Official Kodi Wiki - User contributions [en]

List of built-in functions

2026-08-14T07:43:43Z

Hitcher: /* GUI built-in's */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>ExportLibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>ExportLibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>ExportLibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>MusicLibrary.RefreshAlbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>MusicLibrary.RefreshArtist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function.

The underlying mapping is defined in the Kodi C++ source file https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.h#L55-L180.

{| class="prettytable"
! ID
! Description
|-
| <code>1</code>
| Name
|-
| <code>2</code>
| Date
|-
| <code>3</code>
| Size
|-
| <code>4</code>
| File
|-
| <code>5</code>
| Path
|-
| <code>6</code>
| DriveType
|-
| <code>7</code>
| Title
|-
| <code>8</code>
| TrackNumber
|-
| <code>9</code>
| Time
|-
| <code>10</code>
| Artist
|-
| <code>11</code>
| ArtistThenYear
|-
| <code>12</code>
| Album
|-
| <code>13</code>
| AlbumType
|-
| <code>14</code>
| Genre
|-
| <code>15</code>
| Country
|-
| <code>16</code>
| Year
|-
| <code>17</code>
| Rating
|-
| <code>18</code>
| UserRating
|-
| <code>19</code>
| Votes
|-
| <code>20</code>
| Top250
|-
| <code>21</code>
| ProgramCount
|-
| <code>22</code>
| PlaylistOrder
|-
| <code>23</code>
| EpisodeNumber
|-
| <code>24</code>
| Season
|-
| <code>25</code>
| NumberOfEpisodes
|-
| <code>26</code>
| NumberOfWatchedEpisodes
|-
| <code>27</code>
| TvShowStatus
|-
| <code>28</code>
| TvShowTitle
|-
| <code>29</code>
| SortTitle
|-
| <code>30</code>
| ProductionCode
|-
| <code>31</code>
| MPAA
|-
| <code>32</code>
| VideoResolution
|-
| <code>33</code>
| VideoCodec
|-
| <code>34</code>
| VideoAspectRatio
|-
| <code>35</code>
| AudioChannels
|-
| <code>36</code>
| AudioCodec
|-
| <code>37</code>
| AudioLanguage
|-
| <code>38</code>
| SubtitleLanguage
|-
| <code>39</code>
| Studio
|-
| <code>40</code>
| DateAdded
|-
| <code>41</code>
| LastPlayed
|-
| <code>42</code>
| Playcount
|-
| <code>43</code>
| Listeners
|-
| <code>44</code>
| Bitrate
|-
| <code>45</code>
| Random
|-
| <code>46</code>
| Channel
|-
| <code>47</code>
| ChannelNumber
|-
| <code>48</code>
| DateTaken
|-
| <code>49</code>
| Relevance
|-
| <code>50</code>
| InstallDate
|-
| <code>51</code>
| LastUpdated
|-
| <code>52</code>
| LastUsed
|-
| <code>53</code>
| ClientChannelOrder
|-
| <code>54</code>
| TotalDiscs
|-
| <code>55</code>
| OriginalDate
|-
| <code>56</code>
| BPM
|-
| <code>57</code>
| OriginalTitle
|-
| <code>58</code>
| Provider
|-
| <code>59</code>
| UserPreference
|}

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

== References ==
<references />

{{updated|20}}

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

Controls

2026-06-22T19:19:53Z

Hitcher: /* Available controls */

{{cleanup}}
NOTE: The control definitions here can be become out of date. The latest xml behavior can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/guilib/GUIControlFactory.cpp?view=markup the Git cpp code]

== Available controls ==

; [[Add-on Rendering control]] : Control where rendering becomes performed from add-on.
; [[Button control]] : a standard push button control.
; [[Color Button Control]] : used for creating push buttons in Kodi with a box for color preview.
; [[EPGGrid control]] : used to display the EPG guide in the PVR section.
; [[Edit Control]] : used as an input control for the osd keyboard and other input fields.
; [[Fade label control]] : used to show multiple pieces of text in the same position, by fading from one to the other.
; [[Fixed List Container]] : used for a list of items with a fixed focus. Same as the [[Wrap List Container]] except it doesn't wrap.
; [[Game Control]] : used to display the currently playing game, with optional effects, whilst in the GUI.
; [[Game Controller]] : used to display a game controller, with optional effects.
; [[Game Controller List]] : used to give special behavior to a list of Game Controller controls.
; [[Group Control]] : used to group controls together.
; [[Group List Control]] : special case of the group control that forms a scrolling list of controls.
; [[Image Control]] : used to show an image.
; [[Label control]] : used to show some lines of text.
; [[List Container]] : used for a scrolling lists of items. Replaces the list control.
; [[Mover Control]] : used in the calibration screens.
; [[MultiImage Control]] : used to show a slideshow of images.
; [[Panel Container]] : used for a scrolling panel of items. Replaces the thumbnail panel.
; [[Progress Control]] : Used to show the progress of a particular operation.
; [[Resize ticker]] : used to set the pixel ratio in Video Calibration.
; [[RSS ticker]] : used to display scrolling RSS feeds.
; [[Ranges Control]] : Used to show multiple range blocks.
; [[Radio button control]] : a radio button control (as used for on/off settings).
; [[Scroll Bar Control]] : used for a implementing a scroll bar.
; [[Settings Slider Control]] : used for a slider control in the settings menus.
; [[Settings Spin Control]] : used for cycling up/down controls in the settings menus.
; [[Slider Control]] : used for a volume slider.
; [[Spin Control]] : used for cycling up/down controls.
; [[Text Box]] : used to show a multi-page piece of text.
; [[Toggle button control]] : a toggle on/off button that can take 2 different states.
; [[Video Control]] : used to display the currently playing video whilst in the GUI.
; [[Visualisation Control]] : used to display a visualisation while music is playing.
; [[Wrap List Container]] : used for a wrapping list of items with fixed focus.

== Rarely used controls ==

; [[Mover Control]] : used in the calibration screens.
; [[Resize control]] : used to set the pixel ratio in Video Calibration.

== Depreciated controls ==
These controls are not recommended to be used inside skins
and will be removed from the skinning engine at some point.
Or may not work at all

; Buttonscrollers : used for multiple buttons in a scrollable list.
; Checkmark Control : Used on the XLink Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the check-mark is on the left.
; Console Control : used as a multi-coloured text display (XLink Kai window).
; Extended List Control : used in the XLink Kai window.
; Large Image Control : background loading version of the image control, for larger images.
; List Control : used for lists of items.
; Multiselect control : a piece of text with multiple selectable "button" components.
; Recently Added Media Control : used to display the last few items added to the video database.
; Select button control : a select button control (allows multiple selections from a single button)
; Thumbnail Panel : used to show a panel of thumbnails.

== Built in controls ==

A list of built in controls [[List of Built In Controls|can be found here.]]

== XML tags that affect all control types ==

The XML tags that affect all control types [[Default_control_tags|can be found here.]]

== Filling controls and dictating how they respond from the skin ==

Most of the controls' contents are filled at runtime by the Kodi source codebase, but for controls such as buttons, labels and images, the Skinner has full control over what the button does or what the label and images look like, if they so desire. This is done via the use of conditional <visible> tags, built in <execute> functions, and <info> information tags. See the following links for more information.

; [[Conditional visibility]] : Defining when to display and hide a control, and how to animate the effect.
; [[Animating your skin]] : Breathing life into controls by having defining how they move and respond to actions.
; [[List_of_built-in_functions|Built In Functions]] : Defining what a button or list does when clicked or focused.
; [[InfoLabels|Specifying Labels]] : Defining what a label control or image control's contents should be.

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Controller

2026-06-22T19:13:57Z

Hitcher: /* Available tags */

{{mininav| [[Skinning]] | [[Controls|Available controls]] }}
<section begin="main content" />
'''Used to display a game controller, with optional effects.'''

The game controller control is used for displaying a game controller, such as joysticks, keyboards, mice, lightguns, etc.

In v21 Omega, the control was expanded to give skinners more control over how it behaves, including manually specifying a controller to show, allowing for a fallback image, and applying a highlighting diffuse effect when the underlying controller is active.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamecontroller">
<description>My first game controller</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<controllerid>game.controller.snes</controllerid>
</control>
</syntaxhighlight>
=== Available tags ===
The '''[[Default Control Tags]]''' are applicable to this control. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

In v21 and above, the control derives from an [[Image_Control]] to allow for a fallback texture. All tags and attributes for images can be used, and any game-specific tags will cause the texture to be overridden.

The game-specific tags added in v21 are:
{| class="prettytable"
! Tag !! Description
|-
| '''controllerid'''
| The add-on ID of the controller profile to render, e.g. <code>game.controller.snes</code>.
|-
| '''controllerdiffuse'''
| A diffuse color used to highlight the controller when activity is detected on the in-game port or on the underlying peripheral held by the user.
|-
| '''controlleraddress'''
| The in-game "address" of the controller, e.g. <code>/1/game.controller.snes</code> for a SNES controller connected to console port 1. Used to highlight the controller on port activity. Overrides <code><controllerid></code> and <code><portaddress></code>.
|-
| '''portaddress'''
| The in-game "address" of the port the controller is connected to, e.g. <code>/1</code> for port 1 of a SNES emulator. Used to highlight the controller on port activity.
|-
| '''peripherallocation'''
| The location of the underlying peripheral providing input, e.g. <code>/joystick/0</code> for the first physical controller held by the user. Used to highlight the controller on peripheral activity.
|}

=== Controller address ===
The controller address is connected to the in-game input. It's formed by the emulated console's port, followed by the controller ID.

For example, on SNES controllers, the address of the first port is <code>/1</code>. The address of a SNES controller connected to that port is <code>/1/game.controller.snes</code>.

Old consoles used multitaps (controller hubs) to allow for more players than console ports. A multitap connected to port <code>/2</code> would have the address <code>/2/game.controller.snes.multitap</code>.

A SNES controller connected to port 1 on a multitap would then have the address <code>/2/game.controller.snes.multitap/1/game.controller.snes</code>.
=== Peripheral location ===
Peripherals are located by a <code>peripherals://</code> URI containing their peripheral bus as a hostname and a path to the peripheral. For example, keyboards have the location <code>peripherals://application/keyboard.dev</code>.
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div">
<itemlayout width="96" height="96">
<control type="gamecontroller">
<texture>$INFO[ListItem.Icon]</texture>
<controllerid>$INFO[ListItem.Property(controllerid)]</controllerid>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div">
<content>
<item>
<icon>DefaultAddonNone.png</icon>
</item>
<item>
<property name="controllerid">game.controller.snes</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs that highlight game controllers on button presses (<code>GamePorts</code> and <code>GameAgents</code>) use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Controller List

2026-06-22T19:13:24Z

Hitcher: Created page with "{{mininav| Skinning | Available controls }} <section begin="main content" /> '''Used to display a list of game controllers, allowing for special effects such as controller highlighting and port selection.''' The game controller list is used for displaying a list of game controllers. It is provided as a container to allow for special behavior of the inner game controllers, such as visualizing the current in-game port for each controller in the GameAgents..."

{{mininav| [[Skinning]] | [[Controls|Available controls]] }}
<section begin="main content" />
'''Used to display a list of game controllers, allowing for special effects such as controller highlighting and port selection.'''

The game controller list is used for displaying a list of game controllers. It is provided as a container to allow for special behavior of the inner game controllers, such as visualizing the current in-game port for each controller in the GameAgents dialog.

The control was introduced in v21 to support the new Player Viewer (<code>GameAgents</code>) dialog.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamecontrollerlist">
<description>My first game controller list, showing two items: A "controller disconnected" icon and a SNES controller</description>
<width>192</width>
<height>96</height>
<orientation>horizontal</orientation>
<align>left</align>
<itemlayout width="96" height="96">
<control type="gamecontroller">
<texture>$INFO[ListItem.Icon]</texture>
<controllerid>$INFO[ListItem.Property(controllerid)]</controllerid>
</control>
</itemlayout>
<focusedlayout width="96" height="96">
<control type="gamecontroller">
<texture>$INFO[ListItem.Icon]</texture>
<controllerid>$INFO[ListItem.Property(controllerid)]</controllerid>
</control>
</focusedlayout>
<content>
<item>
<icon>DefaultAddonNone.png</icon>
</item>
<item>
<property name="controllerid">game.controller.snes</property>
</item>
</content>
</control>
</syntaxhighlight>
=== Available tags ===
The '''[[Default Control Tags]]''' are applicable to this control. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

The game controller list derives from a [[List Container]], so all list tags and attributes can be used.

In addition, the following game-related tags are available:
{| class="prettytable"
! Tag !! Description
|-
| '''align'''
| Align controllers to the left or right, depending on how many in-game ports are available. Only used in-game for list item content provided by core, such as in the Player Viewer (<code>GameAgents</code>) dialog. Ignored if static content is provided.
|}
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Controller

2026-06-22T19:05:52Z

Hitcher: Created page with "{{mininav| Skinning | Available controls }} <section begin="main content" /> '''Used to display a game controller, with optional effects.''' The game controller control is used for displaying a game controller, such as joysticks, keyboards, mice, lightguns, etc. In v21 Omega, the control was expanded to give skinners more control over how it behaves, including manually specifying a controller to show, allowing for a fallback image, and applying a highl..."

{{mininav| [[Skinning]] | [[Controls|Available controls]] }}
<section begin="main content" />
'''Used to display a game controller, with optional effects.'''

The game controller control is used for displaying a game controller, such as joysticks, keyboards, mice, lightguns, etc.

In v21 Omega, the control was expanded to give skinners more control over how it behaves, including manually specifying a controller to show, allowing for a fallback image, and applying a highlighting diffuse effect when the underlying controller is active.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamecontroller">
<description>My first game controller</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<controllerid>game.controller.snes</controllerid>
</control>
</syntaxhighlight>
=== Available tags ===
The '''[[Default Control Tags]]''' are applicable to this control. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

In v21 and above, the control derives from an [[Image_Control]] to allow for a fallback texture. All tags and attributes for images can be used, and any game-specific tags will cause the texture to be overridden.

The game-specific tags added in v21 are:
{| class="prettytable"
! Tag !! Description
|-
| '''controllerid'''
| The add-on ID of the controller profile to render, e.g. <code>game.controller.snes</code>.
|-
| '''controllerdiffuse'''
| A diffuse color used to highlight the controller when activity is detected on the in-game port or on the underlying peripheral held by the user.
|-
| '''controlleraddress'''
| The in-game "address" of the controller, e.g. <code>/1/game.controller.snes</code> for a SNES controller connected to console port 1. Used to highlight the controller on port activity. Overrides <code><controllerid></code> and <code><portaddress></code>.
|-
| '''portaddress'''
| The in-game "address" of the port the controller is connected to, e.g. <code>/1</code> for port 1 of a SNES emulator. Used to highlight the controller on port activity.
|-
| '''peripherallocation'''
| The location of the underlying peripheral providing input, e.g. <code>/joystick/0</code> for the first physical controller held by the user. Used to highlight the controller on peripheral activity.
|}
The control has been greatly expanded to allow for more use cases in the new Player Viewer (<code>GameAgents</code>) dialog.
=== Controller address ===
The controller address is connected to the in-game input. It's formed by the emulated console's port, followed by the controller ID.

For example, on SNES controllers, the address of the first port is <code>/1</code>. The address of a SNES controller connected to that port is <code>/1/game.controller.snes</code>.

Old consoles used multitaps (controller hubs) to allow for more players than console ports. A multitap connected to port <code>/2</code> would have the address <code>/2/game.controller.snes.multitap</code>.

A SNES controller connected to port 1 on a multitap would then have the address <code>/2/game.controller.snes.multitap/1/game.controller.snes</code>.
=== Peripheral location ===
Peripherals are located by a <code>peripherals://</code> URI containing their peripheral bus as a hostname and a path to the peripheral. For example, keyboards have the location <code>peripherals://application/keyboard.dev</code>.
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div">
<itemlayout width="96" height="96">
<control type="gamecontroller">
<texture>$INFO[ListItem.Icon]</texture>
<controllerid>$INFO[ListItem.Property(controllerid)]</controllerid>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div">
<content>
<item>
<icon>DefaultAddonNone.png</icon>
</item>
<item>
<property name="controllerid">game.controller.snes</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs that highlight game controllers on button presses (<code>GamePorts</code> and <code>GameAgents</code>) use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Control

2026-06-22T19:04:30Z

Hitcher: /* Available tags */

{{mininav| [[Skinning]] | [[Controls|Available controls]] }}
<section begin="main content" />
'''Used to display the currently playing game, with optional effects, while playing a game.'''

The gamewindow control is used for displaying the currently playing game elsewhere in the Kodi GUI. You can choose the position, and size of the game displayed, as well as various effects. Note that the control is only rendered if game is being played.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamewindow" id="2">
<description>My first game control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<videofilter>nearest</videofilter>
<stretchmode>normal</stretchmode>
<rotation>0</rotation>
</control>
</syntaxhighlight>
=== Available tags ===
In addition to the '''[[Default Control Tags]]''' the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''videofilter'''
| The filter to use, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] info label is used.
|-
| '''stretchmode'''
| The stretch mode, see [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] info label is used.
|-
| '''rotation'''
| The rotation, in degrees counter-clockwise, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] info label is used.
|-
| '''pixels'''
| A path to a v20 savestate, whose pixels will be rendered instead of the active game. A value of - will disable rendering of any pixels.
|}

=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div"><itemlayout width="444" height="250">
<control type="gamewindow">
<videofilter>$INFO[ListItem.Property(game.videofilter)]</videofilter>
<stretchmode>$INFO[ListItem.Property(game.stretchmode)]</stretchmode>
<rotation>$INFO[ListItem.Property(game.videorotation)]</rotation>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div"><content>
<item>
<property name="game.videofilter">nearest</property>
<property name="game.stretchmode">normal</property>
<property name="game.videorotation">0</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs with a gamewindow control (<code>GameVideoFilter</code>, <code>GameStretchMode</code>, <code>GameVideoRotation</code> and <code>InGameSaves)</code> use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Add-on Rendering control

2026-06-22T19:04:10Z

Hitcher: /* Available tags */

<section begin="main content" />
Control where rendering becomes performed from add-on to show on Kodi
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="renderaddon" id ="9">
<left>5</left>
<top>50</top>
<width>780</width>
<height>515</height>
</control>
</syntaxhighlight>
=== Available tags ===
Only the '''[[Default Control Tags]]''' are applicable to this control.
<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Control

2026-06-22T15:33:19Z

Hitcher:

{{mininav| [[Skinning]] | [[Controls|Available controls]] }}
<section begin="main content" />
'''Used to display the currently playing game, with optional effects, while playing a game.'''

The gamewindow control is used for displaying the currently playing game elsewhere in the Kodi GUI. You can choose the position, and size of the game displayed, as well as various effects. Note that the control is only rendered if game is being played.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamewindow" id="2">
<description>My first game control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<videofilter>nearest</videofilter>
<stretchmode>normal</stretchmode>
<rotation>0</rotation>
</control>
</syntaxhighlight>
=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''videofilter'''
| The filter to use, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] info label is used.
|-
| '''stretchmode'''
| The stretch mode, see [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] info label is used.
|-
| '''rotation'''
| The rotation, in degrees counter-clockwise, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] info label is used.
|-
| '''pixels'''
| A path to a v20 savestate, whose pixels will be rendered instead of the active game. A value of - will disable rendering of any pixels.
|}
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div"><itemlayout width="444" height="250">
<control type="gamewindow">
<videofilter>$INFO[ListItem.Property(game.videofilter)]</videofilter>
<stretchmode>$INFO[ListItem.Property(game.stretchmode)]</stretchmode>
<rotation>$INFO[ListItem.Property(game.videorotation)]</rotation>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div"><content>
<item>
<property name="game.videofilter">nearest</property>
<property name="game.stretchmode">normal</property>
<property name="game.videorotation">0</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs with a gamewindow control (<code>GameVideoFilter</code>, <code>GameStretchMode</code>, <code>GameVideoRotation</code> and <code>InGameSaves)</code> use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Control

2026-06-22T15:27:07Z

Hitcher:

__NOTOC__<section begin="main content" />
'''Used to display the currently playing game, with optional effects, while playing a game.'''

The gamewindow control is used for displaying the currently playing game elsewhere in the Kodi GUI. You can choose the position, and size of the game displayed, as well as various effects. Note that the control is only rendered if game is being played.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamewindow" id="2">
<description>My first game control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<videofilter>nearest</videofilter>
<stretchmode>normal</stretchmode>
<rotation>0</rotation>
</control>
</syntaxhighlight>
=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''videofilter'''
| The filter to use, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] info label is used.
|-
| '''stretchmode'''
| The stretch mode, see [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] info label is used.
|-
| '''rotation'''
| The rotation, in degrees counter-clockwise, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] info label is used.
|-
| '''pixels'''
| A path to a v20 savestate, whose pixels will be rendered instead of the active game. A value of - will disable rendering of any pixels.
|}
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div"><itemlayout width="444" height="250">
<control type="gamewindow">
<videofilter>$INFO[ListItem.Property(game.videofilter)]</videofilter>
<stretchmode>$INFO[ListItem.Property(game.stretchmode)]</stretchmode>
<rotation>$INFO[ListItem.Property(game.videorotation)]</rotation>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div"><content>
<item>
<property name="game.videofilter">nearest</property>
<property name="game.stretchmode">normal</property>
<property name="game.videorotation">0</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs with a gamewindow control (<code>GameVideoFilter</code>, <code>GameStretchMode</code>, <code>GameVideoRotation</code> and <code>InGameSaves)</code> use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Control

2026-06-22T15:26:47Z

Hitcher:

__NOTOC__
<section begin="main content" />
'''Used to display the currently playing game, with optional effects, while playing a game.'''

The gamewindow control is used for displaying the currently playing game elsewhere in the Kodi GUI. You can choose the position, and size of the game displayed, as well as various effects. Note that the control is only rendered if game is being played.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamewindow" id="2">
<description>My first game control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<videofilter>nearest</videofilter>
<stretchmode>normal</stretchmode>
<rotation>0</rotation>
</control>
</syntaxhighlight>
=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''videofilter'''
| The filter to use, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] info label is used.
|-
| '''stretchmode'''
| The stretch mode, see [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] info label is used.
|-
| '''rotation'''
| The rotation, in degrees counter-clockwise, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] info label is used.
|-
| '''pixels'''
| A path to a v20 savestate, whose pixels will be rendered instead of the active game. A value of - will disable rendering of any pixels.
|}
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div"><itemlayout width="444" height="250">
<control type="gamewindow">
<videofilter>$INFO[ListItem.Property(game.videofilter)]</videofilter>
<stretchmode>$INFO[ListItem.Property(game.stretchmode)]</stretchmode>
<rotation>$INFO[ListItem.Property(game.videorotation)]</rotation>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div"><content>
<item>
<property name="game.videofilter">nearest</property>
<property name="game.stretchmode">normal</property>
<property name="game.videorotation">0</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs with a gamewindow control (<code>GameVideoFilter</code>, <code>GameStretchMode</code>, <code>GameVideoRotation</code> and <code>InGameSaves)</code> use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Control

2026-06-22T15:24:46Z

Hitcher: Created page with "<section begin="main content" /> '''Used to display the currently playing game, with optional effects, while playing a game.''' The gamewindow control is used for displaying the currently playing game elsewhere in the Kodi GUI. You can choose the position, and size of the game displayed, as well as various effects. Note that the control is only rendered if game is being played. === Example === <syntaxhighlight lang="XML" enclose="div"> <control type="gamewindow" id="2">..."

<section begin="main content" />
'''Used to display the currently playing game, with optional effects, while playing a game.'''

The gamewindow control is used for displaying the currently playing game elsewhere in the Kodi GUI. You can choose the position, and size of the game displayed, as well as various effects. Note that the control is only rendered if game is being played.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamewindow" id="2">
<description>My first game control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<videofilter>nearest</videofilter>
<stretchmode>normal</stretchmode>
<rotation>0</rotation>
</control>
</syntaxhighlight>
=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''videofilter'''
| The filter to use, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoFilter]] info label is used.
|-
| '''stretchmode'''
| The stretch mode, see [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.StretchMode]] info label is used.
|-
| '''rotation'''
| The rotation, in degrees counter-clockwise, see [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] for supported values. If empty, the value of the [[InfoLabels#RetroPlayer|RetroPlayer.VideoRotation]] info label is used.
|-
| '''pixels'''
| A path to a v20 savestate, whose pixels will be rendered instead of the active game. A value of - will disable rendering of any pixels.
|}
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div"><itemlayout width="444" height="250">
<control type="gamewindow">
<videofilter>$INFO[ListItem.Property(game.videofilter)]</videofilter>
<stretchmode>$INFO[ListItem.Property(game.stretchmode)]</stretchmode>
<rotation>$INFO[ListItem.Property(game.videorotation)]</rotation>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div"><content>
<item>
<property name="game.videofilter">nearest</property>
<property name="game.stretchmode">normal</property>
<property name="game.videorotation">0</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs with a gamewindow control (<code>GameVideoFilter</code>, <code>GameStretchMode</code>, <code>GameVideoRotation</code> and <code>InGameSaves)</code> use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Add-on Rendering control

2026-06-22T15:09:37Z

Hitcher: Created page with "<section begin="main content" /> Control where rendering becomes performed from add-on to show on Kodi === Example === <syntaxhighlight lang="XML" enclose="div"> <control type="renderaddon" id ="9"> <left>5</left> <top>50</top> <width>780</width> <height>515</height> </control> </syntaxhighlight> === Available tags === Only the Default_control_tags are applicable to this control. <section end="main content" /> == See also == '''Development:'''..."

<section begin="main content" />
Control where rendering becomes performed from add-on to show on Kodi
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="renderaddon" id ="9">
<left>5</left>
<top>50</top>
<width>780</width>
<height>515</height>
</control>
</syntaxhighlight>
=== Available tags ===
Only the [[Default_control_tags]] are applicable to this control.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Controls

2026-06-22T15:04:03Z

Hitcher: Add missing controls

{{cleanup}}
NOTE: The control definitions here can be become out of date. The latest xml behavior can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/guilib/GUIControlFactory.cpp?view=markup the Git cpp code]

== Available controls ==

; [[Add-on Rendering control]] : Control where rendering becomes performed from add-on.
; [[Button control]] : a standard push button control.
; [[Color Button Control]] : used for creating push buttons in Kodi with a box for color preview.
; [[EPGGrid control]] : used to display the EPG guide in the PVR section.
; [[Edit Control]] : used as an input control for the osd keyboard and other input fields.
; [[Fade label control]] : used to show multiple pieces of text in the same position, by fading from one to the other.
; [[Fixed List Container]] : used for a list of items with a fixed focus. Same as the [[Wrap List Container]] except it doesn't wrap.
; [[Game Control]] : used to display the currently playing game, with optional effects, whilst in the GUI.
; [[Game Controller]] : used to display a game controller, with optional effects.
; [[Game Controller List]] : used to give special behavior to a list of Game Controller controls.
; [[Group Control]] : used to group controls together.
; [[Group List Control]] : special case of the group control that forms a scrolling list of controls.
; [[Image Control]] : used to show an image.
; [[Label control]] : used to show some lines of text.
; [[List Container]] : used for a scrolling lists of items. Replaces the list control.
; [[MultiImage Control]] : used to show a slideshow of images.
; [[Panel Container]] : used for a scrolling panel of items. Replaces the thumbnail panel.
; [[Progress Control]] : Used to show the progress of a particular operation.
; [[RSS ticker]] : used to display scrolling RSS feeds.
; [[Ranges Control]] : Used to show multiple range blocks.
; [[Radio button control]] : a radio button control (as used for on/off settings).
; [[Scroll Bar Control]] : used for a implementing a scroll bar.
; [[Settings Slider Control]] : used for a slider control in the settings menus.
; [[Settings Spin Control]] : used for cycling up/down controls in the settings menus.
; [[Slider Control]] : used for a volume slider.
; [[Spin Control]] : used for cycling up/down controls.
; [[Text Box]] : used to show a multi-page piece of text.
; [[Toggle button control]] : a toggle on/off button that can take 2 different states.
; [[Video Control]] : used to display the currently playing video whilst in the GUI.
; [[Visualisation Control]] : used to display a visualisation while music is playing.
; [[Wrap List Container]] : used for a wrapping list of items with fixed focus.

== Rarely used controls ==

; [[Mover Control]] : used in the calibration screens.
; [[Resize control]] : used to set the pixel ratio in Video Calibration.

== Depreciated controls ==
These controls are not recommended to be used inside skins
and will be removed from the skinning engine at some point.
Or may not work at all

; Buttonscrollers : used for multiple buttons in a scrollable list.
; Checkmark Control : Used on the XLink Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the check-mark is on the left.
; Console Control : used as a multi-coloured text display (XLink Kai window).
; Extended List Control : used in the XLink Kai window.
; Large Image Control : background loading version of the image control, for larger images.
; List Control : used for lists of items.
; Multiselect control : a piece of text with multiple selectable "button" components.
; Recently Added Media Control : used to display the last few items added to the video database.
; Select button control : a select button control (allows multiple selections from a single button)
; Thumbnail Panel : used to show a panel of thumbnails.

== Built in controls ==

A list of built in controls [[List of Built In Controls|can be found here.]]

== XML tags that affect all control types ==

The XML tags that affect all control types [[Default_control_tags|can be found here.]]

== Filling controls and dictating how they respond from the skin ==

Most of the controls' contents are filled at runtime by the Kodi source codebase, but for controls such as buttons, labels and images, the Skinner has full control over what the button does or what the label and images look like, if they so desire. This is done via the use of conditional <visible> tags, built in <execute> functions, and <info> information tags. See the following links for more information.

; [[Conditional visibility]] : Defining when to display and hide a control, and how to animate the effect.
; [[Animating your skin]] : Breathing life into controls by having defining how they move and respond to actions.
; [[List_of_built-in_functions|Built In Functions]] : Defining what a button or list does when clicked or focused.
; [[InfoLabels|Specifying Labels]] : Defining what a label control or image control's contents should be.

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

List of built-in functions

2026-06-22T14:57:01Z

Hitcher: /* List of sort methods */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>ExportLibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>ExportLibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>ExportLibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>MusicLibrary.RefreshAlbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>MusicLibrary.RefreshArtist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function.

The underlying mapping is defined in the Kodi C++ source file https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.h#L55-L180.

{| class="prettytable"
! ID
! Description
|-
| <code>1</code>
| Name
|-
| <code>2</code>
| Date
|-
| <code>3</code>
| Size
|-
| <code>4</code>
| File
|-
| <code>5</code>
| Path
|-
| <code>6</code>
| DriveType
|-
| <code>7</code>
| Title
|-
| <code>8</code>
| TrackNumber
|-
| <code>9</code>
| Time
|-
| <code>10</code>
| Artist
|-
| <code>11</code>
| ArtistThenYear
|-
| <code>12</code>
| Album
|-
| <code>13</code>
| AlbumType
|-
| <code>14</code>
| Genre
|-
| <code>15</code>
| Country
|-
| <code>16</code>
| Year
|-
| <code>17</code>
| Rating
|-
| <code>18</code>
| UserRating
|-
| <code>19</code>
| Votes
|-
| <code>20</code>
| Top250
|-
| <code>21</code>
| ProgramCount
|-
| <code>22</code>
| PlaylistOrder
|-
| <code>23</code>
| EpisodeNumber
|-
| <code>24</code>
| Season
|-
| <code>25</code>
| NumberOfEpisodes
|-
| <code>26</code>
| NumberOfWatchedEpisodes
|-
| <code>27</code>
| TvShowStatus
|-
| <code>28</code>
| TvShowTitle
|-
| <code>29</code>
| SortTitle
|-
| <code>30</code>
| ProductionCode
|-
| <code>31</code>
| MPAA
|-
| <code>32</code>
| VideoResolution
|-
| <code>33</code>
| VideoCodec
|-
| <code>34</code>
| VideoAspectRatio
|-
| <code>35</code>
| AudioChannels
|-
| <code>36</code>
| AudioCodec
|-
| <code>37</code>
| AudioLanguage
|-
| <code>38</code>
| SubtitleLanguage
|-
| <code>39</code>
| Studio
|-
| <code>40</code>
| DateAdded
|-
| <code>41</code>
| LastPlayed
|-
| <code>42</code>
| Playcount
|-
| <code>43</code>
| Listeners
|-
| <code>44</code>
| Bitrate
|-
| <code>45</code>
| Random
|-
| <code>46</code>
| Channel
|-
| <code>47</code>
| ChannelNumber
|-
| <code>48</code>
| DateTaken
|-
| <code>49</code>
| Relevance
|-
| <code>50</code>
| InstallDate
|-
| <code>51</code>
| LastUpdated
|-
| <code>52</code>
| LastUsed
|-
| <code>53</code>
| ClientChannelOrder
|-
| <code>54</code>
| TotalDiscs
|-
| <code>55</code>
| OriginalDate
|-
| <code>56</code>
| BPM
|-
| <code>57</code>
| OriginalTitle
|-
| <code>58</code>
| Provider
|-
| <code>59</code>
| UserPreference
|}

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

== References ==
<references />

{{updated|20}}

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

List of built-in functions

2026-06-22T14:51:43Z

Hitcher: /* List of sort methods */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>ExportLibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>ExportLibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>ExportLibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>MusicLibrary.RefreshAlbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>MusicLibrary.RefreshArtist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function.

The underlying mapping is defined in the Kodi C++ source file [https://github.com SortUtils.h].

{| class="prettytable"
! ID
! Description
|-
| <code>1</code>
| Name
|-
| <code>2</code>
| Date
|-
| <code>3</code>
| Size
|-
| <code>4</code>
| File
|-
| <code>5</code>
| Path
|-
| <code>6</code>
| DriveType
|-
| <code>7</code>
| Title
|-
| <code>8</code>
| TrackNumber
|-
| <code>9</code>
| Time
|-
| <code>10</code>
| Artist
|-
| <code>11</code>
| ArtistThenYear
|-
| <code>12</code>
| Album
|-
| <code>13</code>
| AlbumType
|-
| <code>14</code>
| Genre
|-
| <code>15</code>
| Country
|-
| <code>16</code>
| Year
|-
| <code>17</code>
| Rating
|-
| <code>18</code>
| UserRating
|-
| <code>19</code>
| Votes
|-
| <code>20</code>
| Top250
|-
| <code>21</code>
| ProgramCount
|-
| <code>22</code>
| PlaylistOrder
|-
| <code>23</code>
| EpisodeNumber
|-
| <code>24</code>
| Season
|-
| <code>25</code>
| NumberOfEpisodes
|-
| <code>26</code>
| NumberOfWatchedEpisodes
|-
| <code>27</code>
| TvShowStatus
|-
| <code>28</code>
| TvShowTitle
|-
| <code>29</code>
| SortTitle
|-
| <code>30</code>
| ProductionCode
|-
| <code>31</code>
| MPAA
|-
| <code>32</code>
| VideoResolution
|-
| <code>33</code>
| VideoCodec
|-
| <code>34</code>
| VideoAspectRatio
|-
| <code>35</code>
| AudioChannels
|-
| <code>36</code>
| AudioCodec
|-
| <code>37</code>
| AudioLanguage
|-
| <code>38</code>
| SubtitleLanguage
|-
| <code>39</code>
| Studio
|-
| <code>40</code>
| DateAdded
|-
| <code>41</code>
| LastPlayed
|-
| <code>42</code>
| Playcount
|-
| <code>43</code>
| Listeners
|-
| <code>44</code>
| Bitrate
|-
| <code>45</code>
| Random
|-
| <code>46</code>
| Channel
|-
| <code>47</code>
| ChannelNumber
|-
| <code>48</code>
| DateTaken
|-
| <code>49</code>
| Relevance
|-
| <code>50</code>
| InstallDate
|-
| <code>51</code>
| LastUpdated
|-
| <code>52</code>
| LastUsed
|-
| <code>53</code>
| ClientChannelOrder
|-
| <code>54</code>
| TotalDiscs
|-
| <code>55</code>
| OriginalDate
|-
| <code>56</code>
| BPM
|-
| <code>57</code>
| OriginalTitle
|-
| <code>58</code>
| Provider
|-
| <code>59</code>
| UserPreference
|}

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

== References ==
<references />

{{updated|20}}

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

List of built-in functions

2026-06-22T14:36:28Z

Hitcher: /* Library built-in's */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>ExportLibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>ExportLibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>ExportLibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>MusicLibrary.RefreshAlbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>MusicLibrary.RefreshArtist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

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

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

== References ==
<references />

{{updated|20}}

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

List of built-in functions

2026-06-22T14:35:12Z

Hitcher: /* GUI control built-in's */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>exportlibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>musiclibrary.refreshalbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>musiclibrary.refreshartist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

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

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

== References ==
<references />

{{updated|20}}

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

List of built-in functions

2026-06-22T14:34:48Z

Hitcher: /* GUI built-in's */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>exportlibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>musiclibrary.refreshalbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>musiclibrary.refreshartist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

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

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

== References ==
<references />

{{updated|20}}

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

List of boolean conditions

2026-06-22T13:57:37Z

Hitcher: Update Boolean conditions from Doxygen

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use boolean conditions with the '''<visible>''' tag or with condition attributes. Scripts can read boolean conditions with <code>'''xbmc.getCondVisibility'''(condition)</code>.

=== Global ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
|-
| <code>false</code>
| Returns
:Always evaluates to '''false'''.
|-
| <code>no</code>
| Returns
:same as '''false'''.
|-
| <code>true</code>
| Returns
:Always evaluates to '''true'''.
|-
| <code>yes</code>
| Returns
:same as '''true'''.
|}

=== Addon ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingBool(addon_id,setting_id)</code>
| '''Returns'''
:'''True''' if the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code> is '''True''', '''False''' otherwise.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>The provided setting with <code>setting_id</code> must be a boolean setting type.<br>
Otherwise it will return the boolean info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{| class="wikitable sortable"" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column(column_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the column given.
'''Parameters'''
:'''column_number''' - The column number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| '''Returns'''
:'''True''' if the container with id has static content and is focused on the item with id item_number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasNext</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a next page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasParent</code>
| '''Returns'''
:'''True''' when the container with id contains a parent ('..') item.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasPrevious</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a previous page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).IsUpdating</code>
| '''Returns'''
:'''True''' if the container with dynamic list content is currently updating.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnNext</code>
| '''Returns'''
:'''True''' if the container with id is moving to the next item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnPrevious</code>
| '''Returns'''
:'''True''' if the container with id is moving to the previous item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollNext</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the next item.
:Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollPrevious</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the previous item.
:Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Position(position_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the position given.
'''Parameters'''
:'''position_number''' - The position number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Row(row_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the row given.
'''Parameters'''
:'''row_number''' - The row number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Scrolling</code>
| '''Returns'''
:'''True''' if the user is currently scrolling through the container with id.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.<br>
This is slightly delayed from the actual scroll start.<br>
Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.}}
|
|-
| <code>Container(id).SubItem</code>
| '''Returns'''
:'''True''' if the container with id is focused on the specified subitem.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container.CanFilter</code>
| '''Returns'''
:'''True''' when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| '''Returns'''
:'''True''' when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Content(parameter)</code>
| '''Returns'''
:'''True''' if the current container you are in contains the following:
:*actors
:*addons
:*albums
:*artists
:*directors
:*episodes
:*files
:*genres
:*livetv
:*movies
:*musicvideos
:*playlists
:*plugins
:*seasons
:*sets
:*songs
:*studios
:*tags
:*tvshows
:*years
{{highlight|'''Note'''<br>
These currently only work in the Video and Music Library, unless a Plugin has set the value.}}
|
|-
| <code>Container.Filtered</code>
| '''Returns'''
:'''True''' when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasFiles</code>
| '''Returns'''
:'''True''' if the container contains files.
|
|-
| <code>Container.HasFolders</code>
| '''Returns'''
:'''True''' if the container contains folders.
|
|-
| <code>Container.HasThumb</code>
| '''Returns'''
:'''True''' if the current container you are in has a thumb assigned to it.
|
|-
| <code>Container.IsStacked</code>
| '''Returns'''
:'''True''' if the container is currently in stacked mode.
|
|-
| <code>Container.SortDirection(ascending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is descending.
|
|-
| <code>Container.Sortmethod(sortid)</code>
| '''Returns'''
:'''True''' if the current sort method matches the specified SortID [[https://kodi.wiki/view/List_of_built-in_functions#List_of_sort_methods see list of sort methods]].
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Control.HasFocus(id)</code>
| '''Returns'''
:'''True''' if the currently focused control has id "id".<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsEnabled(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is enabled.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsVisible(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is visible.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| '''Returns'''
:'''True''' if the control group with id “group” has control id “id” as its focused item.<br>
'''Parameters'''
:'''group''' - The id of the group.
:'''id''' - The id of the focused item.
{{highlight|'''Note'''<br>
If “id” is not present, or is 0, then it will return true if the currently focused control is in the control group with id “group”.<br>
If the control group with id “group” does not have focus, then this will still return true if the last focused item in the group had control id “id”.<br>
'''WARNING'''<br>
Avoid using IDs 9000-9999 as this is the range assigned to groups with no ID value.}}
|
|}

=== Integer ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| v19
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| v19
|}

=== Library ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Library.HasContent(Role,Composer)</code>
| Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library
| v17
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets, BoxSets)
|
|-
| <code>Library.HasNode(path)</code>
| Returns True if the specified node is available (example: Library.HasNode(library://video/movies/titles.xml))
| v19
|-
| <code>Library.IsScanning</code>
| '''Returns'''
:'''True''' if the library is being scanned.
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>ListItem.HasArchive</code>
| Returns True when the selected channel has a server-side back buffer (PVR)
| v19
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasRecording</code>
| '''Returns'''
:'''True''' if a given epg tag item currently gets recorded or has been recorded.
|
|-
| <code>ListItem.HasReminder</code>
| Returns True if the item has a reminder set (PVR)
| v19
|-
| <code>ListItem.HasReminderRule</code>
| Returns True if the item was scheduled by a reminder timer rule (PVR)
| v19
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16
|-
| <code>ListItem.HasVideoExtras</code>
| Returns true if the ListItem has video extras
|
|-
| <code>ListItem.HasVideoVersions</code>
| Returns true if the ListItem has video versions
|
|-
| <code>ListItem.InProgress</code>
| '''Returns'''
:'''True''' if the EPG event item is currently active (time-wise).
|
|-
| <code>ListItem.IsAutoUpdateable</code>
| Returns True if this add-on can be updated automatically
| v19
|-
| <code>ListItem.IsBoxset</code>
| Returns True if the item is part of a boxset album
| v19
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsFinale</code>
| Returns true if the item is a finale (for example, a season finale showing on Live TV)
| v19
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsLive</code>
| Returns true if the item is live (for example, a Live TV sports event)
| v19
|-
| <code>ListItem.IsNew</code>
| Returns true if the item is a premiere (for example, a Live TV show that will be first aired) (PVR)
| v19
|-
| <code>ListItem.IsParentFolder</code>
| Returns true is the slected item is the 'up' item
| v17
|-
| <code>ListItem.IsPlayable</code>
| Returns True when the selected programme can be played (PVR)
| v19
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsPremiere</code>
| Returns true if the item is a premiere (for example, a Movie first showing or season first on Live TV)
| v19
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.IsVideoExtra</code>
| '''Returns'''
:'''True''' when the selected item is a video extra.
|
|-
| <code>ListItem.Property(Addon.HasUpdate)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>ListItem.Property(Addon.IsBinary)</code>
| Returns true for binary addons
| v19
|-
| <code>ListItem.Property(Addon.IsEnabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsFromOfficialRepo)</code>
| Returns true if the addon is from an official repository
| v19
|-
| <code>ListItem.Property(Addon.IsInstalled)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsUpdate)</code>
| Returns True if this add-on is a valid update of an installed outdated add-on
| v19
|-
| <code>ListItem.Property(Addon.Orphaned)</code>
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)
| v17
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(Stream.Is3D)</code>
| Returns true if the video stream is a 3D (stereoscopic) video, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsDefault)</code>
| Returns true if the audio/video/subtitle stream is default, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsExternal)</code>
| Returns true if the subtitle stream is external, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsForced)</code>
| Returns true if the audio/subtitle stream is forced, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsHearingImpaired)</code>
| Returns true if the subtitle stream is for the hearing impaired (aka SDH-Subtitles for the Deaf or Hard-of-Hearing/CC-Closed Captions), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsOriginal)</code>
| Returns true if the audio/subtitle stream is in the original language, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsVisualImpaired)</code>
| Returns true if the audio stream is for the visually impaired (aka AD-Audio Description), for use in dialogselect.xml
| v22
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17
|-
| <code>ListItem.TimerIsActive</code>
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
| v17
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total number of discs belonging to an album.
|
|}

=== Network ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.IsDHCP</code>
| '''Returns'''
:'''True''' if the network type is DHCP.
{{highlight|'''Note'''<br>
Network type can be either DHCP or FIXED.}}
|
|}

=== Player ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.ChannelPreviewActive</code>
| Returns true if PVR channel preview is active (used channel tag different from played tag)
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.FrameAdvance</code>
| Returns true if player is in frame advance mode
| v18
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasBookmarks</code>
| '''Returns'''
:'''True''' if the item being played has bookmarks, '''False''' otherwise
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasGame</code>
| Returns true if the player is playing a game
| v18
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasPerformedSeek(interval)</code>
| '''Returns'''
:'''True''' if the Player has performed a seek operation in the last provided second <code>interval</code>, '''False''' otherwise.
'''Parameters'''
:interval - the time interval (in seconds)
|
|-
| <code>Player.HasPrograms</code>
| '''Returns'''
:'''True''' if the media file being played has programs, i.e. groups of streams.
{{highlight|'''Note'''<br>Ex: if a media file has multiple streams (quality, channels, etc) a program represents a particular stream combo.}}
|
|-
| <code>Player.HasResolutions</code>
| Returns true when multiple resolutions are available
| v18
|-
| <code>Player.HasSceneMarkers</code>
| '''Returns'''
:'''True''' if the item being played has scene markers, '''False''' otherwise
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.IsExternal</code>
| '''Returns'''
:'''True''' if the playing player is an external player, '''False''' otherwise
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.IsLive</code>
| Returns if the inputstream of the player is a live stream (a.k.a. real time stream).
| v22
|-
| <code>Player.IsRemote</code>
| '''Returns'''
:'''True''' if the playing player is a remote player (e.g. UPnP), '''False''' otherwise
|
|-
| <code>Player.IsTempo</code>
| Returns true if the current playbackspeed is not equal to 1
| v17
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.TempoEnabled</code>
| Returns true if the current player supports changing the playback speed
| v17
|}

==== MusicPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.Exists(relative,position)</code>
| '''Returns'''
:'''True''' if the currently playing playlist has a song queued at the given position.
'''Parameters'''
:relative - bool - If the position is relative
:position - int - The position of the song
{{highlight|'''Note'''<br>It is possible to define whether the position is relative or not, default is '''false'''.}}
|
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>MusicPlayer.IsMultiDisc</code>
| Returns true if the current album consists of two or more discs
| v19
|-
| <code>MusicPlayer.PlaylistPlaying</code>
| '''Returns'''
:'''True''' if a playlist is currently playing.
|
|}

=== RetroPlayer ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>RetroPlayer.DiscEjected</code>
| '''Returns'''
:'''True''' if the game's disc is ejected (tray is open), '''False''' if the game isn't disc-based or the tray is closed.
|
|-
| <code>RetroPlayer.EmptyTray</code>
| '''Returns'''
:'''True''' if the selected disc state is "No disc", '''False''' if a disc is selected or the game isn't disc-based.
|
|-
| <code>RetroPlayer.SupportsEject</code>
| '''Returns'''
:'''True''' if the game's disc can be ejected, '''False''' if the game isn't disc-based or doesn't support ejecting the disc.
|
|}

==== VideoPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.CanResumeLiveTV</code>
| '''Returns'''
:'''True''' if a in-progress PVR recording is playing an the respective live TV channel is available.
|
|-
| <code>VideoPlayer.HasVideoVersions</code>
| Returns true if the currently playing video has versions.
| v21
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows, etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (e.g. director, plot, etc).
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== PlayList ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| v18
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| v17
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| v17
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| v17
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| v17
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| v19
|-
| <code>PVR.IsPlayingEpgTag</code>
| '''Returns'''
:'''True''' when an epg tag is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| v18
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| v17
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| v17
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>PVR.NextTimer</code>
| '''Returns'''
:The next timer date.
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| v17
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>RDS.HasHotline</code>
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)
|
|-
| <code>RDS.HasRadioText</code>
| Returns true if RDS contains also Radiotext
|
|-
| <code>RDS.HasRadioTextPlus</code>
| Returns true if RDS with Radiotext contains also the plus information
|
|-
| <code>RDS.HasRds</code>
| Returns true if RDS is present
|
|-
| <code>RDS.HasStudio</code>
| Returns true if a studio name is present (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|-
| <code>Skin.TimerIsRunning(timer)</code>
| '''Returns'''
:'''True''' if the given <code>timer</code> is active, '''false''' otherwise.
'''Parameters'''
:timer - the timer name
|
|}

=== SlideShow ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|}

=== String ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|}

=== System ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>System.AddonIsEnabled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.DPMSActive</code>
| '''Returns'''
:'''True''' if DPMS (VESA Display Power Management Signaling) mode is active.
|
|-
| <code>System.DVDReady</code>
| '''Returns'''
:'''True''' if the disc is ready to use.
|
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.HasCMS</code>
| Returns true if colour management is supported in Kodi.
| v17
|-
| <code>System.HasCoreId(id)</code>
| '''Returns'''
:'''True''' if the CPU core with the given 'id' exists.
'''Parameters'''
:id - the id of the CPU core
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles| profile]] login screen is enabled
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18
|-
| <code>System.HasMediaBlurayPlaylist</code>
| '''Returns'''
:'''True''' if there is a bluray in the drive that has been played before. '''False''' if no drive available, empty drive, other medium or new bluray.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.HasPVR</code>
| '''Returns'''
:'''True''' if PVR is supported from Kodi.
{{highlight|'''Note'''<br>normally always '''true'''}}
|
|-
| <code>System.HasPVRAddon</code>
| Returns true if at least one PVR addon is installed on the system.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, e.g. when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.IdleShutdownInhibited</code>
| '''Returns'''
:'''True''' when shutdown on idle is disabled.
|
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.InternetState</code>
| Returns true if the system is connected to the internet, returns false in case no internet connection is available.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles| profile]]
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|-
| <code>System.IsScreensaverInhibited</code>
| '''Returns'''
:'''True''' when screensaver on idle is disabled.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.LoggedOn</code>
| '''Returns'''
:'''True''' if a user is currently logged on under a profile.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.TVOS</code>
| '''Returns'''
:'''True''' if Kodi is running on a tvOS device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| v18
|-
| <code>System.Platform.WebOS</code>
| '''Returns'''
:'''True''' if Kodi is running on a WebOS device.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.ShowExitButton</code>
| '''Returns'''
:'''True''' if the exit button should be shown (configurable via advanced settings).
|
|-
| <code>System.SupportsCPUUsage</code>
| Return True if the system provides CPU info
| v19
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.TrayOpen</code>
| '''Returns'''
:'''True''' if the disc tray is open.
|
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (e.g. in Milkdrop.)
|
|}

=== Weather ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|-
| <code>Weather.IsUpdating</code>
| '''Returns'''
:'''True''' if weather data are currently updating.
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Window.Is(name)</code>
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible
| v17
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsDialogTopmost(dialog)</code>
| '''Returns'''
:'''True''' if the dialog with id or title dialog is on top of the dialog stack.
'''Parameters'''
:window - the id or name of the window
{{highlight|'''Note'''<br>Excludes fade out time on dialogs}}
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.IsModalDialogTopmost(dialog)</code>
| '''Returns'''
:'''True''' if the dialog with id or title dialog is on top of the modal dialog stack
{{highlight|'''Note'''<br>Excludes fade out time on dialogs}}
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]
* [[Conditional visibility]]

{{top}}

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

InfoLabels

2026-06-22T13:57:09Z

Hitcher: Update info labels from Doxygen

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== Integer ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Integer.ValueOf(number)</code>
| '''Returns'''
:An integer info label that represents the provided number
'''Parameters'''
:number - the number to compute
{{highlight|'''Note'''<br>Example: <code>Integer.ValueOf(4)</code> will be evaluated to 4.<br>Will return -1 if not able to convert the provided value to an integer. Example: <code>Integer.ValueOf(some string)</code> will evaluate to -1 as the provided argument is not an integer.}}
|
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonOrigin</code>
| '''Returns'''
:The name of the repository the add-on originates from.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca**
:*dts***
:*dolbydigital
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp2
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
:
: ** note: dca replaced dts in 2011. Deprecated in 2026 / v22.
: *** note: dts used before 2011 and reintroduced in 2026 / v22.
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Cast(separator)</code>
| '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.ChannelGroup</code>
| '''Returns'''
:The channel group of the selected item ( PVR ).
|
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DateTime</code>
| '''Returns'''
:The date and time a certain event happened (event log).
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Developer</code>
| '''Returns'''
:The game developer (e.g. "Square") (RETROPLAYER).
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.Director(separator)</code>
| '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.EpgEventTitle</code>
| '''Returns'''
:The title of the epg event associated with the item, if any.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.EpisodePart</code>
| '''Returns'''
:string containing the number of parts of a single episode - empty if no data provided
|
|-
| <code>ListItem.ExpirationDate</code>
| '''Returns'''
:The expiration date of the selected item in a container, empty string if not supported.
|
|-
| <code>ListItem.ExpirationTime</code>
| '''Returns'''
:The expiration time of the selected item in a container, empty string if not supported
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.GameClient</code>
| '''Returns'''
:The add-on ID of the game client (a.k.a. emulator) to use for playing the game (e.g. game.libretro.fceumm) (RETROPLAYER).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.Genre(separator)</code>
| '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Genres</code>
| '''Returns'''
:The game genres (e.g. "["Action","Strategy"]") (RETROPLAYER).
|
|-
| <code>ListItem.HdrDetail</code>
| '''Returns'''
:String containing details for the HDR type (currently only for DV - profile and EL type) or empty if not HDR. Prints eg 5, 7FEL, and compatibility ID for profile 8 eg 8.4.
|
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.MediaProviders</code>
| '''Returns'''
:string containing the names of the media providers of the item, separated by commas if multiple are present.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.Overview</code>
| '''Returns'''
:The game overview/summary (RETROPLAYER).
|
|-
| <code>ListItem.ParentalRating</code>
| '''Returns'''
:The parental rating of the list item ( PVR ).
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.Platform</code>
| '''Returns'''
:The game platform (e.g. "Atari 2600") (RETROPLAYER).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Publisher</code>
| '''Returns'''
:The game publisher (e.g. "Nintendo") (RETROPLAYER).
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRGroupOrigin</code>
| '''Returns'''
:If selected item is of type PVR channel group, the creator (user, system, client) of the group.
|
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SongVideoURL</code>
| '''Returns'''
:Link to a video of a song
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.TimerType</code>
| '''Returns'''
:The type of the PVR timer / timer rule item as a human readable string.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.TitleExtraInfo</code>
| '''Returns'''
:string containing extra information, enriching the title of the item.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoHeight</code>
| '''Returns'''
:String containing height of video in pixels - empty if unknown.
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.VideoWidth</code>
| '''Returns'''
:String containing width of video in pixels - empty if unknown.
|
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Writer(separator)</code>
| '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|}

=== Network ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.IPAddress</code>
| '''Returns'''
:The system's IP Address. e.g. 192.168.1.15
|
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|}

=== Player ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.AudioDelay</code>
| '''Returns'''
:The used audio delay with the format <code>%2.3f</code> s
|
|-
| <code>Player.Bookmarks</code>
| '''Returns'''
:The bookmarks of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
|
|-
| <code>Player.CacheLevel</code>
| '''Returns'''
:The used cache level as a string with an integer number.
|
|-
| <code>Player.ChapterName</code>
| '''Returns'''
:The name of currently used chapter if available.
|
|-
| <code>Player.Cuts</code>
| '''Returns'''
:The EDL cut markers of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
|
|-
| <code>Player.Editlist</code>
| '''Returns'''
:The editlist of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
{{highlight|'''Note'''<br>This infolabel does not contain EDL cuts. Edits start and end times are adjusted according to cuts defined for the media item.}}
|
|-
| <code>Player.offset(number).Filename</code>
| '''Returns'''
:The filename of audio or video file which has an offset <code>number</code> with respect to the currently playing item.
|
|-
| <code>Player.offset(number).FilenameAndPath</code>
| '''Returns'''
:The full path with filename of audio or video file which has an offset <code>number</code> with respect to the currently playing item.
|
|-
| <code>Player.offset(number).Folderpath</code>
| '''Returns'''
:The full path of the audio or video file which has an offset <code>number</code> with respect to the currently playing item.
|
|-
| <code>Player.offset(number).Title</code>
| '''Returns'''
:The title of audio or video which has an offset <code>number</code> with respect to the currently playing item.
|
|-
| <code>Player.position(number).Filename</code>
| '''Returns'''
:The filename of the audio or video file which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>Player.position(number).FilenameAndPath</code>
| '''Returns'''
:The full path with filename of the audio or video file which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>Player.position(number).Folderpath</code>
| '''Returns'''
:The full path of the audio or video file which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>Player.position(number).Title</code>
| '''Returns'''
:The title of the audio or video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>Player.SceneMarkers</code>
| '''Returns'''
:The EDL scene markers of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
|
|-
| <code>Player.SeekNumeric([format])</code>
| '''Returns'''
:The time at which the playing media began (in a specified format).
'''Parameters'''
:format [opt] The format of the return time value. See TIME_FORMAT for the list of possible values.
|
|-
| <code>Player.SubtitleDelay</code>
| '''Returns'''
:The used subtitle delay with the format <code>%2.3f</code> s
|
|-
| <code>Player.TimeSpeed</code>
| '''Returns'''
:The time and the playspeed formatted: "1:23 (2x)".
|
|}

=== Player labels ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.AlbumArtist</code>
| '''Returns'''
:The album artist of the currently playing song.
|
|-
| <code>MusicPlayer.LastPlayed</code>
| '''Returns'''
:The last play date of currently playing song, if it's in the database.
|
|-
| <code>MusicPlayer.MediaProviders</code>
| '''Returns'''
:string containing the names of the providers of the currently playing media, separated by commas if multiple are present.
|
|-
| <code>MusicPlayer.offset(number).Album</code>
| '''Returns'''
:The album from which the song with offset <code>number</code> with respect to the current song is from.
'''Parameters'''
:number - the offset number with respect to the current playing song
|
|-
| <code>MusicPlayer.offset(number).Artist</code>
| '''Returns'''
:Artist(s) of the song which has an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset of the song with respect to the current playing song
|
|-
| <code>MusicPlayer.offset(number).Comment</code>
| '''Returns'''
:The Comment of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the playing song.
'''Parameters'''
:number - The offset value for the song with respect to the playing song.
|
|-
| <code>MusicPlayer.offset(number).DiscNumber</code>
| '''Returns'''
:The Disc Number of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the playing song.
'''Parameters'''
:number - The offset value for the song with respect to the playing song.
|
|-
| <code>MusicPlayer.offset(number).Duration</code>
| '''Returns'''
:The duration of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset number of the song with respect to the current playing song
|
|-
| <code>MusicPlayer.offset(number).Genre</code>
| '''Returns'''
:The genre(s) of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset song number with respect to the current playing song.
|
|-
| <code>MusicPlayer.offset(number).Rating</code>
| '''Returns'''
:The numeric Rating of song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset with respect to the current playing song
|
|-
| <code>MusicPlayer.offset(number).Title</code>
| '''Returns'''
:The title of the song which has an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset number with respect to the current playing song
|
|-
| <code>MusicPlayer.offset(number).TrackNumber</code>
| '''Returns'''
:The track number of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - The offset number of the song with respect to the playing song
|
|-
| <code>MusicPlayer.offset(number).Year</code>
| '''Returns'''
:The year of release of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset number with respect to the current song.
|
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.PlayCount</code>
| '''Returns'''
:The play count of currently playing song, if it's in the database.
|
|-
| <code>MusicPlayer.Position(number).Album</code>
| '''Returns'''
:The album from which the song with offset <code>number</code> with respect to the start of the playlist is from.
'''Parameters'''
:number - the offset number with respect to the start of the playlist
|
|-
| <code>MusicPlayer.Position(number).Artist</code>
| '''Returns'''
:Artist(s) of the song which has an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset of the song with respect to the start of the playlist
|
|-
| <code>MusicPlayer.Position(number).Comment</code>
| '''Returns'''
:The Comment of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - The offset value for the song with respect to the start of the playlist.
|
|-
| <code>MusicPlayer.Position(number).DiscNumber</code>
| '''Returns'''
:The Disc Number of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - The offset value for the song with respect to the start of the playlist.
|
|-
| <code>MusicPlayer.Position(number).Duration</code>
| '''Returns'''
:The duration of the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset number of the song with respect to the start of the playlist
|
|-
| <code>MusicPlayer.Position(number).Genre</code>
| '''Returns'''
:The genre(s) of the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset song number with respect to the start of the playlist song.
|
|-
| <code>MusicPlayer.Position(number).Rating</code>
| '''Returns'''
:The numeric Rating of song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset with respect to the start of the playlist
|
|-
| <code>MusicPlayer.Position(number).Title</code>
| '''Returns'''
:The title of the song which as an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset number with respect to the start of the playlist
|
|-
| <code>MusicPlayer.Position(number).TrackNumber</code>
| '''Returns'''
:The track number of the song with an offset <code>number</code> with respect to start of the playlist.
'''Parameters'''
:number - The offset number of the song with respect to start of the playlist
|
|-
| <code>MusicPlayer.Position(number).Year</code>
| '''Returns'''
:The year of release of the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset number with respect to the start of the playlist.
|
|-
| <code>MusicPlayer.RatingAndVotes</code>
| '''Returns'''
:The scraped rating and votes of currently playing song, if it's in the database.
|
|-
| <code>MusicPlayer.Station</code>
| '''Returns'''
:The name of the radio station currently playing (if available).
|
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Genre(separator)</code>
| '''Returns'''
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Votes</code>
| '''Returns'''
:The scraped votes of currently playing song, if it's in the database.
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

=== RetroPlayer ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RetroPlayer.Developer</code>
| '''Returns'''
:The developer of the currently-playing game (e.g. "Square").
|
|-
| <code>RetroPlayer.DiscLabel</code>
| '''Returns'''
:The human-readable label of the currently inserted disc, or an empty string if no disc is in the tray/floppy drive or the game isn't disc-based.
|
|-
| <code>RetroPlayer.GameClient</code>
| '''Returns'''
:The add-on ID of the game client (a.k.a. emulator) used to play the currently-playing game (e.g. <code>game.libretro.beetle-psx</code> ).
|
|-
| <code>RetroPlayer.GameClientName</code>
| '''Returns'''
:The emulator/core name parsed from the game client's add-on name (e.g. <code>bsnes-mercury Performance</code> ).
|
|-
| <code>RetroPlayer.GameClientPlatforms</code>
| '''Returns'''
:The platform or platform group supported by the game client (e.g. an emulator might report "Nintendo - SNES / SFC / Game Boy / Color").
|
|-
| <code>RetroPlayer.Genres</code>
| '''Returns'''
:The genres of the currently-playing game, joined by ", ".
|
|-
| <code>RetroPlayer.Overview</code>
| '''Returns'''
:The overview/summary of the currently-playing game.
|
|-
| <code>RetroPlayer.Platform</code>
| '''Returns'''
:The platform of the currently-playing game, or an empty string if the platform is unknown.
|
|-
| <code>RetroPlayer.Publisher</code>
| '''Returns'''
:The publisher of the currently-playing game (e.g. "Nintendo").
|
|-
| <code>RetroPlayer.StretchMode</code>
| '''Returns'''
:The stretch mode of the currently-playing game. The following values are possible:
:<code>normal</code> (Show the game normally)
:<code>4:3</code> (Stretch to a 4:3 aspect ratio)
:<code>fullscreen</code> (Stretch to the full viewing area)
:<code>original</code> (Shrink to the original resolution)
|
|-
| <code>RetroPlayer.Title</code>
| '''Returns'''
:The title of the currently-playing game.
|
|-
| <code>RetroPlayer.VideoFilter</code>
| '''Returns'''
:The video filter of the currently-playing game. The following values are possible:
:<code>nearest</code> (Nearest neighbor, i.e. pixelate)
:<code>linear</code> (Bilinear filtering, i.e. smooth blur)
|
|-
| <code>RetroPlayer.VideoRotation</code>
| '''Returns'''
:The video rotation of the currently-playing game in degrees counter-clockwise. The following values are possible:
:<code>0</code>
:<code>90</code> (Shown in the GUI as 270 degrees)
:<code>180</code>
:<code>270</code> (Shown in the GUI as 90 degrees)
|
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.Art(type)</code>
| '''Returns'''
:The art path for the requested arttype and for the currently playing video.
'''Parameters'''
:type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
|
|-
| <code>VideoPlayer.AudioLanguageEx</code>
| '''Returns'''
:The English name of the language of the current audio stream of the currently playing item.
|
|-
| <code>VideoPlayer.AudioName</code>
| '''Returns'''
:The name of the active audio stream of the currently playing video.
|
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.EpisodePart</code>
| '''Returns'''
:string containing the number of parts of a single episode - empty if no data provided
:[Infolabel Updated] <code>VideoPlayer.EpisodePart</code> also supports EPG.
|
|-
| <code>VideoPlayer.HdrDetail</code>
| '''Returns'''
:String containing details for the HDR type (currently only for DV - profile and EL type) or empty if not HDR. Prints eg 5, 7FEL, and compatibility ID for profile 8 eg 8.4.
|
|-
| <code>VideoPlayer.MediaProviders</code>
| '''Returns'''
:string containing the names of the providers of the currently playing media, separated by commas if multiple are present.
|
|-
| <code>VideoPlayer.offset(number).Album</code>
| '''Returns'''
:The album from which the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Art(type)</code>
| '''Returns'''
:The art path for the requested arttype and for the video which has an offset <code>number</code> with respect to the currently playing video.
'''Parameters'''
:number - the offset with respect to the start of the playlist
:type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
|
|-
| <code>VideoPlayer.offset(number).Artist</code>
| '''Returns'''
:The artist(s) of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Country</code>
| '''Returns'''
:The production country of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Cover</code>
| '''Returns'''
:The cover of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).DBID</code>
| '''Returns'''
:The database id of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Director</code>
| '''Returns'''
:The director of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Episode</code>
| '''Returns'''
:The episode number of the episode which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Genre</code>
| '''Returns'''
:The genre(s) of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).IMDBNumber</code>
| '''Returns'''
:The IMDb ID of the the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).LastPlayed</code>
| '''Returns'''
:The last play date of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).mpaa</code>
| '''Returns'''
:The MPAA rating of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).OriginalTitle</code>
| '''Returns'''
:The original title of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).PlayCount</code>
| '''Returns'''
:The playcount of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Plot</code>
| '''Returns'''
:The complete Text Summary of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).PlotOutline</code>
| '''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Premiered</code>
| '''Returns'''
:The release or aired date of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Rating</code>
| '''Returns'''
:The scraped rating of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).RatingAndVotes</code>
| '''Returns'''
:The scraped rating and votes of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Season</code>
| '''Returns'''
:The season number of the episode which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Studio</code>
| '''Returns'''
:The studio of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Tagline</code>
| '''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Title</code>
| '''Returns'''
:The title of video which has an offset <code>number</code> with respect to the currently playing video.
{{highlight|'''Note'''<br>If it's in the database it will return the database title, else the filename.}}
|
|-
| <code>VideoPlayer.offset(number).Top250</code>
| '''Returns'''
:The IMDb Top250 position of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Trailer</code>
| '''Returns'''
:The path to the trailer of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).TVShowTitle</code>
| '''Returns'''
:The title of the episode's tvshow name which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).UserRating</code>
| '''Returns'''
:The user rating of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Votes</code>
| '''Returns'''
:The scraped votes of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Writer</code>
| '''Returns'''
:The name of Writer of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.offset(number).Year</code>
| '''Returns'''
:The year of release of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
| <code>VideoPlayer.position(number).Album</code>
| '''Returns'''
:The album from which the music video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Art(type)</code>
| '''Returns'''
:The art path for the requested arttype and for the video which has an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset with respect to the start of the playlist
:type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
|
|-
| <code>VideoPlayer.position(number).Artist</code>
| '''Returns'''
:The artist(s) of the music video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Country</code>
| '''Returns'''
:The production country of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Cover</code>
| '''Returns'''
:The cover of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).DBID</code>
| '''Returns'''
:The database id of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Director</code>
| '''Returns'''
:The director of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Episode</code>
| '''Returns'''
:The episode number of the episode which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Genre</code>
| '''Returns'''
:The genre(s) of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).IMDBNumber</code>
| '''Returns'''
:The IMDb ID of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).LastPlayed</code>
| '''Returns'''
:The last play date of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).mpaa</code>
| '''Returns'''
:The MPAA rating of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).OriginalTitle</code>
| '''Returns'''
:The original title of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).PlayCount</code>
| '''Returns'''
:The playcount of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Plot</code>
| '''Returns'''
:The complete Text Summary of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).PlotOutline</code>
| '''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Premiered</code>
| '''Returns'''
:The release or aired date of the video which has an offset <code>number</code> with respect to the start of the playlist. if it's in the database.
|
|-
| <code>VideoPlayer.position(number).Rating</code>
| '''Returns'''
:The scraped rating of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).RatingAndVotes</code>
| '''Returns'''
:The scraped rating and votes of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Season</code>
| '''Returns'''
:The season number of the episode which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Studio</code>
| '''Returns'''
:The studio of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Tagline</code>
| '''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Title</code>
| '''Returns'''
:The title of the video which has an offset <code>number</code> with respect to the start of the playlist.
{{highlight|'''Note'''<br>If it's in the database it will return the database title, else the filename.}}
|
|-
| <code>VideoPlayer.position(number).Top250</code>
| '''Returns'''
:The IMDb Top250 position of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Trailer</code>
| '''Returns'''
:The path to the trailer of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).TVShowTitle</code>
| '''Returns'''
:The title of the episode's tvshow name which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).UserRating</code>
| '''Returns'''
:The user rating of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Votes</code>
| '''Returns'''
:The scraped votes of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Writer</code>
| '''Returns'''
:The name of Writer of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.position(number).Year</code>
| '''Returns'''
:The year of release of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
| <code>VideoPlayer.StartTime</code>
| '''Returns'''
:The start date and time of the currently playing epg event or recording ( PVR ).
|
|-
| <code>VideoPlayer.SubtitleCodec</code>
| '''Returns'''
:The codec of the current subtitles of the currently playing video. Possible values include:
:ass
:dvb_subtitle
:dvb_teletext
:dvd_subtitle
:hdmv_pgs_subtitle
:microdvd
:mov_text
:mpl2
:realtext
:sami
:srt
:ssa
:subrip
:text
:ttml
:vplayer
:webvtt
:xsub
{{highlight|'''Note'''<br><code>VideoPlayer.SubtitleCodec</code> holds the codec of the next available subtitles stream if subtitles are disabled in the player.}}
|
|-
| <code>VideoPlayer.SubtitleLanguageEx</code>
| '''Returns'''
:The English name of the language of the current subtitle stream of the currently playing item.
|
|-
| <code>VideoPlayer.SubtitleName</code>
| '''Returns'''
:The name of the active subtitle stream of the currently playing video.
|
|-
| <code>VideoPlayer.TitleExtraInfo</code>
| '''Returns'''
:string containing extra information, enriching the title of the currently playing media, if any.
|
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre(separator)</code>
| '''Returns'''
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director(separator)</code>
| '''Returns'''
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.Cast(separator)</code>
| '''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer(separator)</code>
| '''Returns'''
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.ActStreamMux</code>
| '''Returns'''
:The multiplex type of played channel if available.
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamProviderName</code>
| '''Returns'''
:The provider name of the played channel if available.
|
|-
| <code>PVR.ActStreamServiceName</code>
| '''Returns'''
:The service name of played channel if available.
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendDeletedRecordings</code>
| '''Returns'''
:The number of deleted recordings present on the backend.
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendDiskSpaceProgr</code>
| '''Returns'''
:The available diskspace on the backend as percent value.
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.ClientName</code>
| '''Returns'''
:The name of the PVR client add-on, as specified by the add-on developer.
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.InstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client add-on, as specified by the user in the add-on settings. Empty if the PVR client add-on does not support multiple instances.
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannelIcon</code>
| '''Returns'''
:The icon of the next recording radio channel.
|
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.Numeric(settingid)</code>
| '''Returns'''
:return the setting value as an integer/numeric value.
'''See also'''
:<code>Skin.SetNumeric(settingid)</code>
|
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.TimerElapsedSecs(timer)</code>
| '''Returns'''
:The elapsed time in seconds for the provided <code>timer</code>.
'''Parameters'''
:timer - the timer name
|
|}

=== Slideshow ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.BuildVersionShort</code>
| '''Returns'''
:The shorter string with version of build.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.GetBool(boolean)</code>
| '''Returns'''
:The value of any standard system boolean setting.
{{highlight|'''Note'''<br>Will not work with settings in advancedsettings.xml}}
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.Locale(type)</code>
| '''Returns'''
:Locale-specific information depending on the requested type.
'''Parameters'''
:type - Can be one of the following:
:region The currently selected region name within the selected language ( <code>System.Language</code> ).
:iso The country code of the currently selected region as specified in langinfo.xml.
:[Removed options] <code>timezonecountry</code> and <code>timezone</code> from <code>System.Locale(type)</code>
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy policy.
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.SupportedHDRTypes</code>
| '''Returns'''
:The display's supported HDR types.
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|}

=== Weather ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Data(property)</code>
| '''Returns'''
:Weather data, as specified by the parameter.
|
|-
| <code>Weather.LastUpdated</code>
| '''Returns'''
:The localized date and time weather data were last updated, empty string if not available.
|
|}

=== Weather labels ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|}

<section end="main content" />

{{top}}

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

List of built-in functions

2026-06-22T13:56:47Z

Hitcher: Update built-in functions from Doxygen and remove outdated notice

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|}

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>exportlibrary2(library, exportFiletype, path [, unscraped][, overwrite][, artwork][, skipnfo] / [, albums][, albumartists][, songartists][, otherartists][, actorthumbs])</code>
| Export the video/music library with extended parameters
'''Parameters'''
:[in] library "video" or "music".
:[in] exportFiletype "singlefile", "separate" or "library".
:[in] path Path to destination folder.
:[in] unscraped Add "unscraped" to include unscraped items.
:[in] overwrite Add "overwrite" to overwrite existing files.
:[in] artwork Add "artwork" to include images such as thumbs and fanart.
:[in] skipnfo Add "skipnfo" to not include nfo files(just art).
:[in] albums Add "ablums" to include albums.
:[in] albumartists Add "albumartists" to include album artists.
:[in] songartists Add "songartists" to include song artists.
:[in] otherartists Add "otherartists" to include other artists.
:[in] actorthumbs Add "actorthumbs" to include other actor thumbs.
|
|-
| <code>musiclibrary.refreshalbum([albumId\])</code>
| Rescrapes additional information for a given album
'''Parameters'''
:[in] albumId Album Id.
|
|-
| <code>musiclibrary.refreshartist([artistId\])</code>
| Rescrapes additional information for a given artist
'''Parameters'''
:[in] artistId Artist Id.
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|}

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayDVD(param)</code>
| (deprecated) Plays the inserted disc, like CD, DVD or Blu-ray, in the disc drive.
'''Parameters'''
:[in] param "restart" to restart from resume point (optional)
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Tempo(value), Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(mediaPath[,isdir][,1][,playoffset=xx][,resume][,noresume][,playlist_type_hint=x])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start the media without switching to fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlaysDisc(parm)</code>
|  
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>QueueMedia(media[,isdir][,1][,playnext],[playoffset=xx])</code>
| Queues the given media. This can be a playlist, music, or video file, directory, plugin, disc image stack, video file stack or an URL. The optional parameter <code>,isdir</code> can be used for playing a directory. <code>,1</code> will start the media without switching to fullscreen. If media is a playlist or a disc image stack or a video file stack, you can use playoffset=xx where xx is the position to start playback from. where xx is the position to start playback from.
'''Parameters'''
:[in] media URL of media to queue.
:[in] isdir Set <code>isdir</code> if media is a directory (optional).
:[in] 1 Set <code>1</code> to start playback without switching to fullscreen (optional).
:[in] resume Set <code>resume</code> to force resuming (optional).
:[in] noresume Set <code>noresume</code> to force not resuming (optional).
:[in] playoffset Set <code>playoffset=<offset></code> to start playback from a given position in a playlist or stack (optional).
:[in] playnext Set <code>playnext</code> to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|
|}

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

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

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

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

|}

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadSkin(skinId)</code>
| Loads the skin passed as a parameter
'''Parameters'''
:[in] skinId Addon skin id of the skin.
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting <code>(setting)</code>. If <code>(setting)</code> is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If <code>(setting)</code> is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting <code>(setting)</code> to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetColor(string,header[,colorfile,selectedcolor])</code>
| Pops up a color selection dialog and allows the user to select a color to be used to define the color of a label control or as a colordiffuse value for a texture elsewhere in the skin via the info tag <code>Skin.String(string)</code>. Skinners can optionally set the color that needs to be preselected in the dialog by specifying the hex value of this color. Also optionally, skinners can include their own color definition file. If not specified, the default colorfile included with Kodi will be used.
'''Parameters'''
:[in] string Name of skin setting.
:[in] string Dialog header text.
:[in] string Hex value of the color to preselect (optional), example: FF00FF00.
:[in] string Filepath of the color definition file (optional).
'''Parameters'''
:[in] numeric Name of skin setting.
:[in] value Value of skin setting (optional).
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.TimerStart(timer)</code>
| Starts the timer with name <code>timer</code>
'''Parameters'''
:[in] timer The name of the timer
'''Parameters'''
:[in] timer The name of the timer
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting <code>(setting)</code> for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|}

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

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

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

<section end="main content" />

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

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

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

== References ==
<references />

{{updated|20}}

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

List of built-in functions

2026-06-22T13:21:19Z

Hitcher: Sort sections alphabetically

{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}

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

<section begin="main content" />
Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.EpgGridControl(command)</code>
| supported commands: firstprogramme (jump to the first programme) / currentprogramme (jump to the current programme) / lastprogramme (jump to the last programme) / selectdate (jump to the selected date & time) / +XX (jump XX hours forward) / -XX (jump XX hours back) / firstchannel (jump to the first channel) / playingchannel (jump to the currently playing channel) / lastchannel (jump to the last channel) / previousgroup (switch the epg to the previous group) / nextgroup (switch the epg to the next group) / selectgroup (select a group)
| {{nowrap|v19 Addition}}
|}

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

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

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

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

| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
|}

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

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

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

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

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

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

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

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

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

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

{{note|Following parameters are available from Kodi v20.}}
If media is a playlist (e.g. STRM), you can set the type of playlist with "playlist_type_hint=x" where x can be 0 for music playlist or 1 for video playlist, if not set will be used music playlist.
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
|-
| <code>QueueMedia()</code> <ref>https://github.com/xbmc/xbmc/pull/22048</ref>
| Queues the given media. This can be a playlist\, music\, or video file\, directory\, plugin or an Url. The optional parameter "\,isdir" can be used for playing a directory. "\,1" will start the media without switching to fullscreen. If media is a playlist\, you can use playoffset=xx where xx is the position to start playback from.
* @param[in] media URL of media to queue.
* @param[in] isdir Set "isdir" if media is a directory (optional).
* @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
* @param[in] resume Set "resume" to force resuming (optional).
* @param[in] noresume Set "noresume" to force not resuming (optional).
* @param[in] playeroffset Set "playoffset=<offset>" to start playback from a given position in a playlist (optional).
* @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently playing. If player is not playing, append media to current playlist (optional).
|

|}

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

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

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

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

|}

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

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

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

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

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

<section end="main content" />

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

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

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

== References ==
<references />

{{updated|20}}

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

InfoLabels

2026-06-22T13:18:15Z

Hitcher: Sort sections alphabetically

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca**
:*dts***
:*dolbydigital
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp2
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
:
: ** note: dca replaced dts in 2011. Deprecated in 2026 / v22.
: *** note: dts used before 2011 and reintroduced in 2026 / v22.
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Cast(separator)</code>
| '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.Director(separator)</code>
| '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.Genre(separator)</code>
| '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Writer(separator)</code>
| '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|}

=== Network ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|}

=== Player labels ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|}
==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Genre(separator)</code>
| '''Returns'''
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre(separator)</code>
| '''Returns'''
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director(separator)</code>
| '''Returns'''
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.Cast(separator)</code>
| '''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer(separator)</code>
| '''Returns'''
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|}

=== Slideshow ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|}

=== Weather labels ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|}

<section end="main content" />

{{top}}

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

List of boolean conditions

2026-06-22T13:16:27Z

Hitcher: Sort sections alphabetically

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use boolean conditions with the '''<visible>''' tag or with condition attributes. Scripts can read boolean conditions with <code>'''xbmc.getCondVisibility'''(condition)</code>.

=== Global ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
|-
| <code>false</code>
| Returns
:Always evaluates to '''false'''.
|-
| <code>no</code>
| Returns
:same as '''false'''.
|-
| <code>true</code>
| Returns
:Always evaluates to '''true'''.
|-
| <code>yes</code>
| Returns
:same as '''true'''.
|}

=== Addon ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingBool(addon_id,setting_id)</code>
| '''Returns'''
:'''True''' if the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code> is '''True''', '''False''' otherwise.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>The provided setting with <code>setting_id</code> must be a boolean setting type.<br>
Otherwise it will return the boolean info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{| class="wikitable sortable"" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column(column_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the column given.
'''Parameters'''
:'''column_number''' - The column number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| '''Returns'''
:'''True''' if the container with id has static content and is focused on the item with id item_number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasNext</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a next page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasParent</code>
| '''Returns'''
:'''True''' when the container with id contains a parent ('..') item.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasPrevious</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a previous page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).IsUpdating</code>
| '''Returns'''
:'''True''' if the container with dynamic list content is currently updating.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnNext</code>
| '''Returns'''
:'''True''' if the container with id is moving to the next item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnPrevious</code>
| '''Returns'''
:'''True''' if the container with id is moving to the previous item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollNext</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the next item.
:Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollPrevious</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the previous item.
:Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Position(position_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the position given.
'''Parameters'''
:'''position_number''' - The position number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Row(row_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the row given.
'''Parameters'''
:'''row_number''' - The row number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Scrolling</code>
| '''Returns'''
:'''True''' if the user is currently scrolling through the container with id.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.<br>
This is slightly delayed from the actual scroll start.<br>
Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.}}
|
|-
| <code>Container(id).SubItem</code>
| '''Returns'''
:'''True''' if the container with id is focused on the specified subitem.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container.CanFilter</code>
| '''Returns'''
:'''True''' when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| '''Returns'''
:'''True''' when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Content(parameter)</code>
| '''Returns'''
:'''True''' if the current container you are in contains the following:
:*actors
:*addons
:*albums
:*artists
:*directors
:*episodes
:*files
:*genres
:*livetv
:*movies
:*musicvideos
:*playlists
:*plugins
:*seasons
:*sets
:*songs
:*studios
:*tags
:*tvshows
:*years
{{highlight|'''Note'''<br>
These currently only work in the Video and Music Library, unless a Plugin has set the value.}}
|
|-
| <code>Container.Filtered</code>
| '''Returns'''
:'''True''' when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasFiles</code>
| '''Returns'''
:'''True''' if the container contains files.
|
|-
| <code>Container.HasFolders</code>
| '''Returns'''
:'''True''' if the container contains folders.
|
|-
| <code>Container.HasThumb</code>
| '''Returns'''
:'''True''' if the current container you are in has a thumb assigned to it.
|
|-
| <code>Container.IsStacked</code>
| '''Returns'''
:'''True''' if the container is currently in stacked mode.
|
|-
| <code>Container.SortDirection(ascending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is descending.
|
|-
| <code>Container.Sortmethod(sortid)</code>
| '''Returns'''
:'''True''' if the current sort method matches the specified SortID [[https://kodi.wiki/view/List_of_built-in_functions#List_of_sort_methods see list of sort methods]].
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Control.HasFocus(id)</code>
| '''Returns'''
:'''True''' if the currently focused control has id "id".<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsEnabled(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is enabled.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsVisible(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is visible.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| '''Returns'''
:'''True''' if the control group with id “group” has control id “id” as its focused item.<br>
'''Parameters'''
:'''group''' - The id of the group.
:'''id''' - The id of the focused item.
{{highlight|'''Note'''<br>
If “id” is not present, or is 0, then it will return true if the currently focused control is in the control group with id “group”.<br>
If the control group with id “group” does not have focus, then this will still return true if the last focused item in the group had control id “id”.<br>
'''WARNING'''<br>
Avoid using IDs 9000-9999 as this is the range assigned to groups with no ID value.}}
|
|}

=== Integer ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| v19
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| v19
|}

=== Library ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Library.HasContent(Role,Composer)</code>
| Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library
| v17
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets, BoxSets)
|
|-
| <code>Library.HasNode(path)</code>
| Returns True if the specified node is available (example: Library.HasNode(library://video/movies/titles.xml))
| v19
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>ListItem.HasArchive</code>
| Returns True when the selected channel has a server-side back buffer (PVR)
| v19
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| Returns True if the item has a reminder set (PVR)
| v19
|-
| <code>ListItem.HasReminderRule</code>
| Returns True if the item was scheduled by a reminder timer rule (PVR)
| v19
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16
|-
| <code>ListItem.HasVideoExtras</code>
| Returns true if the ListItem has video extras
|
|-
| <code>ListItem.HasVideoVersions</code>
| Returns true if the ListItem has video versions
|
|-
| <code>ListItem.IsAutoUpdateable</code>
| Returns True if this add-on can be updated automatically
| v19
|-
| <code>ListItem.IsBoxset</code>
| Returns True if the item is part of a boxset album
| v19
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsFinale</code>
| Returns true if the item is a finale (for example, a season finale showing on Live TV)
| v19
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsLive</code>
| Returns true if the item is live (for example, a Live TV sports event)
| v19
|-
| <code>ListItem.IsNew</code>
| Returns true if the item is a premiere (for example, a Live TV show that will be first aired) (PVR)
| v19
|-
| <code>ListItem.IsParentFolder</code>
| Returns true is the slected item is the 'up' item
| v17
|-
| <code>ListItem.IsPlayable</code>
| Returns True when the selected programme can be played (PVR)
| v19
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsPremiere</code>
| Returns true if the item is a premiere (for example, a Movie first showing or season first on Live TV)
| v19
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(Addon.HasUpdate)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>ListItem.Property(Addon.IsBinary)</code>
| Returns true for binary addons
| v19
|-
| <code>ListItem.Property(Addon.IsEnabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsFromOfficialRepo)</code>
| Returns true if the addon is from an official repository
| v19
|-
| <code>ListItem.Property(Addon.IsInstalled)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsUpdate)</code>
| Returns True if this add-on is a valid update of an installed outdated add-on
| v19
|-
| <code>ListItem.Property(Addon.Orphaned)</code>
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)
| v17
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(Stream.Is3D)</code>
| Returns true if the video stream is a 3D (stereoscopic) video, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsDefault)</code>
| Returns true if the audio/video/subtitle stream is default, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsExternal)</code>
| Returns true if the subtitle stream is external, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsForced)</code>
| Returns true if the audio/subtitle stream is forced, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsHearingImpaired)</code>
| Returns true if the subtitle stream is for the hearing impaired (aka SDH-Subtitles for the Deaf or Hard-of-Hearing/CC-Closed Captions), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsOriginal)</code>
| Returns true if the audio/subtitle stream is in the original language, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsVisualImpaired)</code>
| Returns true if the audio stream is for the visually impaired (aka AD-Audio Description), for use in dialogselect.xml
| v22
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17
|-
| <code>ListItem.TimerIsActive</code>
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
| v17
|}

=== Network ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.IsDHCP</code>
| '''Returns'''
:'''True''' if the network type is DHCP.
{{highlight|'''Note'''<br>
Network type can be either DHCP or FIXED.}}
|
|}

=== Player ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.ChannelPreviewActive</code>
| Returns true if PVR channel preview is active (used channel tag different from played tag)
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.FrameAdvance</code>
| Returns true if player is in frame advance mode
| v18
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasGame</code>
| Returns true if the player is playing a game
| v18
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasResolutions</code>
| Returns true when multiple resolutions are available
| v18
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.IsLive</code>
| Returns if the inputstream of the player is a live stream (a.k.a. real time stream).
| v22
|-
| <code>Player.IsTempo</code>
| Returns true if the current playbackspeed is not equal to 1
| v17
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.TempoEnabled</code>
| Returns true if the current player supports changing the playback speed
| v17
|}
==== MusicPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>MusicPlayer.IsMultiDisc</code>
| Returns true if the current album consists of two or more discs
| v19
|}

==== VideoPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.HasVideoVersions</code>
| Returns true if the currently playing video has versions.
| v21
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows, etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (e.g. director, plot, etc).
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== PlayList ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| v18
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| v17
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| v17
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| v17
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| v17
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| v19
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| v18
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| v17
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| v17
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| v17
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>RDS.HasHotline</code>
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)
|
|-
| <code>RDS.HasRadioText</code>
| Returns true if RDS contains also Radiotext
|
|-
| <code>RDS.HasRadioTextPlus</code>
| Returns true if RDS with Radiotext contains also the plus information
|
|-
| <code>RDS.HasRds</code>
| Returns true if RDS is present
|
|-
| <code>RDS.HasStudio</code>
| Returns true if a studio name is present (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|}

=== String ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|}

=== System ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>System.AddonIsEnabled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.HasCMS</code>
| Returns true if colour management is supported in Kodi.
| v17
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles| profile]] login screen is enabled
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.HasPVRAddon</code>
| Returns true if at least one PVR addon is installed on the system.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, e.g. when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.InternetState</code>
| Returns true if the system is connected to the internet, returns false in case no internet connection is available.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles| profile]]
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| v18
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.SupportsCPUUsage</code>
| Return True if the system provides CPU info
| v19
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (e.g. in Milkdrop.)
|
|}

=== Weather ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Window.Is(name)</code>
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible
| v17
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]
* [[Conditional visibility]]

{{top}}

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

Add-on:OzWeather

2026-05-23T06:54:50Z

Hitcher:

{{Addon
|Name=OzWeather
|provider-name=Bossanova808
|ID=weather.ozweather
|latest-version=2.1.7
|extension point=xbmc.python.weather
|provides=
|Summary=Weather forecasting and radar images for Australia using Bureau of Meteorology data
|Description=Weather forecasting and radar images for Australia using Bureau of Meteorology data. For full features (animated radars & ABC weather videos) - make sure you install the replacement skin files - see information at the addon wiki (https://kodi.wiki/index.php?title=Add-on:Oz_Weather).
|Platform=all
|Language=en
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=116905
|Website=https://kodi.wiki/index.php?title=Add-on:Oz_Weather
|Source=https://github.com/bossanova808/weather.ozweather
|Email=bossanova808@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/omega/weather.ozweather/icon.png}}

This add-on is actively supported and currently works with Kodi Matrix & later version. (Historically, it has been continuously supported since the days of XBMC Frodo, way back in 2011!).

Support, discussion, release notification:[https://forum.kodi.tv/showthread.php?tid=116905 on the Kodi forum thread].
(If you like it and use it, and want to support it surviving into the future, there is a 'buy me a coffee' link in the first post in the forum thread).

OzWeather is the only Kodi weather add-on to source it's data directly from the BOM API (Australian Bureau of Meteorology) - this is really the only authoritative, high quality source for weather data in Australia.

You may also be interested in a companion project - a '10-foot Dashboard' system to display Kodi Now Playing and Australian Weather information (again, source from the BOM). Information on that is [https://github.com/bossanova808/10-foot.dash here]. This is a great way to re-purpose an old phone or tablet you have lying around.

===== OzWeather Features =====

* Animated BOM radar maps (ee notes on an addon to perform the skin changes needed for this, below)
* Auto locates your closest radar, but you can override this and choose any BOM radar loop if you wish
* You can slo create multiple locations that show the same weather data but different radar ranges, if you want e.g. a long and short range view.
* 7 Day Forecasts
* Today's extended forecast
* Direct button access to the 'ABC National Weather Update in 90 Seconds' video report
* Utility provided below to make patching skin files easy (supports: Estuary/Estouchy/Confluence/Confluence Zeitgeist/Xonfluence/OSMC/Amber/Aeon Nox Silvo/Aeon Tajo - more by request...)
* Mini weather when you pause video & display video information etc. if you want (Confluence/Estuary only currently).

Version 2 of the addon (June 2021 on), looks like this:

<gallery>
File:OzWeather_V2_Estuary.jpg|OzWeather in Estuary
File:OzWeather V2 Confluence.jpg|...in Confluence
File:OzWeather-Amber.jpg|...in Amber
</gallery>

...you get the idea... (all of these are using the SkinPatcher mentioned below to easily & automatically customise the Weather section).

==== Instructions ====

Go into Get More Add-Ons and choose Weather -> OzWeather... (Oz Weather is in the official Kodi repository). For radar support, see notes below on skin changes and a tool to help with this.

'''NB Troubleshooting: if you experience errors running OzWeather, particularly if using profiles other than the default Master profile, please check in Settings->System->Addons->Manage Dependencies and make sure that the Bossanova808 dependencies, pytz, requests and urllib3 modules are all enabled!'''

To Configure - First, go to Kodi settings->Weather and choose the OzWeather add on as your selected weather information add on.

In the addon settings you can add up to six BOM locations - you can enter either your postcode or suburb & OzWeather will prompt you to choose from a list of matching locations.

If you enable the extended features (see skin changes required below!) - you can also have animated radars. When you add a new location, OzWeather auto-selects the closest radar to it - but you can overrule this if you wish by manually putting in any BOM radar code.

To manually get a radar code:

The easiest way is to click on a desired point on this [https://reg.bom.gov.au/australia/radar/ BOM MAP]. Then click the range you like the best (in the Radar line, e.g. 128 or 256km) - then you will see the code in the resulting url - e.g.

IDR023

(N.B. you need to use the code verbatim as it appears in the URL, including the 'IDR' and the correct number of preceeding 0s!).

Another way to manually find a radar code is to use the search/filter field about half way down [https://www.bom.gov.au/catalogue/anon-ftp.shtml this page] to the right, and enter a radar location - you can use [https://www.bom.gov.au/resources/learn-and-explore/radar-and-equipment-knowledge-centre/weather-radars#bom-anchor-list__item-weather-radar-coverage-in-australia this map] to find the radar locations.

There is also a more formal [https://reg.bom.gov.au/catalogue/Bureau_of_Meteorology_radar_images_user_guide.pdf PDF document] about this.

Important: not all codes actually work all the time, as some radars are only in part time use. The main capital city ones work reliably, e.g. IDR023 above which is the Melbourne 128km loop, or try IDR00004 for a nice national radar. OzWeather wants the radar to be there, so if you're experiencing reliability issues, try another radar.

Notes:
If ever you experience issues with missing radar ''background'' images, wait a day or two, then use the 'purge backgrounds on next refresh' option in the add-on 'Troubleshooting' settings. With luck your backgrounds will be re-downloaded successfully on the next weather retrieval run.

==== Skin Changes ====

If you enable the extended forecasts & radar, skin changes are required to see this content.

'''Utility to Patch Skins'''

If you're on Kodi Matrix and above, and you're using one of these skins:

* Estuary (& Plextuary)
* Estouchy
* Amber
* Aeon Nox Silvo
* Aeon Tajo
* OSMC Skin
* Confluence
* Confluence Zeitgeist
* Xonfluence
* (Other similar derivatives of Estuary/Aeon/Confluence or whatever ''may'' also work...)

...I have written a utility tool to make this MUCH easier. It can automatically patch the skin for you and (as of October '25) - will even do so automatically every time a new skin OR OzWeather update comes along (you can turn off this auto-patching, if you wish, of course).

'''Note that your skin folder MUST be writeable by the skin patcher addon''' for this to work (for the Core/Libre-ELEC editions of Kodi, see below, and if you're on some Android platforms, you _may_ need a rooted device - nothing I can do about this, sorry!).

I am ''in theory'' happy to add support for other skins (and especially if you can develop & supply working skin files for the current Kodi version!) - just let me know what skin support you're after in the OzWeather forum thread.

The Kodi team will not allow an addon that modifies skin file in to their main repository, understandably. Thus, to install the skin patcher utility - you will first need to install my repository.

Download the latest .zip for that here: https://github.com/bossanova808/repository.bossanova808/tree/master/repository-downloads/repository.bossanova808 (n.b. make sure to use the actual download button, not the 'Raw' button!)

Install that using 'install from zip' in the Kodi addons area, and then install the 'OzWeather Skin Patcher' add-on from that repository. Then, you just run it. It can both patch and restore your skin files as needed. After the initial patch, it will detect future skin/OzWeather updates, and automatically re-patch if needed.

With Confluence and Estuary you get the added bonus of some weather info during playback when you show the video info. With Confluence either the Info (i) or Menu (m) will bring it up, with Estuary just the Menu (m). It looks roughly like this:

<gallery>
File:OzWeather Estuary - Seek.jpg|Now Playing Radar Support
</gallery>

'''Using Corelec / LibreElec with Estuary?'''

In the case of the -ELEC editions of Kodi, unfortunately the main skin folder is '''not''' writeable. This is unfortunately just part of how the -ELEC versions of Kodi are set up. Here are your options:
* Don't use Estuary! Use one of the other supported skins (as, let's face it, Estuary is a low point for Kodi default skins anyway, so you're really not missing much...)
* Or - create your own version of Estuary. Copy the whole estuary folder into your (writeable) add-ons folder, modifying the addon id in addon.xml to give your version a unique name (e.g. skin.estuary-mymod). To then keep your special version of the skin up to date, create a script and set it up to run by cron (or alternatively add these commands to your autostart.sh if you're using one of those) - with the following content (changing the folder name to whatever you've named your personal skin of course):

#!/bin/sh
rsync -a --exclude 'addon.xml' --exclude 'MyWeather.xml' --exclude 'VideoFullScreen.xml' /usr/share/kodi/addons/skin.estuary/ /storage/.kodi/addons/skin.estuary-mymod/
/usr/bin/python /usr/bin/kodi-send -a ReloadSkin

'''The Manual Approach'''

Otherwise, if you're some sort of masochist, you can take a manual approach to patching your skin files , using these instructions/files...note that there are updates to these files in the skin patcher add on so use that if at all possible.

You just need to copy some files into your skin/720p or skin/xml folder. Note this *will* break compatibility with other weather add ons, so best to back up the original files first if you're worried about this. Also, you'll have to do some manual search and replacing in the skin files, as the skin patcher uses a 'template tags' system to let folks change text and background colours. You'll need to manually do the equivalent of this python code:

new_data = new_data.replace('_colour_text_default_', ADDON.getSetting('colour_text_default'))
new_data = new_data.replace('_colour_text_dim_', ADDON.getSetting('colour_text_dim'))
new_data = new_data.replace('_colour_text_dimmer_', ADDON.getSetting('colour_text_dimmer'))
new_data = new_data.replace('_colour_text_high_temp_', ADDON.getSetting('colour_text_high_temp'))
new_data = new_data.replace('_colour_text_low_temp_', ADDON.getSetting('colour_text_low_temp'))
new_data = new_data.replace('_background_visible_', 'yes' if ADDON.getSettingBool('background_visible_bool') else 'no')
new_data = new_data.replace('_background_opacity_', ADDON.getSetting('background_opacity'))

(Another approach, perhaps, would be to run the skin patcher once, then grab the skin files it has generated with your preferred colours, and save those off somewhere for your later purposes...but of course you won't benefit from any future updates to those skin files...)

The latest version of the skin files can be found at: https://github.com/bossanova808/repository.bossanova808/tree/master/staging/script.ozweather-skinpatcher/resources/skin-files

'''...but for 99% of folks, the skin patcher add on above is the ''much'' easier alternative - so try that first!'''

=== Support & Troubleshooting ===

I've been supporting this add on for 15+ years now. I use it myself, of course, and I keep it working as smoothly as the upstream sources allow me to.

If things don't work as expected and you need to ask for help - always supply a link to a FULL DEBUG LOG so I have some real chance of helping you. I '''will''' check it and help, if you supply it. But log snippets, or logs without debug logging enable, are NOT enough.

If you're having problems running the add on (and especially if you use Kodi profiles) - make sure that Bossanova808 dependencies, pytz, requests and urllib3 modules are ALL enabled, for the profile you're using specifically. (System -> Addons -> Manage Dependencies...).

If using a manual radar code, do check your radar code carefully - is it _exactly_ as the BOM one - i.e. '''IDR023''' or similar. You '''must''' include the '''IDR''' part, and the right nu,ber of preceding 0s if there are any! Does the URL in the debug log load if you paste it in to your browser?

Any issues, please post them [https://forum.kodi.tv/showthread.php?tid=116905 on the Kodi forum thread].

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Weather add-ons]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Jarvis add-on repository]]
[[Category:Krypton add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]
[[Category:Omega add-on repository]]

List Container

2026-05-11T08:12:28Z

Hitcher: /* Available tags */

<section begin="main content" />
The list container is one of several containers used to display items from file lists in various ways. The list container is very flexible - it's only restriction is that it is a list - i.e. a single column or row of items. The layout of the items is very flexible and is up to the skinner.
=== Example ===
<syntaxhighlight lang="XML">
<control type="list" id="50">
<description>My first list container</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
<viewtype label="3D list">list</viewtype>
<orientation>vertical</orientation>
<pagecontrol>25</pagecontrol>
<autoscroll>true</autoscroll>
<scrolltime tween="sine" easing="out">200</scrolltime>
<itemlayout width="650" height="29">
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
<font>font13</font>
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
<font>font13</font>
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</itemlayout>
<focusedlayout height="29" width="650">
<control type="image">
<width>485</width>
<height>29</height>
<left>0</left>
<top>0</top>
<visible>Control.HasFocus(50)</visible>
<texture>list-focus.png</texture>
</control>
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
<font>font13</font>
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
<font>font13</font>
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</focusedlayout>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''viewtype'''
| The type of view. Choices are list, icon, wide, wrap, biglist, bigicon, bigwide, bigwrap, info and biginfo. The label attribute indicates the label that will be used in the "View As" control within the GUI. It is localizable via strings.po. ''viewtype'' has no effect on the view itself. It is used by kodi when switching skin to automatically select a view with a similar layout. Skinners should try to set ''viewtype'' to describe the layout as best as possible.
|-
| '''orientation'''
| The orientation of the list. Defaults to vertical.
|-
| '''pagecontrol'''
| Used to set the <id> of the page control used to control this list.
|-
| '''scrolltime'''
| The time (in ms) to scroll from one item to another. By default, this is 200ms. The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling. The scroll movement can be further adjusted by selecting one of the available [[Tweeners|tween]] methods.
|-
| '''itemlayout'''
| Specifies the layout of items in the list. Requires the height attribute set in a vertical list, and the width attribute set for a horizontal list. The <itemlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''focusedlayout'''
| Specifies the layout of items in the list that have focus. Requires the height attribute set in a vertical list, and the width attribute set for a horizontal list. The <focusedlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''content'''
| Used to set the item content that this list will contain. Allows the skinner to setup a list anywhere they want with a static set of content, as a useful alternative to the grouplist control. See [[Static List Content|Static List Content]] or [[Dynamic List Content|Dynamic List Content]] for more information.
|-
| '''preloaditems'''
| Used in association with the [[Archive:Background Image Loader|Background Image Loader]].
|-
| '''autoscroll'''
| Used to make the container scroll automatically
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Advancedsettings.xml

2026-04-25T10:47:43Z

Hitcher: /* pvrrecordings */

{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}

<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.

This file is used for advanced settings and options that do not have GUI controls inside of {{kodi}}. Some settings are experimental or very rarely set, so they can only be used via the advancedsettings.xml file. The file is simply a plain text file and can be edited by various text editors, so long as the name is "advancedsettings.xml". These advanced settings can be used to tweak various things such as episode naming patterns, special network ports, special behaviors, and more.<section end="intro" />

The following page will describe the structure of the advancedsettings.xml file and the various individual settings.

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}
# On some platforms it will be easier to copy, move or delete this file by using the built-in '''[[File_manager|File Manager]]''' tool accessible in the '''[[Settings]]''' screen.

== Layout ==

The layout of <code>advancedsettings.xml</code> is as follows:

<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives its value.

A list of the available "setting" strings and their values is given below.

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang=xml enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang=xml enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
<delay>0</delay>
<hdrextradelay>0</hdrextradelay>
<refresh>
<min></min>
<max></max>
<rate></rate>
<delay></delay>
<hdrextradelay></hdrextradelay>
</refresh>
</latency>
</syntaxhighlight>
| '''Latency''' helps correct audio/video synchronization (lip-sync) when the display's internal processing introduces noticeable delays in the display of the pictures. The optional overrides and hdr extra delay offer further fine-tuning when the delay is not the same for all refresh rates or the HDR vs SDR modes. Latency is given in milliseconds. For one-off adjustments use the OSD during playback to adjust audio synchronisation.<br/><br/>
'''<delay>''' - Global default display latency.<br>
'''<hdrextradelay>''' - Global default latency added to the global default display latency when the display is in any HDR mode. Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).<br>
'''<refresh>''' - Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.<br>
'''<min>''', '''<max>''' - refresh rate range, OR<br>
'''<rate>''' - exact refresh rate<br>
'''<delay>''' - display latency for the given refresh rate<br>
'''<hdrextradelay>''' - additional latency when the display is in any HDR mode for the given refresh rate<br>
<br/>
'''Example:''' The following example sets display latency of 125 msec at 23-24 Hz
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
<br/>
'''Example:''' The following example sets display latency of 50 msec at 50 (+/-0.01) Hz
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>

|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang=xml enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>


<maxcommbreaklength>250</maxcommbreaklength>


<mincommbreaklength>90</mincommbreaklength>


<maxcommbreakgap>120</maxcommbreakgap>


<commbreakautowait>0</commbreakautowait>


<commbreakautowind>0</commbreakautowind>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>label</sortmethod> 
<sortorder>ascending</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" line='line'>
<epg>
<updatecheckinterval>300</updatecheckinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<cleanupinterval>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</syntaxhighlight>

== Video library settings ==

=== videoextensions ===
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.001 .3g2 .3gp .asf .asx .avc .avi .avs .bdm .bdmv .bin .bivx .dat .divx .dv .dvr-ms .evo .fli .flv .f4v
.h264 .ifo .img .iso .m2t .m2ts .m2v .m3u .m3u8 .m4v .mkv .mk3d .mov .mp4 .mpd .mpeg .mpg .mpl .mpls .mts
.nrg .nsv .nuv .ogm .ogv .pls .pva .pxml .qt .rcv .rec .rm .rmvb .rss .sdp .strm .svq3 .tp .trp .ts .ty
.url .udf .vc1 .vdr .viv .vob .vp3 .webm .wmv .wpl .wtv .xsp .xspf .xvid .zip
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==
To prevent the resizing of artwork add the following two tags and values to your advancedsettings.xml file. More details on each tag follows in the next sections.
<syntaxhighlight lang=xml enclose="div">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

<syntaxhighlight lang=xml enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached fanart]] should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.<section end="fanartres description" />

<syntaxhighlight lang=xml enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for music, video, TV, and EPG databases.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of kodi's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as Kodi is concerned) paths. Use this for mysql only.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;<port>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
:by default "MyVideos"+DB number will be used.
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.
* mysql: defines the name of the database to use

;<user>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<connecttimeout> [https://github.com/xbmc/xbmc/pull/26657]
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines a connect timeout, in seconds. Default value is 5 seconds.

;<compression>
: ''Optional'' - Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}

;<key>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<cert>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ca>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<capath>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ciphers>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>kodi_video</name>
<user>kodi</user>
<pass>kodi</pass>
<connecttimeout>3</connecttimeout>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
</musicdatabase>
</syntaxhighlight>

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.aac .ac3 .aif .aiff .ape .cmc .cmr .cue .dmc .dff .dsf .dsp .dts .dtshd .flac .gcm .gdm .idsp .imf
.m15 .m3u .m4a .m4b .mac .mka .mp+ .mp2 .mp3 .mpa .mpc .mpd .mpdsp .mpp .mpt .mss .nsv .oga .ogg .opus
.pls .pxml .rm .rma .rmt .rsd .rss .sap .sfx .shn .spt .strm .tak .tm2 .tm8 .tmc .tta .uni .url
.waa .wam .wav .wma .wpl .wtv .wv .wvs .xsp .xspf .xwav .zip
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang=xml enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang=xml enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang=xml enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<recentlyaddeditems>35</recentlyaddeditems> 

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

<albumformat>%B - %Y</albumformat> 

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>


<useisodates>false</useisodates> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[Add-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<fronttobackrendering>true</fronttobackrendering>
</gui>
</syntaxhighlight>

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

* true: on '''(Default)'''
* false: off

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]
[[Category:Karellen]]

TexturePacker

2026-04-12T08:14:21Z

Hitcher:

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}
<section begin="intro" />Kodi uses a tool named TexturePacker to compile all images used in a skin into a single file. The benefit of it is that images inside the Textures.xbt will load faster in the skin. This is done by converting all images into a format that take less processing by Kodi when they need to be rendered onto the screen.

A common misconception is that TexturePacker will just compress the images into a single file. This if far from the truth, so don't be surprised if the Textures.xbt file is much larger than the total size of all the individual images.
<section end="intro" />
== How To Get It ==
If you are using Windows, you can simply download a zipfile with an up-to-date version of TexturePacker from the Kodi mirrors.
<br /><big>'''It is available here:''' [http://mirrors.kodi.tv/build-deps/win32/texturepacker-1.1.1-win32.7z '''Download TexturePacker 1.1.1''']</big>
{{note| This is a dll free self contained texturepacker executable for windows.}}
{{note| Kodi v17 does not support DXT packed textures anymore. Make sure you pack your skin textures with latest texturepacker (1.1.0 or newer).}}

On other platforms, you will have to compile TexturePacker. TexturePacker is built and stored in ../tools/depends/native/TexturePacker/bin during Kodi's configure process. Bootstrap and configure can be lengthy. If you only need TexturePacker, you can save some effort: install the Kodi source and build dependencies in preparation for a build ([http://kodi.wiki/view/Category:Compiling '''Compiling from source''']) and build TexturePacker directly:

<syntaxhighlight lang="bash">
cd xbmc/tools/depends/native/TexturePacker
make
</syntaxhighlight>

{{Note| TexturePacker depends on libgif which is currently not a ''Kodi'' dependency. Ensure the library and its development headers (Debian: libgif-dev package) is installed before compiling.}}

One you have downloaded/build TexturePacker, copy it to the kodi addons folder.

== Usage ==
Since TexturePacker is a command-line tool, you will need to open a dos box/terminal/console in order to run it. Navigate to the kodi addons folder and use:
<pre>TexturePacker -dupecheck -input skin.name\media -output skin.name\media\Textures.xbt</pre>

The optional ''-dupecheck'' option is useful if you have included the same image multiple times in your media folder. For example, if your skin includes a lot of studio logos, most likely a lot of them are included multiple times but with a slightly different filename. The '-dupecheck' option will make sure each unique image is included only once in the Textures.xbt file, thus keeping the size of it as small as possible.

If your skin includes [[Skin_development_introduction#Skin_Themes|Skin Themes]] you should also run TexturePacker on your theme folders:
<pre>TexturePacker -dupecheck -input skin.name\themes\Blue -output skin.name\media\Blue.xbt</pre>

{{Note| When using an XBT file in your skin, your file paths will '''not''' be case sensitive, even if your skin resides on a case sensitive file system!}}

Alternatively, you can use the [[TextureTool|Kodi - Texture Tool]] which provides a Graphical User Interface for the same usage.

== Advanced Usage - Texturepacker build bat ==
In case you want to automate the process and remove all the source images after the .xbt file has been compiled, you can optionaaly create a batch file with all needed commands.
Create a Texturepacker.bat with the contents below, inside the skin.name directory along with all the texturepacker.exe, a double click on the bat file does all the work for you.
<pre>
@ECHO OFF

COLOR A

ECHO -------------------------------------------------------------------------
ECHO ^> ** Creating excludes... **

ECHO .svn>exclude.txt
ECHO .git>>exclude.txt
ECHO Thumbs.db>>exclude.txt
ECHO Desktop.ini>>exclude.txt
ECHO dsstdfx.bin>>exclude.txt
ECHO build.bat>>exclude.txt
ECHO \skin.confluence\media\>>exclude.txt
ECHO \skin.confluence\backgrounds\>>exclude.txt
ECHO exclude.txt>>exclude.txt

ECHO -------------------------------------------------------------------------
ECHO.

ECHO -------------------------------------------------------------------------
ECHO ** Creating Textures XBT File... **
ECHO -------------------------------------------------------------------------

ECHO.
PING -n 2 -w 1000 127.0.0.1 > NUL
START /B /WAIT TexturePacker -dupecheck -input media\ -output media\Textures.xbt
PING -n 2 -w 20000 127.0.0.1 > NUL
ECHO.
ECHO.
ECHO -------------------------------------------------------------------------
ECHO ^> Deleting excludes...
DEL exclude.txt
ECHO ^> Done
ECHO -------------------------------------------------------------------------
ECHO.
ECHO.

ECHO -------------------------------------------------------------------------
ECHO ** XBT build complete - scroll up to check for errors. **
ECHO -------------------------------------------------------------------------

PING -n 50 -w 5000 127.0.0.1 > NUL
</pre>

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

TextureTool

2026-04-11T21:06:39Z

Hitcher: /* Usage */

[[File:texturetool.png|300px|right]]
{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="intro" />TextureTool ([http://forum.kodi.tv/showthread.php?tid=201883 Communityproject developed by supp.]) is giving you the possibility to decompile and compile .xbt files.
It's also providing a Graphical User Interface (GUI).

The TextureTool is based on tiben20's (Team Kodi) command line extractor and TexturePacker.
<section end="intro" />

== Download ==

TextureTool is only working with Windows XP and above.
<br /><big>'''It is available here:''' [https://github.com/e0xify/KodiXBMCTextureTool/releases/download/2.9.2/Kodi.-.Texture.Tool.exe '''Download TextureTool 2.9.2''']</big>

{{Note| TextureTool requires Visual C++ Redistributable for Visual Studio (vcredist.exe).}}

== Usage ==

The TextureTool does support alot of error handling so there isn't a way to do much mistakes.
There are two primary functions. The decompile Mode and the compile Mode. You will see them by opening the tool.

The Decompile Mode (extract .xbt files)
<syntaxhighlight lang="bash">
1. Select your input file in the FileopenDialog Window
2. Select the output directory (where your files should be extracted to)
3. Press the "start" button to begin.
</syntaxhighlight>

The Compile Mode (TexturePacker - compile .xbt files)
<syntaxhighlight lang="bash">
1. Select your input directory in the FileopenDialog Window
2. Select the output .xbt file (for example "Textures.xbt")
3. Press the "start" button to begin.
</syntaxhighlight>

== Additional Informations ==

* Kodi - Texture Tool is not supporting spaces in directorys (error handling is enabled)
* Updater is included
* You are able to select advanced options (for example: dupecheck / disable lz0)
* Application is portable
* dev mode available by using Ctrl + shift + d
* Logfile will be generated/deleted with every (re)start of the application
* There may be some false positive alerts, due to GDIPlus includes (drawimage dlls).

== Support ==

If you are facing any issues feel free to submit your logfiles and description in the kodi board [http://forum.kodi.tv/showthread.php?tid=201883 here].

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

Opening Windows and Dialogs

2025-11-30T21:00:36Z

Hitcher: /* AddonBrowser */

{{mininav|[[Development]]|[[Add-on development]]}}

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section/window of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows allow you to jump directly to a sub-section of that window. To do this, you can use either the sub-section's name or its path.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>
or
<pre>ActivateWindow(Videos,videodb://movies/titles/)</pre>

Below is a list of the available sub-sections in the Videos, Music, and Programs sections/windows.

== Videos ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||library://video/
|-
|   || 
|-
|Movies ||videodb://movies/
|-
|MovieGenres ||videodb://movies/genres/
|-
|MovieTitles ||videodb://movies/titles/
|-
|MovieYears ||videodb://movies/years/
|-
|MovieActors ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://movies/directors/
|-
|MovieStudios ||videodb://movies/studios/
|-
|MovieSets ||videodb://movies/sets/
|-
|MovieCountries ||videodb://movies/countries/
|-
|MovieTags ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://recentlyaddedmovies/
|-
|   || 
|-
|TvShows ||videodb://tvshows/
|-
|TvShowGenres ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://recentlyaddedepisodes/
|-
|InProgressTvShows ||videodb://inprogresstvshows
|-
|   || 
|-
|MusicVideos ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://recentlyaddedmusicvideos/
|-
|   || 
|-
|Playlists ||special://videoplaylists/
|-
|Current Playlist ||playlistvideo://
|-
|Video Add-ons ||addons://sources/video/
|-
|Files ||sources://video/
|-
|}

== Music ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||library://music/
|-
|   || 
|-
|Genres ||musicdb://genres/
|-
|Artists ||musicdb://artists/
|-
|Albums ||musicdb://albums/
|-
|Song ||musicdb://songs/
|-
|Top100 ||musicdb://top100/
|-
|Top100Songs ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://compilations/
|-
|Years ||musicdb://years/
|-
|Singles ||musicdb://singles/
|-
|   || 
|-
|Files ||sources://music/
|-
|Playlists ||special://musicplaylists/
|-
|Current Playlist ||playlistmusic://
|-
|Music Add-ons ||addons://sources/audio/
|}

== Programs ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Addons ||addons://sources/executable/
|-
|AndroidApps ||androidapp://sources/apps/
|}

== AddonBrowser ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|My add-ons ||addons://user/<type>/ (see for available types https://github.com/xbmc/xbmc/blob/master/xbmc/addons/Addon.cpp#L73)
|-
|Update available ||addons://outdated/
|-
|Currently downloading add-ons ||addons://downloading/
|-
|Recently updated ||addons://recently_updated/
|-
|Install from repository ||addons://repos/
|-
|Install from zip ||addons://install/
|-
|Search ||addons://search/
|-
|Running ||addons://running/
|}

== PVR ==
There are different PVR windows, one for every PVR content type (channels, recordings, timers, timer rules, search) not a single PVR window with sub sections denoting the different content types.

Currently, most PVR windows cannot be activated using user supplied paths. Support for more windows may be added in the future.

Example: <pre>ActivateWindow(TVRecordings,pvr://recordings/tv/active/FooDirectory/)</pre> will open the TV recordings window prepoulated with the recordings contained in directory FooDirectory.

{| class="prettytable"
! Window Name !! Path !! Notes !! Kodi version
|-
|TVChannels || pvr://channels/tv/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific tv channel group || Kodi 19
|-
|TVGuide || pvr://channels/tv/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific tv channel group || Kodi 19
|-
|TVRecordings ||pvr://recordings/tv/active/<DIRECTORY>/ || Replace <DIRECTORY> with the name of the recording directory to display
|-
|TVTimers || || ||
|-
|TVTimerRules || || ||
|-
|TVSearch || || ||
|-
|RadioChannels || pvr://channels/radio/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific radio channel group || Kodi 19
|-
|RadioGuide || pvr://channels/radio/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific radio channel group || Kodi 19
|-
|RadioRecordings ||pvr://recordings/radio/active/<DIRECTORY>/ ||Replace <DIRECTORY> with the name of the recording directory to display
|-
|RadioTimers || || ||
|-
|RadioTimerRules || || ||
|-
|RadioSearch || || ||
|}

== Notes ==
<references />

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

InfoLabels

2025-10-13T13:39:48Z

Hitcher: /* ListItem */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca**
:*dolbydigital
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp2
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
:
: ** note: dca replaced dts in 2011
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Cast(separator)</code>
| '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.Director(separator)</code>
| '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.Genre(separator)</code>
| '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Writer(separator)</code>
| '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Genre(separator)</code>
| '''Returns'''
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre(separator)</code>
| '''Returns'''
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director(separator)</code>
| '''Returns'''
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.Cast(separator)</code>
| '''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer(separator)</code>
| '''Returns'''
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

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

Image Control

2025-07-18T15:18:57Z

Hitcher: /* Available tags and attributes */

{{mininav| [[Skinning]] }}
<section begin="main content" />
The image control is used for displaying images in Kodi. You can choose the position, size, transparency and contents of the image to be displayed.

=== Example ===
<syntaxhighlight lang="xml" enclose="div">
<control type="image" id="1">
<description>My first image control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<fadetime>200</fadetime>
<texture border="5" flipy="true" flipx="false">mytexture.png</texture>
<bordertexture border="5">mybordertexture.png</bordertexture>
<bordersize>5</bordersize>
<texture>$INFO[MusicPlayer.Cover]</texture>
<aspectratio>keep</aspectratio>
<imagefilter>linear</imagefilter>
<diffusefilter>linear</diffusefilter>
</control>
</syntaxhighlight>

=== Image Size and Type Restrictions ===
For the '''<texture>''' tags, and for all '''<texture>''' tags in other controls, there is a small set of rules that you should follow if at all possible:

=== Size ===
Images can be any size, though some graphics cards allow only power of 2 textures, so this may be a consideration. For the most case, it doesn't really matter what size things are - Kodi will quite happily load most files.

=== Formats ===
If you wish to use transparency, then use PNG. It is suggested that you use PNG and JPG as much as possible. Note that once the images are injected into Textures.xbt, they are not stored as JPG or PNG – rather they are stored in a native format used for GPUs for faster loading, such as ARGB or DXTc textures. The size of the images (in kb) is therefore not as important as the size of the images in pixels – so feel free to store them in a lossless (eg PNG) manner if you wish.

The only exception to this is if you require an animated texture. In this case, we support only animated GIF. There are also some animated gifs that may not work. Use ImageReady CS and make sure you set the gif-anim to “restore to background” and they should work fine.

=== Available tags and attributes ===
In addition to the [[Default Control Tags|default control tags]], the following tags are available. Note that each tag is '''lower case only.''' This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''aspectratio'''
| This specifies how the image will be drawn inside the box defined by <code><width></code> and <code><height></code>. [[Aspect Ratio|See here for more information]].
|-
| '''texture'''
| Specifies the image file which should be displayed. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''bordertexture'''
| Specifies the image file which should be displayed as a border around the image. Use the <code><bordersize></code> to specify the size of the border. The <code><width></code>,<code><height></code> box specifies the size of the image plus border. Set the argument <code>infill="false"</code> to hint to the GUI that the inner portion of the border doesn't have to be rendered.
|-
| '''bordersize'''
| Specifies the size of the border. A single number specifies the border should be the same size all the way around the image, whereas a comma separated list of 4 values indicates left,top,right,bottom values.
|-
| '''info'''
| Specifies the information that this image control is presenting. Kodi will select the texture to use based on this tag. [[InfoLabels|See here for more information.]]
|-
| '''fadetime'''
| This specifies a crossfade time that will be used whenever the underlying '''<texture>''' filename changes. The previous image will be held until the new image is ready, and then they will be crossfaded. This is particularly useful for a large thumbnail image showing the focused item in a list, or for fanart or other large backdrops.
|-
| '''background'''
| For images inside a container, you can specify background="true" to load the textures in a background worker thread.
|-
| '''imagefilter'''
| This can take two values: '''linear''' or '''nearest'''. Linear scaling is the default, and smoothly blurs between pixels. Nearest neighbor scaling will apply a pixelated effect to the image.
|-
| '''diffusefilter'''
| Equivalent of '''imagefilter''' for the diffuse texture.
|}

For the tags "texture" and "bordertexture", the following attributes are available.

{| class="prettytable"
! Tag !! Description
|-
| '''border'''
| Used to specify a region of the texture to be considered a border that should not be scaled when the texture is scaled to fit a control's dimensions. The portion in the border region will remain unscaled. Particularly useful to achieve rounded corners that do not change size when a control is resized. Note that zoom animations and GUI rescaling will still affect the border region - it is just the scaling of the texture to the control size which is unaffected. Using border="5" will give a 5 pixel border all around the texture. You can specify each of the border amounts on each edge individually using border="left,top,right,bottom".
|-
| '''infill'''
| Available if the "border" attribute is used. Hint for the GUI drawing routine if the center portion or just the outer frame should be drawn. Useful if the texture center is fully transparent. Accepts boolean values "true" (default) and "false".
|-
| '''flipx'''
| Specifies that the texture should be flipped in the horizontal direction, useful for reflections.
|-
| '''flipy'''
| Specifies that the texture should be flipped in the vertical direction, useful for reflections.
|-
| '''background'''
| Used on the '''<imagepath>''' tag. When set to "true", this forces the image to be loaded via the large texture manager (except for textures located in Textures.xbt).
|-
| '''diffuse'''
| Specifies a diffuse texture which is "modulated" or multiplied with the texture in order to give specific effects, such as making the image gain transparency, or tint it in various ways. As it's applied per-pixel many effects are possible, the most popular being by a transparent reflection which slowly gets more and more opaque. This is achieved using a WHITE image where the transparency increases as you move down the texture.
|-
| '''colordiffuse'''
| This specifies the color to be used for the texture basis. It's is specified in hexadecimal notation using the AARRGGBB format. If you define '''<texture colordiffuse="FFFFAAFF">texture.png</texture>''' (magenta), the image will be given a magenta tint when rendered. You can also specify this as a name from the colour theme, or you can also use $VAR and $INFO for dynamic values.
|}

=== Texture Loading ===
==== Normal texture loading ====
The only textures loaded by Kodi are the ones currently visible. Nothing displays on the screen until all the images have been loaded in memory, this can result in "jerky" scrolling through panel containers. As you scroll down, Kodi will delay the scrolling animation until all of the images in the next row are loaded.

==== Background loading ====
Images are loaded one at a time in a background worker thread and are shown as soon as xbmc processes them. Has the benefit that images can be loaded into memory before they're visible, resulting in smoother scrolling and transitions.

==== Preloading ====
Used to automatically load the next items (or rows/columns in the case of a panel) while scrolling. Currently limited to 2.

<section end="main content" />

[[Category:Skin development]]

Image Control

2025-07-18T15:14:55Z

Hitcher: /* Available tags and attributes */

Image Control

2025-07-18T15:12:22Z

Hitcher: /* Image Size and Type Restrictions */

Image Control

2025-07-18T15:11:58Z

Hitcher: /* Example */

List of boolean conditions

2025-06-22T10:08:05Z

Hitcher: /* Player */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use boolean conditions with the '''<visible>''' tag or with condition attributes. Scripts can read boolean conditions with <code>'''xbmc.getCondVisibility'''(condition)</code>.

=== Global ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
|-
| <code>true</code>
| Returns
:Always evaluates to '''true'''.
|-
| <code>false</code>
| Returns
:Always evaluates to '''false'''.
|-
| <code>yes</code>
| Returns
:same as '''true'''.
|-
| <code>no</code>
| Returns
:same as '''false'''.
|}

=== Addon ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingBool(addon_id,setting_id)</code>
| '''Returns'''
:'''True''' if the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code> is '''True''', '''False''' otherwise.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>The provided setting with <code>setting_id</code> must be a boolean setting type.<br>
Otherwise it will return the boolean info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{| class="wikitable sortable"" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Container.CanFilter</code>
| '''Returns'''
:'''True''' when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| '''Returns'''
:'''True''' when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Content(parameter)</code>
| '''Returns'''
:'''True''' if the current container you are in contains the following:
:*actors
:*addons
:*albums
:*artists
:*directors
:*episodes
:*files
:*genres
:*livetv
:*movies
:*musicvideos
:*playlists
:*plugins
:*seasons
:*sets
:*songs
:*studios
:*tags
:*tvshows
:*years
{{highlight|'''Note'''<br>
These currently only work in the Video and Music Library, unless a Plugin has set the value.}}
|
|-
| <code>Container.Filtered</code>
| '''Returns'''
:'''True''' when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasFiles</code>
| '''Returns'''
:'''True''' if the container contains files.
|
|-
| <code>Container.HasFolders</code>
| '''Returns'''
:'''True''' if the container contains folders.
|
|-
| <code>Container.HasThumb</code>
| '''Returns'''
:'''True''' if the current container you are in has a thumb assigned to it.
|
|-
| <code>Container.IsStacked</code>
| '''Returns'''
:'''True''' if the container is currently in stacked mode.
|
|-
| <code>Container.SortDirection(ascending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is descending.
|
|-
| <code>Container.Sortmethod(sortid)</code>
| '''Returns'''
:'''True''' if the current sort method matches the specified SortID [[https://kodi.wiki/view/List_of_built-in_functions#List_of_sort_methods see list of sort methods]].
|
|-
| <code>Container(id).Column(column_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the column given.
'''Parameters'''
:'''column_number''' - The column number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| '''Returns'''
:'''True''' if the container with id has static content and is focused on the item with id item_number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasNext</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a next page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasParent</code>
| '''Returns'''
:'''True''' when the container with id contains a parent ('..') item.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasPrevious</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a previous page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).IsUpdating</code>
| '''Returns'''
:'''True''' if the container with dynamic list content is currently updating.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnNext</code>
| '''Returns'''
:'''True''' if the container with id is moving to the next item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnPrevious</code>
| '''Returns'''
:'''True''' if the container with id is moving to the previous item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollNext</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the next item.
:Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollPrevious</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the previous item.
:Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Position(position_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the position given.
'''Parameters'''
:'''position_number''' - The position number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Row(row_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the row given.
'''Parameters'''
:'''row_number''' - The row number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Scrolling</code>
| '''Returns'''
:'''True''' if the user is currently scrolling through the container with id.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.<br>
This is slightly delayed from the actual scroll start.<br>
Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.}}
|
|-
| <code>Container(id).SubItem</code>
| '''Returns'''
:'''True''' if the container with id is focused on the specified subitem.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Control.HasFocus(id)</code>
| '''Returns'''
:'''True''' if the currently focused control has id "id".<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsEnabled(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is enabled.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsVisible(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is visible.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| '''Returns'''
:'''True''' if the control group with id “group” has control id “id” as its focused item.<br>
'''Parameters'''
:'''group''' - The id of the group.
:'''id''' - The id of the focused item.
{{highlight|'''Note'''<br>
If “id” is not present, or is 0, then it will return true if the currently focused control is in the control group with id “group”.<br>
If the control group with id “group” does not have focus, then this will still return true if the last focused item in the group had control id “id”.<br>
'''WARNING'''<br>
Avoid using IDs 9000-9999 as this is the range assigned to groups with no ID value.}}
|
|}

=== Integer ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| v19
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| v19
|}

=== Library ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets, BoxSets)
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|-
| <code>Library.HasContent(Role,Composer)</code>
| Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library
| v17
|-
| <code>Library.HasNode(path)</code>
| Returns True if the specified node is available (example: Library.HasNode(library://video/movies/titles.xml))
| v19
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>ListItem.HasVideoVersions</code>
| Returns true if the ListItem has video versions
|
|-
| <code>ListItem.HasVideoExtras</code>
| Returns true if the ListItem has video extras
|
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasArchive</code>
| Returns True when the selected channel has a server-side back buffer (PVR)
| v19
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| Returns True if the item has a reminder set (PVR)
| v19
|-
| <code>ListItem.HasReminderRule</code>
| Returns True if the item was scheduled by a reminder timer rule (PVR)
| v19
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(Stream.Is3D)</code>
| Returns true if the video stream is a 3D (stereoscopic) video, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsDefault)</code>
| Returns true if the audio/video/subtitle stream is default, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsExternal)</code>
| Returns true if the subtitle stream is external, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsForced)</code>
| Returns true if the audio/subtitle stream is forced, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsHearingImpaired)</code>
| Returns true if the subtitle stream is for the hearing impaired (aka SDH-Subtitles for the Deaf or Hard-of-Hearing/CC-Closed Captions), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsOriginal)</code>
| Returns true if the audio/subtitle stream is in the original language, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsVisualImpaired)</code>
| Returns true if the audio stream is for the visually impaired (aka AD-Audio Description), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(Addon.IsEnabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsInstalled)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.HasUpdate)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17
|-
| <code>ListItem.TimerIsActive</code>
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
| v17
|-
| <code>ListItem.Property(Addon.Orphaned)</code>
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)
| v17
|-
| <code>ListItem.IsParentFolder</code>
| Returns true is the slected item is the 'up' item
| v17
|-
| <code>ListItem.IsNew</code>
| Returns true if the item is a premiere (for example, a Live TV show that will be first aired) (PVR)
| v19
|-
| <code>ListItem.IsPlayable</code>
| Returns True when the selected programme can be played (PVR)
| v19
|-
| <code>ListItem.IsBoxset</code>
| Returns True if the item is part of a boxset album
| v19
|-
| <code>ListItem.IsPremiere</code>
| Returns true if the item is a premiere (for example, a Movie first showing or season first on Live TV)
| v19
|-
| <code>ListItem.IsFinale</code>
| Returns true if the item is a finale (for example, a season finale showing on Live TV)
| v19
|-
| <code>ListItem.IsLive</code>
| Returns true if the item is live (for example, a Live TV sports event)
| v19
|-
| <code>ListItem.Property(Addon.IsFromOfficialRepo)</code>
| Returns true if the addon is from an official repository
| v19
|-
| <code>ListItem.Property(Addon.IsBinary)</code>
| Returns true for binary addons
| v19
|-
| <code>ListItem.Property(Addon.IsUpdate)</code>
| Returns True if this add-on is a valid update of an installed outdated add-on
| v19
|-
| <code>ListItem.IsAutoUpdateable</code>
| Returns True if this add-on can be updated automatically
| v19
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.IsDHCP</code>
| '''Returns'''
:'''True''' if the network type is DHCP.
{{highlight|'''Note'''<br>
Network type can be either DHCP or FIXED.}}
|
|}

=== Player ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.IsLive</code>
| Returns if the inputstream of the player is a live stream (a.k.a. real time stream).
| v22
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17
|-
| <code>Player.TempoEnabled</code>
| Returns true if the current player supports changing the playback speed
| v17
|-
| <code>Player.IsTempo</code>
| Returns true if the current playbackspeed is not equal to 1
| v17
|-
| <code>Player.HasGame</code>
| Returns true if the player is playing a game
| v18
|-
| <code>Player.HasResolutions</code>
| Returns true when multiple resolutions are available
| v18
|-
| <code>Player.FrameAdvance</code>
| Returns true if player is in frame advance mode
| v18
|-
| <code>Player.ChannelPreviewActive</code>
| Returns true if PVR channel preview is active (used channel tag different from played tag)
|
|}

==== MusicPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>MusicPlayer.IsMultiDisc</code>
| Returns true if the current album consists of two or more discs
| v19
|}

==== VideoPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.HasVideoVersions</code>
| Returns true if the currently playing video has versions.
| v21
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows, etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (e.g. director, plot, etc).
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== PlayList ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| v17
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| v17
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| v17
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| v17
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| v17
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| v17
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| v17
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| v18
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| v18
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>RDS.HasRds</code>
| Returns true if RDS is present
|
|-
| <code>RDS.HasRadioText</code>
| Returns true if RDS contains also Radiotext
|
|-
| <code>RDS.HasRadioTextPlus</code>
| Returns true if RDS with Radiotext contains also the plus information
|
|-
| <code>RDS.HasHotline</code>
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)
|
|-
| <code>RDS.HasStudio</code>
| Returns true if a studio name is present (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|}

=== String ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|}

=== System ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>System.AddonIsEnabled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasPVRAddon</code>
| Returns true if at least one PVR addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.InternetState</code>
| Returns true if the system is connected to the internet, returns false in case no internet connection is available.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles| profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles| profile]] login screen is enabled
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, e.g. when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| v18
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>System.HasCMS</code>
| Returns true if colour management is supported in Kodi.
| v17
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|-
| <code>System.SupportsCPUUsage</code>
| Return True if the system provides CPU info
| v19
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (e.g. in Milkdrop.)
|
|}

=== Weather ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Is(name)</code>
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible
| v17
|}
<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]
* [[Conditional visibility]]

{{top}}

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

List of boolean conditions

2025-06-22T10:07:19Z

Hitcher: /* Player */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use boolean conditions with the '''<visible>''' tag or with condition attributes. Scripts can read boolean conditions with <code>'''xbmc.getCondVisibility'''(condition)</code>.

=== Global ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
|-
| <code>true</code>
| Returns
:Always evaluates to '''true'''.
|-
| <code>false</code>
| Returns
:Always evaluates to '''false'''.
|-
| <code>yes</code>
| Returns
:same as '''true'''.
|-
| <code>no</code>
| Returns
:same as '''false'''.
|}

=== Addon ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingBool(addon_id,setting_id)</code>
| '''Returns'''
:'''True''' if the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code> is '''True''', '''False''' otherwise.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>The provided setting with <code>setting_id</code> must be a boolean setting type.<br>
Otherwise it will return the boolean info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{| class="wikitable sortable"" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Container.CanFilter</code>
| '''Returns'''
:'''True''' when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| '''Returns'''
:'''True''' when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Content(parameter)</code>
| '''Returns'''
:'''True''' if the current container you are in contains the following:
:*actors
:*addons
:*albums
:*artists
:*directors
:*episodes
:*files
:*genres
:*livetv
:*movies
:*musicvideos
:*playlists
:*plugins
:*seasons
:*sets
:*songs
:*studios
:*tags
:*tvshows
:*years
{{highlight|'''Note'''<br>
These currently only work in the Video and Music Library, unless a Plugin has set the value.}}
|
|-
| <code>Container.Filtered</code>
| '''Returns'''
:'''True''' when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasFiles</code>
| '''Returns'''
:'''True''' if the container contains files.
|
|-
| <code>Container.HasFolders</code>
| '''Returns'''
:'''True''' if the container contains folders.
|
|-
| <code>Container.HasThumb</code>
| '''Returns'''
:'''True''' if the current container you are in has a thumb assigned to it.
|
|-
| <code>Container.IsStacked</code>
| '''Returns'''
:'''True''' if the container is currently in stacked mode.
|
|-
| <code>Container.SortDirection(ascending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is descending.
|
|-
| <code>Container.Sortmethod(sortid)</code>
| '''Returns'''
:'''True''' if the current sort method matches the specified SortID [[https://kodi.wiki/view/List_of_built-in_functions#List_of_sort_methods see list of sort methods]].
|
|-
| <code>Container(id).Column(column_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the column given.
'''Parameters'''
:'''column_number''' - The column number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| '''Returns'''
:'''True''' if the container with id has static content and is focused on the item with id item_number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasNext</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a next page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasParent</code>
| '''Returns'''
:'''True''' when the container with id contains a parent ('..') item.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasPrevious</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a previous page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).IsUpdating</code>
| '''Returns'''
:'''True''' if the container with dynamic list content is currently updating.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnNext</code>
| '''Returns'''
:'''True''' if the container with id is moving to the next item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnPrevious</code>
| '''Returns'''
:'''True''' if the container with id is moving to the previous item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollNext</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the next item.
:Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollPrevious</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the previous item.
:Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Position(position_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the position given.
'''Parameters'''
:'''position_number''' - The position number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Row(row_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the row given.
'''Parameters'''
:'''row_number''' - The row number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Scrolling</code>
| '''Returns'''
:'''True''' if the user is currently scrolling through the container with id.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.<br>
This is slightly delayed from the actual scroll start.<br>
Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.}}
|
|-
| <code>Container(id).SubItem</code>
| '''Returns'''
:'''True''' if the container with id is focused on the specified subitem.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Control.HasFocus(id)</code>
| '''Returns'''
:'''True''' if the currently focused control has id "id".<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsEnabled(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is enabled.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsVisible(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is visible.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| '''Returns'''
:'''True''' if the control group with id “group” has control id “id” as its focused item.<br>
'''Parameters'''
:'''group''' - The id of the group.
:'''id''' - The id of the focused item.
{{highlight|'''Note'''<br>
If “id” is not present, or is 0, then it will return true if the currently focused control is in the control group with id “group”.<br>
If the control group with id “group” does not have focus, then this will still return true if the last focused item in the group had control id “id”.<br>
'''WARNING'''<br>
Avoid using IDs 9000-9999 as this is the range assigned to groups with no ID value.}}
|
|}

=== Integer ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| v19
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| v19
|}

=== Library ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets, BoxSets)
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|-
| <code>Library.HasContent(Role,Composer)</code>
| Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library
| v17
|-
| <code>Library.HasNode(path)</code>
| Returns True if the specified node is available (example: Library.HasNode(library://video/movies/titles.xml))
| v19
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>ListItem.HasVideoVersions</code>
| Returns true if the ListItem has video versions
|
|-
| <code>ListItem.HasVideoExtras</code>
| Returns true if the ListItem has video extras
|
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasArchive</code>
| Returns True when the selected channel has a server-side back buffer (PVR)
| v19
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| Returns True if the item has a reminder set (PVR)
| v19
|-
| <code>ListItem.HasReminderRule</code>
| Returns True if the item was scheduled by a reminder timer rule (PVR)
| v19
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(Stream.Is3D)</code>
| Returns true if the video stream is a 3D (stereoscopic) video, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsDefault)</code>
| Returns true if the audio/video/subtitle stream is default, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsExternal)</code>
| Returns true if the subtitle stream is external, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsForced)</code>
| Returns true if the audio/subtitle stream is forced, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsHearingImpaired)</code>
| Returns true if the subtitle stream is for the hearing impaired (aka SDH-Subtitles for the Deaf or Hard-of-Hearing/CC-Closed Captions), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsOriginal)</code>
| Returns true if the audio/subtitle stream is in the original language, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsVisualImpaired)</code>
| Returns true if the audio stream is for the visually impaired (aka AD-Audio Description), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(Addon.IsEnabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsInstalled)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.HasUpdate)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17
|-
| <code>ListItem.TimerIsActive</code>
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
| v17
|-
| <code>ListItem.Property(Addon.Orphaned)</code>
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)
| v17
|-
| <code>ListItem.IsParentFolder</code>
| Returns true is the slected item is the 'up' item
| v17
|-
| <code>ListItem.IsNew</code>
| Returns true if the item is a premiere (for example, a Live TV show that will be first aired) (PVR)
| v19
|-
| <code>ListItem.IsPlayable</code>
| Returns True when the selected programme can be played (PVR)
| v19
|-
| <code>ListItem.IsBoxset</code>
| Returns True if the item is part of a boxset album
| v19
|-
| <code>ListItem.IsPremiere</code>
| Returns true if the item is a premiere (for example, a Movie first showing or season first on Live TV)
| v19
|-
| <code>ListItem.IsFinale</code>
| Returns true if the item is a finale (for example, a season finale showing on Live TV)
| v19
|-
| <code>ListItem.IsLive</code>
| Returns true if the item is live (for example, a Live TV sports event)
| v19
|-
| <code>ListItem.Property(Addon.IsFromOfficialRepo)</code>
| Returns true if the addon is from an official repository
| v19
|-
| <code>ListItem.Property(Addon.IsBinary)</code>
| Returns true for binary addons
| v19
|-
| <code>ListItem.Property(Addon.IsUpdate)</code>
| Returns True if this add-on is a valid update of an installed outdated add-on
| v19
|-
| <code>ListItem.IsAutoUpdateable</code>
| Returns True if this add-on can be updated automatically
| v19
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.IsDHCP</code>
| '''Returns'''
:'''True''' if the network type is DHCP.
{{highlight|'''Note'''<br>
Network type can be either DHCP or FIXED.}}
|
|}

=== Player ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.IsLive</code>
| Returns if the inputstream of the player is a live stream (a.k.a. real time stream), False otherwise.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17
|-
| <code>Player.TempoEnabled</code>
| Returns true if the current player supports changing the playback speed
| v17
|-
| <code>Player.IsTempo</code>
| Returns true if the current playbackspeed is not equal to 1
| v17
|-
| <code>Player.HasGame</code>
| Returns true if the player is playing a game
| v18
|-
| <code>Player.HasResolutions</code>
| Returns true when multiple resolutions are available
| v18
|-
| <code>Player.FrameAdvance</code>
| Returns true if player is in frame advance mode
| v18
|-
| <code>Player.ChannelPreviewActive</code>
| Returns true if PVR channel preview is active (used channel tag different from played tag)
|
|}

==== MusicPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>MusicPlayer.IsMultiDisc</code>
| Returns true if the current album consists of two or more discs
| v19
|}

==== VideoPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.HasVideoVersions</code>
| Returns true if the currently playing video has versions.
| v21
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows, etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (e.g. director, plot, etc).
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== PlayList ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| v17
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| v17
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| v17
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| v17
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| v17
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| v17
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| v17
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| v18
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| v18
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>RDS.HasRds</code>
| Returns true if RDS is present
|
|-
| <code>RDS.HasRadioText</code>
| Returns true if RDS contains also Radiotext
|
|-
| <code>RDS.HasRadioTextPlus</code>
| Returns true if RDS with Radiotext contains also the plus information
|
|-
| <code>RDS.HasHotline</code>
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)
|
|-
| <code>RDS.HasStudio</code>
| Returns true if a studio name is present (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|}

=== String ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|}

=== System ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>System.AddonIsEnabled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasPVRAddon</code>
| Returns true if at least one PVR addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.InternetState</code>
| Returns true if the system is connected to the internet, returns false in case no internet connection is available.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles| profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles| profile]] login screen is enabled
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, e.g. when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| v18
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>System.HasCMS</code>
| Returns true if colour management is supported in Kodi.
| v17
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|-
| <code>System.SupportsCPUUsage</code>
| Return True if the system provides CPU info
| v19
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (e.g. in Milkdrop.)
|
|}

=== Weather ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Is(name)</code>
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible
| v17
|}
<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]
* [[Conditional visibility]]

{{top}}

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

List of boolean conditions

2025-06-22T10:05:22Z

Hitcher: /* Network */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use boolean conditions with the '''<visible>''' tag or with condition attributes. Scripts can read boolean conditions with <code>'''xbmc.getCondVisibility'''(condition)</code>.

=== Global ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
|-
| <code>true</code>
| Returns
:Always evaluates to '''true'''.
|-
| <code>false</code>
| Returns
:Always evaluates to '''false'''.
|-
| <code>yes</code>
| Returns
:same as '''true'''.
|-
| <code>no</code>
| Returns
:same as '''false'''.
|}

=== Addon ===

{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingBool(addon_id,setting_id)</code>
| '''Returns'''
:'''True''' if the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code> is '''True''', '''False''' otherwise.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>The provided setting with <code>setting_id</code> must be a boolean setting type.<br>
Otherwise it will return the boolean info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{| class="wikitable sortable"" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Container.CanFilter</code>
| '''Returns'''
:'''True''' when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| '''Returns'''
:'''True''' when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Content(parameter)</code>
| '''Returns'''
:'''True''' if the current container you are in contains the following:
:*actors
:*addons
:*albums
:*artists
:*directors
:*episodes
:*files
:*genres
:*livetv
:*movies
:*musicvideos
:*playlists
:*plugins
:*seasons
:*sets
:*songs
:*studios
:*tags
:*tvshows
:*years
{{highlight|'''Note'''<br>
These currently only work in the Video and Music Library, unless a Plugin has set the value.}}
|
|-
| <code>Container.Filtered</code>
| '''Returns'''
:'''True''' when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasFiles</code>
| '''Returns'''
:'''True''' if the container contains files.
|
|-
| <code>Container.HasFolders</code>
| '''Returns'''
:'''True''' if the container contains folders.
|
|-
| <code>Container.HasThumb</code>
| '''Returns'''
:'''True''' if the current container you are in has a thumb assigned to it.
|
|-
| <code>Container.IsStacked</code>
| '''Returns'''
:'''True''' if the container is currently in stacked mode.
|
|-
| <code>Container.SortDirection(ascending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| '''Returns'''
:'''True''' if the sort direction of a container is descending.
|
|-
| <code>Container.Sortmethod(sortid)</code>
| '''Returns'''
:'''True''' if the current sort method matches the specified SortID [[https://kodi.wiki/view/List_of_built-in_functions#List_of_sort_methods see list of sort methods]].
|
|-
| <code>Container(id).Column(column_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the column given.
'''Parameters'''
:'''column_number''' - The column number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| '''Returns'''
:'''True''' if the container with id has static content and is focused on the item with id item_number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasNext</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a next page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasParent</code>
| '''Returns'''
:'''True''' when the container with id contains a parent ('..') item.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).HasPrevious</code>
| '''Returns'''
:'''True''' if the container or textbox with id has a previous page.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).IsUpdating</code>
| '''Returns'''
:'''True''' if the container with dynamic list content is currently updating.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnNext</code>
| '''Returns'''
:'''True''' if the container with id is moving to the next item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnPrevious</code>
| '''Returns'''
:'''True''' if the container with id is moving to the previous item.
:Allows views to be custom-designed, such as 3D cover views, etc.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollNext</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the next item.
:Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).OnScrollPrevious</code>
| '''Returns'''
:'''True''' if the container with id is scrolling to the previous item.
:Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Position(position_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the position given.
'''Parameters'''
:'''position_number''' - The position number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Row(row_number)</code>
| '''Returns'''
:'''True''' if the container with id is focused on the row given.
'''Parameters'''
:'''row_number''' - The row number.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|-
| <code>Container(id).Scrolling</code>
| '''Returns'''
:'''True''' if the user is currently scrolling through the container with id.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.<br>
This is slightly delayed from the actual scroll start.<br>
Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.}}
|
|-
| <code>Container(id).SubItem</code>
| '''Returns'''
:'''True''' if the container with id is focused on the specified subitem.
{{highlight|'''Note'''<br>
If no id is specified it grabs the current container.}}
|
|}

=== Control ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Control.HasFocus(id)</code>
| '''Returns'''
:'''True''' if the currently focused control has id "id".<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsEnabled(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is enabled.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>Control.IsVisible(id)</code>
| '''Returns'''
:'''True''' if the control with id "id" is visible.<br>
'''Parameters'''
:'''id''' - The id of the control.
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| '''Returns'''
:'''True''' if the control group with id “group” has control id “id” as its focused item.<br>
'''Parameters'''
:'''group''' - The id of the group.
:'''id''' - The id of the focused item.
{{highlight|'''Note'''<br>
If “id” is not present, or is 0, then it will return true if the currently focused control is in the control group with id “group”.<br>
If the control group with id “group” does not have focus, then this will still return true if the last focused item in the group had control id “id”.<br>
'''WARNING'''<br>
Avoid using IDs 9000-9999 as this is the range assigned to groups with no ID value.}}
|
|}

=== Integer ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| v19
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| v17
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| v19
|}

=== Library ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets, BoxSets)
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|-
| <code>Library.HasContent(Role,Composer)</code>
| Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library
| v17
|-
| <code>Library.HasNode(path)</code>
| Returns True if the specified node is available (example: Library.HasNode(library://video/movies/titles.xml))
| v19
|}

=== ListItem ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>ListItem.HasVideoVersions</code>
| Returns true if the ListItem has video versions
|
|-
| <code>ListItem.HasVideoExtras</code>
| Returns true if the ListItem has video extras
|
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasArchive</code>
| Returns True when the selected channel has a server-side back buffer (PVR)
| v19
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| Returns True if the item has a reminder set (PVR)
| v19
|-
| <code>ListItem.HasReminderRule</code>
| Returns True if the item was scheduled by a reminder timer rule (PVR)
| v19
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(Stream.Is3D)</code>
| Returns true if the video stream is a 3D (stereoscopic) video, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsDefault)</code>
| Returns true if the audio/video/subtitle stream is default, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsExternal)</code>
| Returns true if the subtitle stream is external, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsForced)</code>
| Returns true if the audio/subtitle stream is forced, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsHearingImpaired)</code>
| Returns true if the subtitle stream is for the hearing impaired (aka SDH-Subtitles for the Deaf or Hard-of-Hearing/CC-Closed Captions), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsOriginal)</code>
| Returns true if the audio/subtitle stream is in the original language, for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(Stream.IsVisualImpaired)</code>
| Returns true if the audio stream is for the visually impaired (aka AD-Audio Description), for use in dialogselect.xml
| v22
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(Addon.IsEnabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsInstalled)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.HasUpdate)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17
|-
| <code>ListItem.TimerIsActive</code>
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
| v17
|-
| <code>ListItem.Property(Addon.Orphaned)</code>
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)
| v17
|-
| <code>ListItem.IsParentFolder</code>
| Returns true is the slected item is the 'up' item
| v17
|-
| <code>ListItem.IsNew</code>
| Returns true if the item is a premiere (for example, a Live TV show that will be first aired) (PVR)
| v19
|-
| <code>ListItem.IsPlayable</code>
| Returns True when the selected programme can be played (PVR)
| v19
|-
| <code>ListItem.IsBoxset</code>
| Returns True if the item is part of a boxset album
| v19
|-
| <code>ListItem.IsPremiere</code>
| Returns true if the item is a premiere (for example, a Movie first showing or season first on Live TV)
| v19
|-
| <code>ListItem.IsFinale</code>
| Returns true if the item is a finale (for example, a season finale showing on Live TV)
| v19
|-
| <code>ListItem.IsLive</code>
| Returns true if the item is live (for example, a Live TV sports event)
| v19
|-
| <code>ListItem.Property(Addon.IsFromOfficialRepo)</code>
| Returns true if the addon is from an official repository
| v19
|-
| <code>ListItem.Property(Addon.IsBinary)</code>
| Returns true for binary addons
| v19
|-
| <code>ListItem.Property(Addon.IsUpdate)</code>
| Returns True if this add-on is a valid update of an installed outdated add-on
| v19
|-
| <code>ListItem.IsAutoUpdateable</code>
| Returns True if this add-on can be updated automatically
| v19
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.IsDHCP</code>
| '''Returns'''
:'''True''' if the network type is DHCP.
{{highlight|'''Note'''<br>
Network type can be either DHCP or FIXED.}}
|
|}

=== Player ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17
|-
| <code>Player.TempoEnabled</code>
| Returns true if the current player supports changing the playback speed
| v17
|-
| <code>Player.IsTempo</code>
| Returns true if the current playbackspeed is not equal to 1
| v17
|-
| <code>Player.HasGame</code>
| Returns true if the player is playing a game
| v18
|-
| <code>Player.HasResolutions</code>
| Returns true when multiple resolutions are available
| v18
|-
| <code>Player.FrameAdvance</code>
| Returns true if player is in frame advance mode
| v18
|-
| <code>Player.ChannelPreviewActive</code>
| Returns true if PVR channel preview is active (used channel tag different from played tag)
|
|}

==== MusicPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>MusicPlayer.IsMultiDisc</code>
| Returns true if the current album consists of two or more discs
| v19
|}

==== VideoPlayer ====
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.HasVideoVersions</code>
| Returns true if the currently playing video has versions.
| v21
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows, etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (e.g. director, plot, etc).
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== PlayList ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|}

=== PVR ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| v17
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| v17
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| v17
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| v17
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| v17
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| v17
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| v17
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| v18
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| v18
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>RDS.HasRds</code>
| Returns true if RDS is present
|
|-
| <code>RDS.HasRadioText</code>
| Returns true if RDS contains also Radiotext
|
|-
| <code>RDS.HasRadioTextPlus</code>
| Returns true if RDS with Radiotext contains also the plus information
|
|-
| <code>RDS.HasHotline</code>
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)
|
|-
| <code>RDS.HasStudio</code>
| Returns true if a studio name is present (Only be available on RadiotextPlus)
|
|}

=== Skin ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|}

=== String ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| v17
|}

=== System ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>System.AddonIsEnabled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasPVRAddon</code>
| Returns true if at least one PVR addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.InternetState</code>
| Returns true if the system is connected to the internet, returns false in case no internet connection is available.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles| profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles| profile]] login screen is enabled
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, e.g. when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| v18
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>System.HasCMS</code>
| Returns true if colour management is supported in Kodi.
| v17
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|-
| <code>System.SupportsCPUUsage</code>
| Return True if the system provides CPU info
| v19
|}

=== Visualisation ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (e.g. in Milkdrop.)
|
|}

=== Weather ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|}

=== Window ===
{| class="wikitable sortable" width="100%"
! Labels
! style="80%" | Description
! Version
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs| See here for a list of windows]]
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs| See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Is(name)</code>
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible
| v17
|}
<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]
* [[Conditional visibility]]

{{top}}

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

Controls

2025-06-15T12:50:04Z

Hitcher:

{{cleanup}}
NOTE: The control definitions here can be become out of date. The latest xml behavior can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/guilib/GUIControlFactory.cpp?view=markup the Git cpp code]

== Available controls ==

; [[Button control]] : a standard push button control.
; [[Color Button Control]] : used to select a color.
; [[EPGGrid control]] : used to display the EPG guide in the PVR section.
; [[Edit Control]] : used as an input control for the osd keyboard and other input fields.
; [[Fade label control]] : used to show multiple pieces of text in the same position, by fading from one to the other.
; [[Fixed List Container]] : used for a list of items with a fixed focus. Same as the [[Wrap List Container]] except it doesn't wrap.
; [[Group Control]] : used to group controls together.
; [[Group List Control]] : special case of the group control that forms a scrolling list of controls.
; [[Image Control]] : used to show an image.
; [[Label control]] : used to show some lines of text.
; [[List Container]] : used for a scrolling lists of items. Replaces the list control.
; [[MultiImage Control]] : used to show a slideshow of images.
; [[Panel Container]] : used for a scrolling panel of items. Replaces the thumbnail panel.
; [[Progress Control]] : Used to show the progress of a particular operation.
; [[RSS ticker]] : used to display scrolling RSS feeds.
; [[Radio button control]] : a radio button control (as used for on/off settings).
; [[Scroll Bar Control]] : used for a implementing a scroll bar.
; [[Settings Slider Control]] : used for a slider control in the settings menus.
; [[Settings Spin Control]] : used for cycling up/down controls in the settings menus.
; [[Slider Control]] : used for a volume slider.
; [[Spin Control]] : used for cycling up/down controls.
; [[Text Box]] : used to show a multi-page piece of text.
; [[Toggle button control]] : a toggle on/off button that can take 2 different states.
; [[Video Control]] : used to display the currently playing video whilst in the GUI.
; [[Visualisation Control]] : used to display a visualisation while music is playing.
; [[Wrap List Container]] : used for a wrapping list of items with fixed focus.

== Rarely used controls ==

; [[Mover Control]] : used in the calibration screens.
; [[Resize control]] : used to set the pixel ratio in Video Calibration.

== Depreciated controls ==
These controls are not recommended to be used inside skins
and will be removed from the skinning engine at some point.
Or may not work at all

; Buttonscrollers : used for multiple buttons in a scrollable list.
; Checkmark Control : Used on the XLink Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the check-mark is on the left.
; Console Control : used as a multi-coloured text display (XLink Kai window).
; Extended List Control : used in the XLink Kai window.
; Large Image Control : background loading version of the image control, for larger images.
; List Control : used for lists of items.
; Multiselect control : a piece of text with multiple selectable "button" components.
; Recently Added Media Control : used to display the last few items added to the video database.
; Select button control : a select button control (allows multiple selections from a single button)
; Thumbnail Panel : used to show a panel of thumbnails.

== Built in controls ==

A list of built in controls [[List of Built In Controls|can be found here.]]

== XML tags that affect all control types ==

The XML tags that affect all control types [[Default_control_tags|can be found here.]]

== Filling controls and dictating how they respond from the skin ==

Most of the controls' contents are filled at runtime by the Kodi source codebase, but for controls such as buttons, labels and images, the Skinner has full control over what the button does or what the label and images look like, if they so desire. This is done via the use of conditional <visible> tags, built in <execute> functions, and <info> information tags. See the following links for more information.

; [[Conditional visibility]] : Defining when to display and hide a control, and how to animate the effect.
; [[Animating your skin]] : Breathing life into controls by having defining how they move and respond to actions.
; [[List_of_built-in_functions|Built In Functions]] : Defining what a button or list does when clicked or focused.
; [[InfoLabels|Specifying Labels]] : Defining what a label control or image control's contents should be.

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Color Button Control

2025-06-15T12:44:21Z

Hitcher: Created page with "<section begin="main content" /> The color button control is used for creating push buttons in Kodi with a box for color preview. You can choose the position, size, and look of the button, as well as choosing what action(s) should be performed when pushed. === Example === <syntaxhighlight lang="xml" enclose="div"> <control type="colorbutton" id="2"> <description>My first colorbutton control</description> <posx>80</posx> <posy>60</posy> <width>250<..."

<section begin="main content" />
The color button control is used for creating push buttons in Kodi with a box for color preview. You can choose the position, size, and look of the button, as well as choosing what action(s) should be performed when pushed.
=== Example ===
<syntaxhighlight lang="xml" enclose="div">
<control type="colorbutton" id="2">
<description>My first colorbutton control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<texturecolormask>mycolormask.png</texturecolormask>
<texturecolordisabledmask>mycolormask.png</texturecolordisabledmask>
<colorbox>FF0533ff</colorbox>
<onclick>ActivateWindow(MyVideos)</onclick>
<label>29</label>
<font>font12</font>
<textcolor>FFFFFFFF</textcolor>
<focusedcolor>FFFFFFFF</focusedcolor>
<disabledcolor>80FFFFFF</disabledcolor>
<align>left</align>
<aligny>center</aligny>
<pulseonselect>false</pulseonselect>
<onfocus>-</onfocus>
<onunfocus>-</onunfocus>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
</control>
</syntaxhighlight>
=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''texturefocus'''
| Specifies the image file which should be displayed when the button has focus. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''texturenofocus'''
| Specifies the image file which should be displayed when the button does not have focus.
|-
| '''label'''
| The label used on the button. It can be a link into strings.po, or an actual text label.
|-
| '''font'''
| Font used for the button label. From fonts.xml.
|-
| '''textcolor'''
| Color used for displaying the button label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''focusedcolor'''
| Color used for the button label when the button has in focus. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''disabledcolor'''
| Color used for the button label if the button is disabled. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''invalidcolor'''
| Color used for the button if the user entered some invalid value. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''angle'''
| The angle the text should be rendered at, in degrees. A value of 0 is horizontal.
|-
| '''align'''
| Label horizontal alignment on the button. Defaults to left, can also be center or right.
|-
| '''aligny'''
| Label vertical alignment on the button. Defaults to top, can also be center.
|-
| '''textoffsetx'''
| Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
|-
| '''textoffsety'''
| Amount to offset the label from the top edge of the button when using top alignment.
|-
| '''textwidth'''
| Will truncate any text that's too long.
|-
| '''onclick'''
| Specifies the action to perform when the button is pressed. Should be a built in function. [[Built-in_scripting|See here for more information.]] You may have more than one <onclick> tag, and they'll be executed in sequence.
|-
| '''onfocus'''
| Specifies the action to perform when the button is focused. Should be a built in function. The action is performed after any focus animations have completed. [[Built-in_scripting|See here for more information.]]
|-
| '''onunfocus'''
| Specifies the action to perform when the button loses focus. Should be a built in function.
|-
| '''wrapmultiline'''
| Will wrap the label across multiple lines if the label exceeds the control width.
|-
| '''colorbox'''
| Specifies the color of the preview color box, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''colorposx'''
| X offset of the preview color box.
|-
| '''colorposy'''
| Y offset of the preview color box.
|-
| '''colorwidth'''
| Width in Pixels of the preview color box.
|-
| '''colorheight'''
| Height in Pixels of the preview color box.
|-
| '''texturecolormask'''
| Specifies the image mask which should be displayed to see the color preview. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''texturecolordisabledmask'''
| Specifies the image mask which should be displayed when the control is disabled. [[Texture Attributes|See here for additional information about textures.]]
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Controls

2025-06-15T07:54:56Z

Hitcher: /* Filling controls and dictating how they respond from the skin */

{{cleanup}}
NOTE: The control definitions here can be become out of date. The latest xml behavior can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/guilib/GUIControlFactory.cpp?view=markup the Git cpp code]

== Available controls ==

; [[Group Control]] : used to group controls together.
; [[Group List Control]] : special case of the group control that forms a scrolling list of controls.
; [[Label control]] : used to show some lines of text.
; [[Fade label control]] : used to show multiple pieces of text in the same position, by fading from one to the other.
; [[Image Control]] : used to show an image.
; [[MultiImage Control]] : used to show a slideshow of images.
; [[Button control]] : a standard push button control.
; [[Radio button control]] : a radio button control (as used for on/off settings).
; [[Toggle button control]] : a toggle on/off button that can take 2 different states.
; [[Spin Control]] : used for cycling up/down controls.
; [[Settings Spin Control]] : used for cycling up/down controls in the settings menus.
; [[Slider Control]] : used for a volume slider.
; [[Scroll Bar Control]] : used for a implementing a scroll bar.
; [[Settings Slider Control]] : used for a slider control in the settings menus.
; [[Progress Control]] : Used to show the progress of a particular operation.
; [[List Container]] : used for a scrolling lists of items. Replaces the list control.
; [[Wrap List Container]] : used for a wrapping list of items with fixed focus.
; [[Fixed List Container]] : used for a list of items with a fixed focus. Same as the [[Wrap List Container]] except it doesn't wrap.
; [[Panel Container]] : used for a scrolling panel of items. Replaces the thumbnail panel.
; [[Text Box]] : used to show a multi-page piece of text.
; [[RSS ticker]] : used to display scrolling RSS feeds.
; [[Visualisation Control]] : used to display a visualisation while music is playing.
; [[Video Control]] : used to display the currently playing video whilst in the GUI.
; [[Edit Control]] : used as an input control for the osd keyboard and other input fields.
; [[EPGGrid control]] : used to display the EPG guide in the PVR section.

== Rarely used controls ==

; [[Mover Control]] : used in the calibration screens.
; [[Resize control]] : used to set the pixel ratio in Video Calibration.

== Depreciated controls ==
These controls are not recommended to be used inside skins
and will be removed from the skinning engine at some point.
Or may not work at all

; Buttonscrollers : used for multiple buttons in a scrollable list.
; Checkmark Control : Used on the XLink Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the check-mark is on the left.
; Console Control : used as a multi-coloured text display (XLink Kai window).
; Extended List Control : used in the XLink Kai window.
; Large Image Control : background loading version of the image control, for larger images.
; List Control : used for lists of items.
; Multiselect control : a piece of text with multiple selectable "button" components.
; Recently Added Media Control : used to display the last few items added to the video database.
; Select button control : a select button control (allows multiple selections from a single button)
; Thumbnail Panel : used to show a panel of thumbnails.

== Built in controls ==

A list of built in controls [[List of Built In Controls|can be found here.]]

== XML tags that affect all control types ==

The XML tags that affect all control types [[Default_control_tags|can be found here.]]

== Filling controls and dictating how they respond from the skin ==

Most of the controls' contents are filled at runtime by the Kodi source codebase, but for controls such as buttons, labels and images, the Skinner has full control over what the button does or what the label and images look like, if they so desire. This is done via the use of conditional <visible> tags, built in <execute> functions, and <info> information tags. See the following links for more information.

; [[Conditional visibility]] : Defining when to display and hide a control, and how to animate the effect.
; [[Animating your skin]] : Breathing life into controls by having defining how they move and respond to actions.
; [[List_of_built-in_functions|Built In Functions]] : Defining what a button or list does when clicked or focused.
; [[InfoLabels|Specifying Labels]] : Defining what a label control or image control's contents should be.

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

InfoLabels

2025-04-20T19:44:14Z

Hitcher: /* ListItem */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp2
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Cast(separator)</code>
| '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.Director(separator)</code>
| '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.Genre(separator)</code>
| '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Writer(separator)</code>
| '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Genre(separator)</code>
| '''Returns'''
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre(separator)</code>
| '''Returns'''
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director(separator)</code>
| '''Returns'''
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.Cast(separator)</code>
| '''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer(separator)</code>
| '''Returns'''
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

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

InfoLabels

2025-04-18T10:43:15Z

Hitcher:

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Cast(separator)</code>
| '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.Director(separator)</code>
| '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.Genre(separator)</code>
| '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Writer(separator)</code>
| '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Genre(separator)</code>
| '''Returns'''
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre(separator)</code>
| '''Returns'''
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director(separator)</code>
| '''Returns'''
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.Cast(separator)</code>
| '''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer(separator)</code>
| '''Returns'''
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

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

InfoLabels

2025-04-15T17:40:34Z

Hitcher: /* Video player */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

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

InfoLabels

2025-04-15T15:16:15Z

Hitcher: /* ListItem */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

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

InfoLabels

2025-04-15T07:50:02Z

Hitcher:

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The video codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The stereomode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

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