https://kodi.wiki/api.php?action=feedcontributions&user=Phil65&feedformat=atomOfficial Kodi Wiki - User contributions [en]2024-03-29T06:06:18ZUser contributionsMediaWiki 1.39.6https://kodi.wiki/index.php?title=List_of_built-in_functions&diff=126909List of built-in functions2017-01-03T22:39:51Z<p>Phil65: /* List of functions */</p>
<hr />
<div>{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}<br />
<section begin="main content" /><br />
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>.<br />
<br />
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].<br />
<br />
In addition to the following list, for most <onclick> and <onfocus> button actions in the skin you can also use the functions from [[Keyboard.xml]].<br />
<br />
<poem><br />
'''Example:'''<br />
<onclick>VolumeUp</onclick><br />
<onclick>VolumeDown</onclick><br />
</poem><br />
<br />
'''You can use parameters with all media windows, as can be seen here:'''<br />
* [[Opening Windows and Dialogs]]<br />
<br />
== List of functions ==<br />
<section begin="functions" /><br />
{| class="prettytable sort sortable"<br />
! Function<br />
! Description<br />
! Version<br />
|-<br />
| <code>Action(action[,window])</code><br />
| 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 window names, and their respective ids. <br />
| <br />
|-<br />
| <code>ActivateScreensaver</code><br />
| Starts the screensaver<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>ActivateWindow(window[,dir,return])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code><br />
| 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).<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>Addon.Default.OpenSettings(extensionpoint)</code><br />
| Open a settings dialog for the default addon of the given type (extensionpoint)<br />
| <br />
|-<br />
| <code>Addon.Default.Set(extensionpoint)</code><br />
| Open a select dialog to allow choosing the default addon of the given type (extensionpoint)<br />
| <br />
|-<br />
| <code>Addon.OpenSettings(id)</code><br />
| Open a settings dialog for the addon of the given id <br />
| <br />
|-<br />
| <code>AlarmClock(name,command,time[,silent,loop])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>AllowIdleShutdown</code><br />
| Allow the system to shutdown on idle.<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>CancelAlarm(name[,silent])</code><br />
| Cancel a running alarm. Set silent to true to hide the alarm notification. <br />
| <br />
|-<br />
| <code>CECActivateSource</code><br />
| Wake up playing device via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CECStandby</code><br />
| Put playing device on standby via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CECToggleState</code><br />
| Toggle state of playing device via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CleanLibrary(database)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ClearProperty(key[,id])</code><br />
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id). <br />
| <br />
|-<br />
| <code>Container.NextSortMethod</code><br />
| Change to the next sort method. <br />
| <br />
|-<br />
| <code>Container.NextViewMode</code><br />
| Select the next view mode. <br />
| <br />
|-<br />
| <code>Container.PreviousSortMethod</code><br />
| Change to the previous sort method. <br />
| <br />
|-<br />
| <code>Container.PreviousViewMode</code><br />
| Select the previous view mode. <br />
| <br />
|-<br />
| <code>Container.Refresh</code><br />
| Refresh current listing. <br />
| <br />
|-<br />
| <code>Container.SetSortMethod(id)</code><br />
| Change to the specified sort method. (For list of ID's see List of sort methods below) <br />
| <br />
|-<br />
| <code>Container.SetViewMode(id)</code><br />
| Set the current view mode (list, icons etc.) to the given container id. <br />
| <br />
|-<br />
| <code>Container.SetSortDirection</code><br />
| Toggle the sort direction. <br />
| <br />
|-<br />
| <code>Container.Update</code><br />
| Update current listing. Send Container.Update(path,replace) to reset the path history. <br />
| <br />
|-<br />
| <code>Control.Message(id,message,[windowid])</code><br />
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click. <br />
| <br />
|-<br />
| <code>Control.Move(id,offset)</code><br />
| Will make a Container with the "id" specified in the command move focus by "offset". <br />
| <br />
|-<br />
| <code>Control.SetFocus(id,position)</code><br />
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position) <br />
| <br />
|-<br />
| <code>Dialog.Close(dialog[,force])</code><br />
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once. <br />
| <br />
|-<br />
| <code>EjectTray()</code><br />
| Either opens or closes the DVD tray, depending on its current state <br />
| <br />
|-<br />
| <code>exportlibrary(music,false,filepath)</code><br />
| The music library will be exported to a single file stored at filepath location. <br />
| <br />
|-<br />
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code><br />
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false). <br />
| <br />
|-<br />
| <code>Extract(archive_url[, destination])</code><br />
| Extracts a specified archive to an optionally specified 'absolute' path. <br />
| <br />
|-<br />
| <code>Help</code><br />
| This help message (??? probably broken) <br />
| <br />
|-<br />
| <code>Hibernate</code><br />
| Hibernate (S4) the System <br />
| <br />
|-<br />
| <code>InhibitIdleShutdown(true/false)</code><br />
| Prevent the system to shutdown on idle.<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>InstallAddon(id)</code><br />
| Will install the addon with the given id.<br />
| <br />
|-<br />
| <code>LIRC.Send(command)</code><br />
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup) <br />
| <br />
|-<br />
| <code>LIRC.Start</code><br />
| Adds Kodi as a LIRC client. <br />
| <br />
|-<br />
| <code>LIRC.Stop</code><br />
| Removes Kodi as a LIRC client. <br />
| <br />
|-<br />
| <code>LoadProfile(profilename,[prompt])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Mastermode</code><br />
| Runs Kodi in master mode <br />
| <br />
|-<br />
| <code>Minimize</code><br />
| Minimizes Kodi <br />
| <br />
|-<br />
| <code>Mute</code><br />
| Mutes (or unmutes) the volume. <br />
| <br />
|-<br />
| <code>NextChannelGroup</code><br />
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>NextStereoMode</code><br />
| Changes the stereo mode of the GUI to the next available mode.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>Notification(header,message[,time,image])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>NotifyAll(sender, data [, json])</code><br />
| Notify all connected clients<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PageDown</code><br />
| Send a page down event to the pagecontrol with given id. <br />
| <br />
|-<br />
| <code>PageUp</code><br />
| Send a page up event to the pagecontrol with given id. <br />
| <br />
|-<br />
| <code>PlayDVD</code><br />
| Will play the inserted CD or DVD media from the DVD-ROM drive. <br />
| <br />
|-<br />
| <code>PlayerControl(command)</code><br />
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, TempoUp, TempoDown, Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file), and Record. Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. <br />
| <br />
|-<br />
| <code>Playlist.Clear</code><br />
| Clear the current playlist <br />
| <br />
|-<br />
| <code>Playlist.PlayOffset</code><br />
| Start playing from a particular offset in the playlist <br />
| <br />
|-<br />
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code><br />
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. <br />
| <br />
|-<br />
| <code>PlayWith()</code><br />
| Play the selected item with the specified player core. <br />
| <br />
|-<br />
| <code>Powerdown</code><br />
| Powerdown system <br />
| <br />
|-<br />
| <code>PreviousChannelGroup</code><br />
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PreviousStereoMode</code><br />
| Changes the stereo mode of the GUI to the previous available mode.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PVR.SearchMissingChannelIcons</code><br />
| Will start a search for missing channel icons<br />
| {{nowrap|v16 Addition}}<br />
|-<br />
| <code>Quit</code><br />
| Quits Kodi <br />
| <br />
|-<br />
| <code>Reboot</code><br />
| Cold reboots the system (power cycle) <br />
| <br />
|-<br />
| <code>RecursiveSlideShow(dir)</code><br />
| Run a slideshow from the specified directory, including all subdirs <br />
| <br />
|-<br />
| <code>RefreshRSS</code><br />
| Reload RSS feeds from RSSFeeds.xml <br />
| <br />
|-<br />
| <code>ReloadSkin()</code><br />
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling) <br />
| <br />
|-<br />
| <code>ReplaceWindow(window,dir)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code><br />
| 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).<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>Reset</code><br />
| Reset the system (same as reboot) <br />
| <br />
|-<br />
| <code>Resolution</code><br />
| Change Kodi's Resolution. <br />
| <br />
|-<br />
| <code>RestartApp</code><br />
| Restarts Kodi (only implemented under Windows and Linux) <br />
| <br />
|-<br />
| <code>RipCD</code><br />
| Will rip the inserted CD from the DVD-ROM drive. <br />
| <br />
|-<br />
| <code>RunAddon(id)</code><br />
| Runs the specified plugin/script <br />
| <br />
|-<br />
| <code>RunAppleScript(script[,args]*)</code><br />
| Run the specified AppleScript command <br />
| <br />
|-<br />
| <code>RunPlugin(plugin)</code><br />
| Runs the plugin. Full path must be specified. Does not work for folder plugins <br />
| <br />
|-<br />
| <code>RunScript(script[,args]*)</code><br />
| Runs the python script. You must specify the full path to the script. One way to specify the full path is through the [[Special protocol|special protocol]]. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv <br />
| <br />
|-<br />
| <code>Seek(seconds)</code><br />
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.<br />
| {{nowrap|v15 Addition}}<br />
|-<br />
| <code>SendClick(windowid,id)</code><br />
| Sends a click to a control in a given window (or active window if omitted). <br />
| <br />
|-<br />
| <code>SetFocus(id,position)</code><br />
| Will make a container with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position) <br />
| <br />
|-<br />
| <code>SetGUILanguage</code><br />
| Set GUI Language<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>SetProperty(key,value[,id])</code><br />
| Sets a window property for the current window (key,value), or the specified window (key,value,id). <br />
| <br />
|-<br />
| <code>SetStereoMode</code><br />
| 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)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>settingslevelchange</code><br />
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>SetVolume(percent[,showvolumebar])</code><br />
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume. <br />
| <br />
|-<br />
| <code>ShowPicture(picture)</code><br />
| Show a picture by its file path/url.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>ShutDown</code><br />
| Trigger default Shutdown action defined in System Settings <br />
| <br />
|-<br />
| <code>Skin.Reset(setting)</code><br />
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty. <br />
| <br />
|-<br />
| <code>Skin.ResetSettings</code><br />
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.) <br />
| <br />
|-<br />
| <code>Skin.SelectBool(header, label1&#124;setting1, label2&#124;setting2)</code><br />
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411&#124;RecentWidget, 31412&#124;RandomWidget, 31413&#124;InProgressWidget)<br />
| <br />
|-<br />
| <code>Skin.SetAddon(string,type)</code><br />
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image and xbmc.addon.executable. <br />
| <br />
|-<br />
| <code>Skin.SetBool(setting)</code><br />
| Sets the skin setting ?setting? to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings. <br />
| <br />
|-<br />
| <code>Skin.SetFile(string,mask,folderpath)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetImage(string[,value,path])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetNumeric(numeric[,value])</code><br />
| Pops up a keyboard dialog and allows the user to input a numerical. <br />
| <br />
|-<br />
| <code>Skin.SetPath(string[,folderpath])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetString(string[,value])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.Theme(1)</code><br />
| Cycles the skin theme. Skin.Theme(-1) will go backwards. <br />
| <br />
|-<br />
| <code>Skin.ToggleDebug</code><br />
| Toggles skin debug info on/off <br />
| <br />
|-<br />
| <code>Skin.ToggleSetting(setting)</code><br />
| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting). <br />
| <br />
|-<br />
| <code>SlideShow(dir [,recursive, [not]random])</code><br />
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window. <br />
| <br />
|-<br />
| <code>StartAndroidActivity(package,[intent,dataType,dataURI])</code><br />
| 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><br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>StartPVRManager</code><br />
| (Re)Starts the PVR manager<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>StereoModeToMono</code><br />
| Toggle the stereoscopic mode to 2D.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>StopPVRManager</code><br />
| Stops the PVR manager<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>StopScript(id)</code><br />
| Stop the script by ID or path, if running<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>Suspend</code><br />
| Suspends (S3 / S1 depending on bios setting) the System <br />
| <br />
|-<br />
| <code>System.Exec</code><br />
| Execute shell commands. <br />
| <br />
|-<br />
| <code>System.ExecWait</code><br />
| Execute shell commands and freezes Kodi until shell is closed. <br />
| <br />
|-<br />
| <code>System.LogOff</code><br />
| Log off current user. <br />
| <br />
|-<br />
| <code>TakeScreenshot([filenameandpath,sync])</code><br />
| 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).<br />
| <br />
|-<br />
| <code>ToggleDebug</code><br />
| Enables/disables debug mode<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>ToggleDirtyRegionVisualization</code><br />
| makes dirty regions visible for debugging proposes.<br />
| {{nowrap|v16 Addition}}<br />
|-<br />
| <code>ToggleDPMS</code><br />
| Toggle DPMS mode manually <br />
| <br />
|-<br />
| <code>ToggleStereoMode</code><br />
| Toggle the stereoscopic mode of the GUI (on/off).<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>UnloadSkin()</code><br />
| Unloads the current skin <br />
| <br />
|-<br />
| <code>UpdateAddonRepos</code><br />
| Triggers a forced update of enabled add-on repositories. <br />
| <br />
|-<br />
| <code>UpdateLibrary(database,[path])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>UpdateLocalAddons</code><br />
| Triggers a scan of local add-on directories. <br />
| <br />
|-<br />
| <code>VideoLibrary.Search</code><br />
| Brings up a search dialog which will search the library <br />
| <br />
|-<br />
| <code>WakeOnLan(mac)</code><br />
| 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). <br />
| <br />
|-<br />
| <code>Weather.LocationNext</code><br />
| Switch to next weather location <br />
| <br />
|-<br />
| <code>Weather.LocationPrevious</code><br />
| Switch to previous weather location <br />
| <br />
|-<br />
| <code>Weather.LocationSet</code><br />
| Switch to given weather location (parameter can be 1-3) <br />
| <br />
|-<br />
| <code>Weather.Refresh</code><br />
| Force weather data refresh<br />
| <br />
|}<br />
<section end="functions" /><br />
<section end="main content" /><br />
<br />
== Removed functions ==<br />
* <code>LastFM.Love</code> - Removed in v13 Gotham<br />
* <code>LastFM.Ban</code> - Removed in v13 Gotham<br />
* <code>LCD.Suspend</code> - Removed in v13 Gotham<br />
* <code>LCD.Resume</code> - Removed in v13 Gotham<br />
<br />
== List of sort methods ==<br />
These ID's can be used with the Container.SetSortMethod(id) function as listed [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.cpp#L529-L577 here]:<br />
{| class="prettytable"<br />
! ID<br />
! Description<br />
|-<br />
| <code>1</code><br />
| Name<br />
|-<br />
| <code>2</code><br />
| Date<br />
|-<br />
| <code>3</code><br />
| Size<br />
|-<br />
| <code>4</code><br />
| File<br />
|-<br />
| <code>5</code><br />
| Path<br />
|-<br />
| <code>6</code><br />
| DriveType<br />
|-<br />
| <code>7</code><br />
| Title<br />
|-<br />
| <code>8</code><br />
| TrackNumber<br />
|-<br />
| <code>9</code><br />
| Time<br />
|-<br />
| <code>10</code><br />
| Artist<br />
|-<br />
| <code>11</code><br />
| Album<br />
|-<br />
| <code>12</code><br />
| AlbumType<br />
|-<br />
| <code>13</code><br />
| Genre<br />
|-<br />
| <code>14</code><br />
| Country<br />
|-<br />
| <code>15</code><br />
| Year<br />
|-<br />
| <code>16</code><br />
| Rating<br />
|-<br />
| <code>17</code><br />
| Votes<br />
|-<br />
| <code>18</code><br />
| Top250<br />
|-<br />
| <code>19</code><br />
| ProgramCount<br />
|-<br />
| <code>20</code><br />
| PlaylistOrder<br />
|-<br />
| <code>21</code><br />
| EpisodeNumber<br />
|-<br />
| <code>22</code><br />
| Season<br />
|-<br />
| <code>23</code><br />
| NumberOfEpisodes<br />
|-<br />
| <code>24</code><br />
| NumberOfWatchedEpisodes<br />
|-<br />
| <code>25</code><br />
| TvShowStatus<br />
|-<br />
| <code>26</code><br />
| TvShowTitle<br />
|-<br />
| <code>27</code><br />
| SortTitle<br />
|-<br />
| <code>28</code><br />
| ProductionCode<br />
|-<br />
| <code>29</code><br />
| MPAA<br />
|-<br />
| <code>30</code><br />
| VideoResolution<br />
|-<br />
| <code>31</code><br />
| VideoCodec<br />
|-<br />
| <code>32</code><br />
| VideoAspectRatio<br />
|-<br />
| <code>33</code><br />
| AudioChannels<br />
|-<br />
| <code>34</code><br />
| AudioCodec<br />
|-<br />
| <code>35</code><br />
| AudioLanguage<br />
|-<br />
| <code>36</code><br />
| SubtitleLanguage<br />
|-<br />
| <code>37</code><br />
| Studio<br />
|-<br />
| <code>38</code><br />
| DateAdded<br />
|-<br />
| <code>39</code><br />
| LastPlayed<br />
|-<br />
| <code>40</code><br />
| Playcount<br />
|-<br />
| <code>41</code><br />
| Listeners<br />
|-<br />
| <code>42</code><br />
| Bitrate<br />
|-<br />
| <code>43</code><br />
| Random<br />
|-<br />
| <code>44</code><br />
| Channel<br />
|-<br />
| <code>45</code><br />
| ChannelNumber<br />
|-<br />
| <code>46</code> <br />
| DateTaken<br />
|}<br />
<br />
== See also ==<br />
* [[Action IDs]]<br />
<br />
[[Category:Python]]<br />
[[Category:Add-on development]]<br />
[[Category:Skin development]]</div>Phil65https://kodi.wiki/index.php?title=List_of_built-in_functions&diff=126908List of built-in functions2017-01-03T22:26:52Z<p>Phil65: </p>
<hr />
<div>{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}<br />
<section begin="main content" /><br />
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>.<br />
<br />
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].<br />
<br />
In addition to the following list, for most <onclick> and <onfocus> button actions in the skin you can also use the functions from [[Keyboard.xml]].<br />
<br />
<poem><br />
'''Example:'''<br />
<onclick>VolumeUp</onclick><br />
<onclick>VolumeDown</onclick><br />
</poem><br />
<br />
'''You can use parameters with all media windows, as can be seen here:'''<br />
* [[Opening Windows and Dialogs]]<br />
<br />
== List of functions ==<br />
<section begin="functions" /><br />
{| class="prettytable sort sortable"<br />
! Function<br />
! Description<br />
! Version<br />
|-<br />
| <code>Action(action[,window])</code><br />
| 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 window names, and their respective ids. <br />
| <br />
|-<br />
| <code>ActivateScreensaver</code><br />
| Starts the screensaver<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>ActivateWindow(window[,dir,return])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code><br />
| 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).<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>Addon.Default.OpenSettings(extensionpoint)</code><br />
| Open a settings dialog for the default addon of the given type (extensionpoint)<br />
| <br />
|-<br />
| <code>Addon.Default.Set(extensionpoint)</code><br />
| Open a select dialog to allow choosing the default addon of the given type (extensionpoint)<br />
| <br />
|-<br />
| <code>Addon.OpenSettings(id)</code><br />
| Open a settings dialog for the addon of the given id <br />
| <br />
|-<br />
| <code>AlarmClock(name,command,time[,silent,loop])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>AllowIdleShutdown</code><br />
| Allow the system to shutdown on idle.<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>CancelAlarm(name[,silent])</code><br />
| Cancel a running alarm. Set silent to true to hide the alarm notification. <br />
| <br />
|-<br />
| <code>CECActivateSource</code><br />
| Wake up playing device via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CECStandby</code><br />
| Put playing device on standby via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CECToggleState</code><br />
| Toggle state of playing device via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CleanLibrary(database)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ClearProperty(key[,id])</code><br />
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id). <br />
| <br />
|-<br />
| <code>Container.NextSortMethod</code><br />
| Change to the next sort method. <br />
| <br />
|-<br />
| <code>Container.NextViewMode</code><br />
| Select the next view mode. <br />
| <br />
|-<br />
| <code>Container.PreviousSortMethod</code><br />
| Change to the previous sort method. <br />
| <br />
|-<br />
| <code>Container.PreviousViewMode</code><br />
| Select the previous view mode. <br />
| <br />
|-<br />
| <code>Container.Refresh</code><br />
| Refresh current listing. <br />
| <br />
|-<br />
| <code>Container.SetSortMethod(id)</code><br />
| Change to the specified sort method. (For list of ID's see List of sort methods below) <br />
| <br />
|-<br />
| <code>Container.SetViewMode(id)</code><br />
| Set the current view mode (list, icons etc.) to the given container id. <br />
| <br />
|-<br />
| <code>Container.SetSortDirection</code><br />
| Toggle the sort direction. <br />
| <br />
|-<br />
| <code>Container.Update</code><br />
| Update current listing. Send Container.Update(path,replace) to reset the path history. <br />
| <br />
|-<br />
| <code>Control.Message(id,message,[windowid])</code><br />
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click. <br />
| <br />
|-<br />
| <code>Control.Move(id,offset)</code><br />
| Will make a Container with the "id" specified in the command move focus by "offset". <br />
| <br />
|-<br />
| <code>Control.SetFocus(id,position)</code><br />
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position) <br />
| <br />
|-<br />
| <code>Dialog.Close(dialog[,force])</code><br />
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once. <br />
| <br />
|-<br />
| <code>EjectTray()</code><br />
| Either opens or closes the DVD tray, depending on its current state <br />
| <br />
|-<br />
| <code>exportlibrary(music,false,filepath)</code><br />
| The music library will be exported to a single file stored at filepath location. <br />
| <br />
|-<br />
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code><br />
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false). <br />
| <br />
|-<br />
| <code>Extract</code><br />
| Extracts a specified archive to an optionally specified 'absolute' path. <br />
| <br />
|-<br />
| <code>Help</code><br />
| This help message (??? probably broken) <br />
| <br />
|-<br />
| <code>Hibernate</code><br />
| Hibernate (S4) the System <br />
| <br />
|-<br />
| <code>InhibitIdleShutdown(true/false)</code><br />
| Prevent the system to shutdown on idle.<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>InstallAddon(id)</code><br />
| Will install the addon with the given id.<br />
| <br />
|-<br />
| <code>LIRC.Send(command)</code><br />
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup) <br />
| <br />
|-<br />
| <code>LIRC.Start</code><br />
| Adds Kodi as a LIRC client. <br />
| <br />
|-<br />
| <code>LIRC.Stop</code><br />
| Removes Kodi as a LIRC client. <br />
| <br />
|-<br />
| <code>LoadProfile(profilename,[prompt])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Mastermode</code><br />
| Runs Kodi in master mode <br />
| <br />
|-<br />
| <code>Minimize</code><br />
| Minimizes Kodi <br />
| <br />
|-<br />
| <code>Mute</code><br />
| Mutes (or unmutes) the volume. <br />
| <br />
|-<br />
| <code>NextChannelGroup</code><br />
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>NextStereoMode</code><br />
| Changes the stereo mode of the GUI to the next available mode.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>Notification(header,message[,time,image])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>NotifyAll(sender, data [, json])</code><br />
| Notify all connected clients<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PageDown</code><br />
| Send a page down event to the pagecontrol with given id. <br />
| <br />
|-<br />
| <code>PageUp</code><br />
| Send a page up event to the pagecontrol with given id. <br />
| <br />
|-<br />
| <code>PlayDVD</code><br />
| Will play the inserted CD or DVD media from the DVD-ROM drive. <br />
| <br />
|-<br />
| <code>PlayerControl(command)</code><br />
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, TempoUp, TempoDown, Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file), and Record. Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. <br />
| <br />
|-<br />
| <code>Playlist.Clear</code><br />
| Clear the current playlist <br />
| <br />
|-<br />
| <code>Playlist.PlayOffset</code><br />
| Start playing from a particular offset in the playlist <br />
| <br />
|-<br />
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code><br />
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. <br />
| <br />
|-<br />
| <code>PlayWith()</code><br />
| Play the selected item with the specified player core. <br />
| <br />
|-<br />
| <code>Powerdown</code><br />
| Powerdown system <br />
| <br />
|-<br />
| <code>PreviousChannelGroup</code><br />
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PreviousStereoMode</code><br />
| Changes the stereo mode of the GUI to the previous available mode.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PVR.SearchMissingChannelIcons</code><br />
| Will start a search for missing channel icons<br />
| {{nowrap|v16 Addition}}<br />
|-<br />
| <code>Quit</code><br />
| Quits Kodi <br />
| <br />
|-<br />
| <code>Reboot</code><br />
| Cold reboots the system (power cycle) <br />
| <br />
|-<br />
| <code>RecursiveSlideShow(dir)</code><br />
| Run a slideshow from the specified directory, including all subdirs <br />
| <br />
|-<br />
| <code>RefreshRSS</code><br />
| Reload RSS feeds from RSSFeeds.xml <br />
| <br />
|-<br />
| <code>ReloadSkin()</code><br />
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling) <br />
| <br />
|-<br />
| <code>ReplaceWindow(window,dir)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code><br />
| 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).<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>Reset</code><br />
| Reset the system (same as reboot) <br />
| <br />
|-<br />
| <code>Resolution</code><br />
| Change Kodi's Resolution. <br />
| <br />
|-<br />
| <code>RestartApp</code><br />
| Restarts Kodi (only implemented under Windows and Linux) <br />
| <br />
|-<br />
| <code>RipCD</code><br />
| Will rip the inserted CD from the DVD-ROM drive. <br />
| <br />
|-<br />
| <code>RunAddon(id)</code><br />
| Runs the specified plugin/script <br />
| <br />
|-<br />
| <code>RunAppleScript(script[,args]*)</code><br />
| Run the specified AppleScript command <br />
| <br />
|-<br />
| <code>RunPlugin(plugin)</code><br />
| Runs the plugin. Full path must be specified. Does not work for folder plugins <br />
| <br />
|-<br />
| <code>RunScript(script[,args]*)</code><br />
| Runs the python script. You must specify the full path to the script. One way to specify the full path is through the [[Special protocol|special protocol]]. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv <br />
| <br />
|-<br />
| <code>Seek(seconds)</code><br />
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.<br />
| {{nowrap|v15 Addition}}<br />
|-<br />
| <code>SendClick(windowid,id)</code><br />
| Sends a click to a control in a given window (or active window if omitted). <br />
| <br />
|-<br />
| <code>SetFocus(id,position)</code><br />
| Will make a container with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position) <br />
| <br />
|-<br />
| <code>SetGUILanguage</code><br />
| Set GUI Language<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>SetProperty(key,value[,id])</code><br />
| Sets a window property for the current window (key,value), or the specified window (key,value,id). <br />
| <br />
|-<br />
| <code>SetStereoMode</code><br />
| 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)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>settingslevelchange</code><br />
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>SetVolume(percent[,showvolumebar])</code><br />
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume. <br />
| <br />
|-<br />
| <code>ShowPicture(picture)</code><br />
| Show a picture by its file path/url.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>ShutDown</code><br />
| Trigger default Shutdown action defined in System Settings <br />
| <br />
|-<br />
| <code>Skin.Reset(setting)</code><br />
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty. <br />
| <br />
|-<br />
| <code>Skin.ResetSettings</code><br />
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.) <br />
| <br />
|-<br />
| <code>Skin.SelectBool(header, label1&#124;setting1, label2&#124;setting2)</code><br />
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411&#124;RecentWidget, 31412&#124;RandomWidget, 31413&#124;InProgressWidget)<br />
| <br />
|-<br />
| <code>Skin.SetAddon(string,type)</code><br />
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image and xbmc.addon.executable. <br />
| <br />
|-<br />
| <code>Skin.SetBool(setting)</code><br />
| Sets the skin setting ?setting? to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings. <br />
| <br />
|-<br />
| <code>Skin.SetFile(string,mask,folderpath)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetImage(string[,value,path])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetNumeric(numeric[,value])</code><br />
| Pops up a keyboard dialog and allows the user to input a numerical. <br />
| <br />
|-<br />
| <code>Skin.SetPath(string[,folderpath])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetString(string[,value])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.Theme(1)</code><br />
| Cycles the skin theme. Skin.Theme(-1) will go backwards. <br />
| <br />
|-<br />
| <code>Skin.ToggleDebug</code><br />
| Toggles skin debug info on/off <br />
| <br />
|-<br />
| <code>Skin.ToggleSetting(setting)</code><br />
| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting). <br />
| <br />
|-<br />
| <code>SlideShow(dir [,recursive, [not]random])</code><br />
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window. <br />
| <br />
|-<br />
| <code>StartAndroidActivity(package,[intent,dataType,dataURI])</code><br />
| 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><br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>StartPVRManager</code><br />
| (Re)Starts the PVR manager<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>StereoModeToMono</code><br />
| Toggle the stereoscopic mode to 2D.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>StopPVRManager</code><br />
| Stops the PVR manager<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>StopScript(id)</code><br />
| Stop the script by ID or path, if running<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>Suspend</code><br />
| Suspends (S3 / S1 depending on bios setting) the System <br />
| <br />
|-<br />
| <code>System.Exec</code><br />
| Execute shell commands. <br />
| <br />
|-<br />
| <code>System.ExecWait</code><br />
| Execute shell commands and freezes Kodi until shell is closed. <br />
| <br />
|-<br />
| <code>System.LogOff</code><br />
| Log off current user. <br />
| <br />
|-<br />
| <code>TakeScreenshot([filenameandpath,sync])</code><br />
| 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).<br />
| <br />
|-<br />
| <code>ToggleDebug</code><br />
| Enables/disables debug mode<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>ToggleDirtyRegionVisualization</code><br />
| makes dirty regions visible for debugging proposes.<br />
| {{nowrap|v16 Addition}}<br />
|-<br />
| <code>ToggleDPMS</code><br />
| Toggle DPMS mode manually <br />
| <br />
|-<br />
| <code>ToggleStereoMode</code><br />
| Toggle the stereoscopic mode of the GUI (on/off).<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>UnloadSkin()</code><br />
| Unloads the current skin <br />
| <br />
|-<br />
| <code>UpdateAddonRepos</code><br />
| Triggers a forced update of enabled add-on repositories. <br />
| <br />
|-<br />
| <code>UpdateLibrary(database,[path])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>UpdateLocalAddons</code><br />
| Triggers a scan of local add-on directories. <br />
| <br />
|-<br />
| <code>VideoLibrary.Search</code><br />
| Brings up a search dialog which will search the library <br />
| <br />
|-<br />
| <code>WakeOnLan(mac)</code><br />
| 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). <br />
| <br />
|-<br />
| <code>Weather.LocationNext</code><br />
| Switch to next weather location <br />
| <br />
|-<br />
| <code>Weather.LocationPrevious</code><br />
| Switch to previous weather location <br />
| <br />
|-<br />
| <code>Weather.LocationSet</code><br />
| Switch to given weather location (parameter can be 1-3) <br />
| <br />
|-<br />
| <code>Weather.Refresh</code><br />
| Force weather data refresh<br />
| <br />
|}<br />
<section end="functions" /><br />
<section end="main content" /><br />
<br />
== Removed functions ==<br />
* <code>LastFM.Love</code> - Removed in v13 Gotham<br />
* <code>LastFM.Ban</code> - Removed in v13 Gotham<br />
* <code>LCD.Suspend</code> - Removed in v13 Gotham<br />
* <code>LCD.Resume</code> - Removed in v13 Gotham<br />
<br />
== List of sort methods ==<br />
These ID's can be used with the Container.SetSortMethod(id) function as listed [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.cpp#L529-L577 here]:<br />
{| class="prettytable"<br />
! ID<br />
! Description<br />
|-<br />
| <code>1</code><br />
| Name<br />
|-<br />
| <code>2</code><br />
| Date<br />
|-<br />
| <code>3</code><br />
| Size<br />
|-<br />
| <code>4</code><br />
| File<br />
|-<br />
| <code>5</code><br />
| Path<br />
|-<br />
| <code>6</code><br />
| DriveType<br />
|-<br />
| <code>7</code><br />
| Title<br />
|-<br />
| <code>8</code><br />
| TrackNumber<br />
|-<br />
| <code>9</code><br />
| Time<br />
|-<br />
| <code>10</code><br />
| Artist<br />
|-<br />
| <code>11</code><br />
| Album<br />
|-<br />
| <code>12</code><br />
| AlbumType<br />
|-<br />
| <code>13</code><br />
| Genre<br />
|-<br />
| <code>14</code><br />
| Country<br />
|-<br />
| <code>15</code><br />
| Year<br />
|-<br />
| <code>16</code><br />
| Rating<br />
|-<br />
| <code>17</code><br />
| Votes<br />
|-<br />
| <code>18</code><br />
| Top250<br />
|-<br />
| <code>19</code><br />
| ProgramCount<br />
|-<br />
| <code>20</code><br />
| PlaylistOrder<br />
|-<br />
| <code>21</code><br />
| EpisodeNumber<br />
|-<br />
| <code>22</code><br />
| Season<br />
|-<br />
| <code>23</code><br />
| NumberOfEpisodes<br />
|-<br />
| <code>24</code><br />
| NumberOfWatchedEpisodes<br />
|-<br />
| <code>25</code><br />
| TvShowStatus<br />
|-<br />
| <code>26</code><br />
| TvShowTitle<br />
|-<br />
| <code>27</code><br />
| SortTitle<br />
|-<br />
| <code>28</code><br />
| ProductionCode<br />
|-<br />
| <code>29</code><br />
| MPAA<br />
|-<br />
| <code>30</code><br />
| VideoResolution<br />
|-<br />
| <code>31</code><br />
| VideoCodec<br />
|-<br />
| <code>32</code><br />
| VideoAspectRatio<br />
|-<br />
| <code>33</code><br />
| AudioChannels<br />
|-<br />
| <code>34</code><br />
| AudioCodec<br />
|-<br />
| <code>35</code><br />
| AudioLanguage<br />
|-<br />
| <code>36</code><br />
| SubtitleLanguage<br />
|-<br />
| <code>37</code><br />
| Studio<br />
|-<br />
| <code>38</code><br />
| DateAdded<br />
|-<br />
| <code>39</code><br />
| LastPlayed<br />
|-<br />
| <code>40</code><br />
| Playcount<br />
|-<br />
| <code>41</code><br />
| Listeners<br />
|-<br />
| <code>42</code><br />
| Bitrate<br />
|-<br />
| <code>43</code><br />
| Random<br />
|-<br />
| <code>44</code><br />
| Channel<br />
|-<br />
| <code>45</code><br />
| ChannelNumber<br />
|-<br />
| <code>46</code> <br />
| DateTaken<br />
|}<br />
<br />
== See also ==<br />
* [[Action IDs]]<br />
<br />
[[Category:Python]]<br />
[[Category:Add-on development]]<br />
[[Category:Skin development]]</div>Phil65https://kodi.wiki/index.php?title=List_of_boolean_conditions&diff=126849List of boolean conditions2016-12-22T03:47:11Z<p>Phil65: /* VideoPlayer */</p>
<hr />
<div>{{see also|Conditional Visibility}}<br />
<section begin="main content" /><br />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.<br />
<br />
=== ADSP ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>ADSP.IsActive</code><br />
| Returns true if dsp system is enabled<br />
| <br />
|-<br />
| <code>ADSP.HasModes</code><br />
| Returns true if one or more modes are present on any of the types<br />
| <br />
|-<br />
| <code>ADSP.HasInputResample</code><br />
| Returns true if on stream is a input resample is active<br />
| <br />
|-<br />
| <code>ADSP.HasPreProcess</code><br />
| Returns true if on stream is a pre process mode active<br />
| <br />
|-<br />
| <code>ADSP.HasMasterProcess</code><br />
| Returns true if on stream is a master process mode available<br />
| <br />
|-<br />
| <code>ADSP.HasPostProcess</code><br />
| Returns true if on stream is a post process<br />
| <br />
|-<br />
| <code>ADSP.HasOutputResample</code><br />
| Returns true if on stream is a output resample<br />
| <br />
|-<br />
| <code>ADSP.MasterActive</code><br />
| Returns true if on stream is a master mode selected and active<br />
| <br />
|}<br />
<br />
=== Container ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Container.HasThumb</code><br />
| Returns true if the current container you are in has a thumb assigned to it<br />
| <br />
|-<br />
| <code>Container.Content(parameter)</code><br />
| Returns true if the current container you are in contains the following: '''files, songs, artists, albums, movies, tvshows, seasons, episodes, musicvideos, genres, years, actors, playlists, plugins, studios, directors, sets, tags, countries, roles, images''' (Note: these currently only work in the Video and Music Library or unless a Plugin has set the value) also available are '''Addons''' true when a list of add-ons is shown '''LiveTV''' true when a htsp (tvheadend) directory is shown<br />
|<br />
|-<br />
| <code>Container(id).OnNext</code><br />
| Returns true if the container with id (or current container if id is omitted) is moving to the next item. Allows views to be custom-designed (such as 3D coverviews etc.)<br />
|<br />
|-<br />
| <code>Container(id).OnScrollNext</code><br />
| Returns true if the container with id (or current container if id is omitted) is scrolling to the next item. Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.<br />
|<br />
|-<br />
| <code>Container(id).OnPrevious</code><br />
| Returns true if the container with id (or current container if id is omitted) is moving to the previous item. Allows views to be custom-designed (such as 3D coverviews etc.)<br />
|<br />
|-<br />
| <code>Container(id).OnScrollPrevious</code><br />
| Returns true if the container with id (or current container if id is omitted) is scrolling to the previous item. Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.<br />
|<br />
|-<br />
| <code>Container(id).HasFocus(item_number)</code><br />
| Returns true if the container with id (or current container if id is omitted) has static content and is focused on the item with id item_number.<br />
|<br />
|-<br />
| <code>Container(id).HasFiles</code><br />
| Returns true if the container contains files (or current container if id is omitted).<br />
|<br />
|-<br />
| <code>Container(id).HasFolders</code><br />
| Returns true if the container contains folders (or current container if id is omitted).<br />
|<br />
|-<br />
| <code>Container(id).HasNext</code><br />
| Returns true if the container or textbox with id (id) has a next page.<br />
|<br />
|-<br />
| <code>Container(id).HasPrevious</code><br />
| Returns true if the container or textbox with id (id) has a previous page.<br />
|<br />
|-<br />
| <code>Container(id).IsUpdating</code><br />
| Returns true if the container with [[Dynamic List Content|dynamic list content]] is currently updating.<br />
|<br />
|-<br />
| <code>Container(id).IsStacked</code><br />
| Returns true if the container is currently in stacked mode (or current container if id is omitted).<br />
|<br />
|-<br />
| <code>Container.CanFilter</code><br />
| Returns true when the current container can be filtered.<br />
|<br />
|-<br />
| <code>Container.CanFilterAdvanced</code><br />
| Returns true when advanced filtering can be applied to the current container.<br />
|<br />
|-<br />
| <code>Container.Filtered</code><br />
| Returns true when a mediafilter is applied to the current container.<br />
|<br />
|-<br />
| <code>Container.HasParent</code><br />
| Return true when the container contains a parent ('..') item.<br />
|<br />
|-<br />
| <code>Container.SortDirection(ascending)</code><br />
| Returns true the sort direction of a container is ascending.<br />
|<br />
|-<br />
| <code>Container.SortDirection(descending)</code><br />
| Returns true the sort direction of a container is descending.<br />
|<br />
|-<br />
| <code>Container(id).Row(row)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.<br />
|<br />
|-<br />
| <code>Container(id).Column(col)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.<br />
|<br />
|-<br />
| <code>Container(id).Position(pos)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.<br />
|<br />
|-<br />
| <code>Container(id).Scrolling</code><br />
| Returns true if the user is currently scrolling through the container with id (or current container if id is omitted). Note that this is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.<br />
|<br />
|}<br />
<br />
=== Control ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Control.IsEnabled(id)</code><br />
| Returns true if the control with id "id" is enabled.<br />
|<br />
|-<br />
| <code>Control.IsVisible(id)</code><br />
| Returns true if the control with id "id" is visible.<br />
|<br />
|-<br />
| <code>Control.HasFocus(id)</code><br />
| Returns true if the currently focused control has id "id".<br />
|<br />
|-<br />
| <code>ControlGroup(group).HasFocus(id)</code><br />
| Returns true if the control group with id “group” has control id “id” as it's focused item. 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”. Note that 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 />
|<br />
|}<br />
<br />
=== Integer ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsLess([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== Library ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Library.HasContent(string)</code><br />
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)<br />
|<br />
|-<br />
| <code>Library.IsScanningMusic</code><br />
| Returns true if the music library is being updated<br />
|<br />
|-<br />
| <code>Library.IsScanningVideo</code><br />
| Returns true if the video library is being updated<br />
|<br />
|-<br />
| <code>Library.HasContent(Role, Composer)</code><br />
| 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<br />
| v17 addition<br />
|}<br />
<br />
=== ListItem ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>ListItem.IsFolder</code><br />
| Returns whether the current ListItem is a folder<br />
|<br />
|-<br />
| <code>ListItem.IsPlaying</code><br />
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media<br />
|<br />
|-<br />
| <code>ListItem.IsResumable</code><br />
| Returns true when the current ListItem has been partially played<br />
|<br />
|-<br />
| <code>ListItem.IsCollection</code><br />
| Returns true when the current ListItem is a movie set<br />
|<br />
|-<br />
| <code>ListItem.IsSelected</code><br />
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)<br />
|<br />
|-<br />
| <code>ListItem.HasEpg</code><br />
| Returns true when the selected programme has epg info (PVR)<br />
|<br />
|-<br />
| <code>ListItem.HasTimer</code><br />
| Returns true when a recording timer has been set for the selected programme (PVR)<br />
|<br />
|-<br />
| <code>ListItem.IsRecording</code><br />
| Returns true when the selected programme is being recorded (PVR)<br />
|<br />
|-<br />
| <code>ListItem.IsEncrypted</code><br />
| Returns true when the selected programme is encrypted (PVR)<br />
|<br />
|-<br />
| <code>ListItem.IsStereoscopic</code><br />
| Returns true when the selected video is a 3D (stereoscopic) video<br />
|<br />
|-<br />
| <code>ListItem.Property(IsSpecial)</code><br />
| Returns whether the current Season/Episode is a Special<br />
|<br />
|-<br />
| <code>ListItem.Property(DateLabel)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>ListItem.Property(Addon.IsEnabled)</code><br />
| Returns true when the selected addon is enabled (for use in the addon info dialog only).<br />
|<br />
|-<br />
| <code>ListItem.Property(Addon.IsInstalled)</code><br />
| Returns true when the selected addon is installed (for use in the addon info dialog only).<br />
|<br />
|-<br />
| <code>ListItem.Property(Addon.HasUpdate)</code><br />
| Returns true when there's an update available for the selected addon.<br />
|<br />
|-<br />
| ListItem.HasTimerSchedule<br />
| Whether the item is part of a repeating timer schedule (PVR).<br />
| v16 addition<br />
|-<br />
| ListItem.TimerHasError<br />
| Whether the item has a timer and it won't be recorded because of an error (PVR).<br />
| v17 addition<br />
|-<br />
| ListItem.TimerHasConflict<br />
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).<br />
| v17 addition<br />
|-<br />
| ListItem.TimerIsActive<br />
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). <br />
| v17 addition<br />
|-<br />
| <code>ListItem.Property(Addon.Orphaned)</code><br />
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)<br />
| v17 addition<br />
|-<br />
| <code>ListItem.IsParentFolder</code><br />
| Returns true is the slected item is the 'up' item<br />
| v17 addition<br />
|}<br />
<br />
=== Player ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Player.HasMedia</code><br />
| Returns true if the player has an audio or video file.<br />
|<br />
|-<br />
| <code>Player.HasAudio</code><br />
| Returns true if the player has an audio file.<br />
|<br />
|-<br />
| <code>Player.HasDuration</code><br />
| Returns true if Media isn't a true stream<br />
|<br />
|-<br />
| <code>Player.HasVideo</code><br />
| Returns true if the player has a video file.<br />
|<br />
|-<br />
| <code>Player.Passthrough</code><br />
| Returns true if the player is using audio passthrough.<br />
|<br />
|-<br />
| <code>Player.Playing</code><br />
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)<br />
|<br />
|-<br />
| <code>Player.Paused</code><br />
| Returns true if the player is paused.<br />
|<br />
|-<br />
| <code>Player.Forwarding</code><br />
| Returns true if the player is fast forwarding.<br />
|<br />
|-<br />
| <code>Player.Forwarding2x</code><br />
| Returns true if the player is fast forwarding at 2x.<br />
|<br />
|-<br />
| <code>Player.Forwarding4x</code><br />
| Returns true if the player is fast forwarding at 4x.<br />
|<br />
|-<br />
| <code>Player.Forwarding8x</code><br />
| Returns true if the player is fast forwarding at 8x.<br />
|<br />
|-<br />
| <code>Player.Forwarding16x</code><br />
| Returns true if the player is fast forwarding at 16x.<br />
|<br />
|-<br />
| <code>Player.Forwarding32x</code><br />
| Returns true if the player is fast forwarding at 32x.<br />
|<br />
|-<br />
| <code>Player.Rewinding</code><br />
| Returns true if the player is rewinding.<br />
|<br />
|-<br />
| <code>Player.Rewinding2x</code><br />
| Returns true if the player is rewinding at 2x.<br />
|<br />
|-<br />
| <code>Player.Rewinding4x</code><br />
| Returns true if the player is rewinding at 4x.<br />
|<br />
|-<br />
| <code>Player.Rewinding8x</code><br />
| Returns true if the player is rewinding at 8x.<br />
|<br />
|-<br />
| <code>Player.Rewinding16x</code><br />
| Returns true if the player is rewinding at 16x.<br />
|<br />
|-<br />
| <code>Player.Rewinding32x</code><br />
| Returns true if the player is rewinding at 32x.<br />
|<br />
|-<br />
| <code>Player.CanRecord</code><br />
| Returns true if the player can record the current internet stream.<br />
|<br />
|-<br />
| <code>Player.Recording</code><br />
| Returns true if the player is recording the current internet stream.<br />
|<br />
|-<br />
| <code>Player.Caching</code><br />
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).<br />
|<br />
|-<br />
| <code>Player.DisplayAfterSeek</code><br />
| Returns true for the first 2.5 seconds after a seek.<br />
|<br />
|-<br />
| <code>Player.Seeking</code><br />
| Returns true if a seek is in progress<br />
|<br />
|-<br />
| <code>Player.ShowTime</code><br />
| Returns true if the user has requested the time to show (occurs in video fullscreen)<br />
|<br />
|-<br />
| <code>Player.ShowInfo</code><br />
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)<br />
|<br />
|-<br />
| <code>Player.IsInternetStream</code><br />
| Returns true if the player is playing an internet stream.<br />
|<br />
|-<br />
| <code>Player.Muted</code><br />
| Returns true if the volume is muted.<br />
|<br />
|-<br />
| <code>Player.Process(videohwdecoder)</code><br />
| Returns true if the currently playing video is decoded in hardware<br />
| v17 addition<br />
|-<br />
| <code>Player.TempoEnabled</code><br />
| Returns true if the current player supports changing the playback speed<br />
| v17 addition<br />
|-<br />
| <code>Player.IsTempo</code><br />
| Returns true if the current playbackspeed is not equal to 1<br />
| v17 addition<br />
|}<br />
<br />
==== MusicPlayer ====<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>MusicPlayer.HasNext</code><br />
| Returns true if the music player has a next song queued in the Playlist.<br />
|<br />
|-<br />
| <code>MusicPlayer.HasPrevious</code><br />
| Returns true if the music player has a a Previous Song in the Playlist .<br />
|<br />
|-<br />
| <code>MusicPlayer.Offset(number).Exists</code><br />
| Returns true if the music players playlist has a song queued in position (number).<br />
|<br />
|-<br />
| <code>MusicPartyMode.Enabled</code><br />
| Returns true if Party Mode is enabled<br />
|<br />
|}<br />
<br />
==== VideoPlayer ====<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>VideoPlayer.UsingOverlays</code><br />
| 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.<br />
|<br />
|-<br />
| <code>VideoPlayer.IsFullscreen</code><br />
| Returns true if the video player is in fullscreen mode.<br />
|<br />
|-<br />
| <code>VideoPlayer.HasMenu</code><br />
| Returns true if the video player has a menu (ie is playing a DVD)<br />
|<br />
|-<br />
| <code>VideoPlayer.HasInfo</code><br />
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)<br />
|<br />
|-<br />
| <code>VideoPlayer.Content(parameter)</code><br />
| 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<br />
|<br />
|-<br />
| <code>VideoPlayer.HasSubtitles</code><br />
| Returns true if there are subtitles available for video. (available for version 11.0 and above)<br />
|<br />
|-<br />
| <code>VideoPlayer.IsStereoscopic</code><br />
| Returns true when the currently playing video is a 3D (stereoscopic) video<br />
|<br />
|-<br />
| <code>VideoPlayer.SubtitlesEnabled</code><br />
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)<br />
|<br />
|-<br />
| <code>VideoPlayer.HasEpg</code><br />
| Returns true when epg information is available for the currently playing programme (PVR).<br />
||-<br />
| <code>VideoPlayer.HasTeletext</code><br />
| Returns true when teletext is available.<br />
|<br />
|}<br />
<br />
=== PlayList ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Playlist.IsRandom</code><br />
| Returns true if the player is in random mode.<br />
|<br />
|-<br />
| <code>Playlist.IsRepeat</code><br />
| Returns true if the player is in repeat all mode.<br />
|<br />
|-<br />
| <code>Playlist.IsRepeatOne</code><br />
| Returns true if the player is in repeat one mode.<br />
|<br />
|}<br />
<br />
=== PVR ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Pvr.HasTimer</code><br />
| Returns true when a recording timer is active.<br />
|<br />
|-<br />
| <code>Pvr.HasNonRecordingTimer</code><br />
| Returns true when a non recording timer is active.<br />
|<br />
|-<br />
| <code>Pvr.HasTVChannels</code><br />
| Returns true if there are tv channels available<br />
|<br />
|-<br />
| <code>Pvr.HasRadioChannels</code><br />
| Returns true if there are radio channels available<br />
|<br />
|-<br />
| <code>Pvr.IsPlayingTv</code><br />
| Returns true when live tv is being watched.<br />
|<br />
|-<br />
| <code>Pvr.IsPlayingRadio</code><br />
| Returns true when live radio is being listened to.<br />
|<br />
|-<br />
| <code>Pvr.IsPlayingRecording</code><br />
| Returns true when a recording is being watched.<br />
|<br />
|-<br />
| <code>Pvr.IsRecording</code><br />
| Returns true when the system is recording a tv programme.<br />
|<br />
|-<br />
| <code>Pvr.IsTimeShift</code><br />
| Returns true when the playback is timeshifted.<br />
|<br />
|-<br />
| <code>Pvr.ActStreamIsEncrypted</code><br />
| Returns true if the stream is encrypted<br />
|<br />
|-<br />
| Pvr.RadioNextRecordingChannelIcon<br />
| Icon of the next recording radio channel<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.IsRecordingTV<br />
| Returns true when the system is recording a tv programme.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasTVTimer<br />
| Returns true if at least one tv timer is active.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasNonRecordingTVTimer<br />
| Returns true if there are tv timers present who currently not do recording<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.IsRecordingRadio<br />
| Returns true when the system is recording a radio programme.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasRadioTimer<br />
| Returns true if at least one radio timer is active.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasNonRecordingRadioTimer<br />
| Returns true if there are radio timers present who currently not do recording<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== RDS ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>RDS.HasRds</code><br />
| Returns true if RDS is present<br />
|<br />
|-<br />
| <code>RDS.HasRadioText</code><br />
| Returns true if RDS contains also Radiotext<br />
|<br />
|-<br />
| <code>RDS.HasRadioTextPlus</code><br />
| Returns true if RDS with Radiotext contains also the plus information<br />
|<br />
|-<br />
| <code>RDS.HasHotline</code><br />
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)<br />
|<br />
|-<br />
| <code>RDS.HasStudio</code><br />
| Returns true if a studio name is present (Only be available on RadiotextPlus)<br />
|<br />
|}<br />
<br />
=== Skin ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Skin.HasTheme(theme)</code><br />
| Returns true if the user has selected the theme with name ?theme?.<br />
|<br />
|-<br />
| <code>Skin.HasSetting(setting)</code><br />
| 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>.<br />
|<br />
|-<br />
| <code>Skin.String(string)</code><br />
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.<br />
|<br />
|-<br />
| <code>Skin.String(string1,string2)</code><br />
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.<br />
|<br />
|}<br />
<br />
=== SlideShow ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Slideshow.IsActive</code><br />
| Returns true if the picture slideshow is running<br />
|<br />
|-<br />
| <code>Slideshow.IsPaused</code><br />
| Returns true if the picture slideshow is paused<br />
|<br />
|-<br />
| <code>Slideshow.IsRandom</code><br />
| Returns true if the picture slideshow is in random mode<br />
|<br />
|-<br />
| <code>Slideshow.IsVideo</code><br />
| Returns true if the picture slideshow is playing a video<br />
|<br />
|}<br />
<br />
=== String ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>String.IsEmpty([[InfoLabels|info]])</code><br />
| 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.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.IsEqual([[InfoLabels|info]],string)</code><br />
| 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.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.StartsWith([[InfoLabels|info]],substring)</code><br />
| 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[]. Also note that in a panelview or similar this only works on the focused item.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.EndsWith([[InfoLabels|info]],substring)</code><br />
| 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[]. Also note that in a panelview or similar this only works on the focused item.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.Contains([[InfoLabels|info]],substring)</code><br />
| 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[]. Also note that in a panelview or similar this only works on the focused item.<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== System ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>System.HasAddon(id)</code><br />
| Returns true if the specified addon is installed on the system.<br />
|<br />
|-<br />
| <code>System.HasPVRAddon</code><br />
| Returns true if at least one PVR addon is installed on the system.<br />
|<br />
|-<br />
| <code>System.HasAlarm(alarm)</code><br />
| Returns true if the system has the ?alarm? alarm set.<br />
|<br />
|-<br />
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>System.HasNetwork</code><br />
| Returns true if the ethernet cable is plugged in.<br />
|<br />
|-<br />
| <code>System.HasMediadvd</code><br />
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.<br />
|<br />
|-<br />
| <code>System.IdleTime(time)</code><br />
| Returns true if Kodi has had no input for ?time? amount of seconds.<br />
|<br />
|-<br />
| <code>System.IsStandalone</code><br />
| Returns true if Kodi is running in standalone mode.<br />
|<br />
|-<br />
| <code>System.IsFullscreen</code><br />
| Returns true if Kodi is running fullscreen.<br />
|<br />
|-<br />
| <code>System.KaiConnected</code><br />
| Returns true if XBMC's Kai client is connected to the PC engine.<br />
|<br />
|-<br />
| <code>System.IsLoggedOn</code><br />
| Returns true if a user is currently logged on under a [[Profiles|profile]]<br />
|<br />
|-<br />
| <code>System.HasLoginScreen</code><br />
| Returns true if the [[Profiles|profile]] login screen is enabled<br />
|<br />
|-<br />
| <code>System.HasADSP</code><br />
| Returns true if ADSP is enabled<br />
|<br />
|-<br />
| <code>System.HasModalDialog</code><br />
| Returns true true if a modal dialog is visible<br />
|<br />
|-<br />
| <code>System.Time(startTime,endTime)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>System.Date(startDate,endDate)</code><br />
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.<br />
|<br />
|-<br />
| <code>System.Platform.Linux</code><br />
| Returns true if Kodi is running on a linux/unix based computer.<br />
|<br />
|-<br />
| <code>System.Platform.Linux.RaspberryPi</code><br />
| Returns true if Kodi is running on a Raspberry Pi.<br />
|<br />
|-<br />
| <code>System.Platform.Windows</code><br />
| Returns true if Kodi is running on a windows based computer.<br />
|<br />
|-<br />
| <code>System.Platform.OSX</code><br />
| Returns true if Kodi is running on an OSX based computer.<br />
|<br />
|-<br />
| <code>System.Platform.IOS</code><br />
| Returns true if Kodi is running on an IOS device.<br />
|<br />
|-<br />
| <code>System.Platform.Darwin</code><br />
| Returns true if Kodi is running on an OSX or IOS system.<br />
|<br />
|-<br />
| <code>System.Platform.ATV2</code><br />
| Returns true if Kodi is running on an atv2.<br />
|<br />
|-<br />
| <code>System.Platform.Android</code><br />
| Returns true if Kodi is running on an android device.<br />
|<br />
|-<br />
| <code>System.CanPowerDown</code><br />
| Returns true if Kodi can powerdown the system.<br />
|<br />
|-<br />
| <code>System.CanSuspend</code><br />
| Returns true if Kodi can suspend the system.<br />
|<br />
|-<br />
| <code>System.CanHibernate</code><br />
| Returns true if Kodi can hibernate the system.<br />
|<br />
|-<br />
| <code>System.HasHiddenInput</code><br />
| Return true when to osd keyboard/numeric dialog requests a password/pincode.<br />
|<br />
|-<br />
| <code>System.CanReboot</code><br />
| Returns true if Kodi can reboot the system.<br />
|<br />
|-<br />
| <code>System.ScreenSaverActive</code><br />
| Returns true if ScreenSaver is active.<br />
|<br />
|-<br />
| <code>System.Setting(hidewatched)</code><br />
| Returns true if 'hide watched items' is selected.<br />
|<br />
|-<br />
| <code>System.IsInhibit</code><br />
| Returns true when shutdown on idle is disabled.<br />
|<br />
|-<br />
| <code>System.HasShutdown</code><br />
| Returns true when shutdown on idle is enabled.<br />
|<br />
|-<br />
| <code>System.HasCMS</code><br />
| Returns true if colour management is supported in Kodi.<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== Visualisation ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Visualisation.Enabled</code><br />
| Returns true if any visualisation has been set in settings (so not None).<br />
|<br />
|-<br />
| <code>Visualisation.HasPresets</code><br />
| Returns true if the visualisation has built in presets.<br />
|<br />
|-<br />
| <code>Visualisation.Locked</code><br />
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)<br />
|<br />
|}<br />
<br />
=== Weather ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Weather.IsFetched</code><br />
| Returns true if the weather data has been downloaded.<br />
|<br />
|}<br />
<br />
=== Window ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Window.IsVisible(window)</code><br />
| Returns true if the window is visible (includes fade out time on dialogs)<br />
|<br />
|-<br />
| <code>Window.IsActive(window)</code><br />
| 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]]<br />
|<br />
|-<br />
| <code>Window.IsTopMost(window)</code><br />
| 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]]<br />
|<br />
|-<br />
| <code>Window.IsMedia</code><br />
| Returns true if this window is a media window (programs, music, video, scripts, pictures)<br />
|<br />
|-<br />
| <code>Window.Next(window)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>Window.Previous(window)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>Window.Property(IsRadio)</code><br />
| Returns true if the window is a radio window (for use in the PVR windows)<br />
|-<br />
| <code>Window.Is(name)</code><br />
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible<br />
| v17 addition<br />
|}<br />
<section end="main content" /><br />
<br />
<br />
== See also ==<br />
'''Development:'''<br />
* [[Add-on development]]<br />
* [[Skinning]]<br />
<br />
[[Category:Skin development]]<br />
[[Category:Add-on development]]</div>Phil65https://kodi.wiki/index.php?title=List_of_boolean_conditions&diff=126848List of boolean conditions2016-12-22T03:45:36Z<p>Phil65: /* PVR */</p>
<hr />
<div>{{see also|Conditional Visibility}}<br />
<section begin="main content" /><br />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.<br />
<br />
=== ADSP ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>ADSP.IsActive</code><br />
| Returns true if dsp system is enabled<br />
| <br />
|-<br />
| <code>ADSP.HasModes</code><br />
| Returns true if one or more modes are present on any of the types<br />
| <br />
|-<br />
| <code>ADSP.HasInputResample</code><br />
| Returns true if on stream is a input resample is active<br />
| <br />
|-<br />
| <code>ADSP.HasPreProcess</code><br />
| Returns true if on stream is a pre process mode active<br />
| <br />
|-<br />
| <code>ADSP.HasMasterProcess</code><br />
| Returns true if on stream is a master process mode available<br />
| <br />
|-<br />
| <code>ADSP.HasPostProcess</code><br />
| Returns true if on stream is a post process<br />
| <br />
|-<br />
| <code>ADSP.HasOutputResample</code><br />
| Returns true if on stream is a output resample<br />
| <br />
|-<br />
| <code>ADSP.MasterActive</code><br />
| Returns true if on stream is a master mode selected and active<br />
| <br />
|}<br />
<br />
=== Container ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Container.HasThumb</code><br />
| Returns true if the current container you are in has a thumb assigned to it<br />
| <br />
|-<br />
| <code>Container.Content(parameter)</code><br />
| Returns true if the current container you are in contains the following: '''files, songs, artists, albums, movies, tvshows, seasons, episodes, musicvideos, genres, years, actors, playlists, plugins, studios, directors, sets, tags, countries, roles, images''' (Note: these currently only work in the Video and Music Library or unless a Plugin has set the value) also available are '''Addons''' true when a list of add-ons is shown '''LiveTV''' true when a htsp (tvheadend) directory is shown<br />
|<br />
|-<br />
| <code>Container(id).OnNext</code><br />
| Returns true if the container with id (or current container if id is omitted) is moving to the next item. Allows views to be custom-designed (such as 3D coverviews etc.)<br />
|<br />
|-<br />
| <code>Container(id).OnScrollNext</code><br />
| Returns true if the container with id (or current container if id is omitted) is scrolling to the next item. Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.<br />
|<br />
|-<br />
| <code>Container(id).OnPrevious</code><br />
| Returns true if the container with id (or current container if id is omitted) is moving to the previous item. Allows views to be custom-designed (such as 3D coverviews etc.)<br />
|<br />
|-<br />
| <code>Container(id).OnScrollPrevious</code><br />
| Returns true if the container with id (or current container if id is omitted) is scrolling to the previous item. Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.<br />
|<br />
|-<br />
| <code>Container(id).HasFocus(item_number)</code><br />
| Returns true if the container with id (or current container if id is omitted) has static content and is focused on the item with id item_number.<br />
|<br />
|-<br />
| <code>Container(id).HasFiles</code><br />
| Returns true if the container contains files (or current container if id is omitted).<br />
|<br />
|-<br />
| <code>Container(id).HasFolders</code><br />
| Returns true if the container contains folders (or current container if id is omitted).<br />
|<br />
|-<br />
| <code>Container(id).HasNext</code><br />
| Returns true if the container or textbox with id (id) has a next page.<br />
|<br />
|-<br />
| <code>Container(id).HasPrevious</code><br />
| Returns true if the container or textbox with id (id) has a previous page.<br />
|<br />
|-<br />
| <code>Container(id).IsUpdating</code><br />
| Returns true if the container with [[Dynamic List Content|dynamic list content]] is currently updating.<br />
|<br />
|-<br />
| <code>Container(id).IsStacked</code><br />
| Returns true if the container is currently in stacked mode (or current container if id is omitted).<br />
|<br />
|-<br />
| <code>Container.CanFilter</code><br />
| Returns true when the current container can be filtered.<br />
|<br />
|-<br />
| <code>Container.CanFilterAdvanced</code><br />
| Returns true when advanced filtering can be applied to the current container.<br />
|<br />
|-<br />
| <code>Container.Filtered</code><br />
| Returns true when a mediafilter is applied to the current container.<br />
|<br />
|-<br />
| <code>Container.HasParent</code><br />
| Return true when the container contains a parent ('..') item.<br />
|<br />
|-<br />
| <code>Container.SortDirection(ascending)</code><br />
| Returns true the sort direction of a container is ascending.<br />
|<br />
|-<br />
| <code>Container.SortDirection(descending)</code><br />
| Returns true the sort direction of a container is descending.<br />
|<br />
|-<br />
| <code>Container(id).Row(row)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.<br />
|<br />
|-<br />
| <code>Container(id).Column(col)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.<br />
|<br />
|-<br />
| <code>Container(id).Position(pos)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.<br />
|<br />
|-<br />
| <code>Container(id).Scrolling</code><br />
| Returns true if the user is currently scrolling through the container with id (or current container if id is omitted). Note that this is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.<br />
|<br />
|}<br />
<br />
=== Control ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Control.IsEnabled(id)</code><br />
| Returns true if the control with id "id" is enabled.<br />
|<br />
|-<br />
| <code>Control.IsVisible(id)</code><br />
| Returns true if the control with id "id" is visible.<br />
|<br />
|-<br />
| <code>Control.HasFocus(id)</code><br />
| Returns true if the currently focused control has id "id".<br />
|<br />
|-<br />
| <code>ControlGroup(group).HasFocus(id)</code><br />
| Returns true if the control group with id “group” has control id “id” as it's focused item. 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”. Note that 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 />
|<br />
|}<br />
<br />
=== Integer ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number.<br />Example: Integer.IsEqual(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number.<br />Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsLess([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number.<br />Example: Integer.IsLess(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== Library ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Library.HasContent(string)</code><br />
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)<br />
|<br />
|-<br />
| <code>Library.IsScanningMusic</code><br />
| Returns true if the music library is being updated<br />
|<br />
|-<br />
| <code>Library.IsScanningVideo</code><br />
| Returns true if the video library is being updated<br />
|<br />
|-<br />
| <code>Library.HasContent(Role, Composer)</code><br />
| 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<br />
| v17 addition<br />
|}<br />
<br />
=== ListItem ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>ListItem.IsFolder</code><br />
| Returns whether the current ListItem is a folder<br />
|<br />
|-<br />
| <code>ListItem.IsPlaying</code><br />
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media<br />
|<br />
|-<br />
| <code>ListItem.IsResumable</code><br />
| Returns true when the current ListItem has been partially played<br />
|<br />
|-<br />
| <code>ListItem.IsCollection</code><br />
| Returns true when the current ListItem is a movie set<br />
|<br />
|-<br />
| <code>ListItem.IsSelected</code><br />
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)<br />
|<br />
|-<br />
| <code>ListItem.HasEpg</code><br />
| Returns true when the selected programme has epg info (PVR)<br />
|<br />
|-<br />
| <code>ListItem.HasTimer</code><br />
| Returns true when a recording timer has been set for the selected programme (PVR)<br />
|<br />
|-<br />
| <code>ListItem.IsRecording</code><br />
| Returns true when the selected programme is being recorded (PVR)<br />
|<br />
|-<br />
| <code>ListItem.IsEncrypted</code><br />
| Returns true when the selected programme is encrypted (PVR)<br />
|<br />
|-<br />
| <code>ListItem.IsStereoscopic</code><br />
| Returns true when the selected video is a 3D (stereoscopic) video<br />
|<br />
|-<br />
| <code>ListItem.Property(IsSpecial)</code><br />
| Returns whether the current Season/Episode is a Special<br />
|<br />
|-<br />
| <code>ListItem.Property(DateLabel)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>ListItem.Property(Addon.IsEnabled)</code><br />
| Returns true when the selected addon is enabled (for use in the addon info dialog only).<br />
|<br />
|-<br />
| <code>ListItem.Property(Addon.IsInstalled)</code><br />
| Returns true when the selected addon is installed (for use in the addon info dialog only).<br />
|<br />
|-<br />
| <code>ListItem.Property(Addon.HasUpdate)</code><br />
| Returns true when there's an update available for the selected addon.<br />
|<br />
|-<br />
| ListItem.HasTimerSchedule<br />
| Whether the item is part of a repeating timer schedule (PVR).<br />
| v16 addition<br />
|-<br />
| ListItem.TimerHasError<br />
| Whether the item has a timer and it won't be recorded because of an error (PVR).<br />
| v17 addition<br />
|-<br />
| ListItem.TimerHasConflict<br />
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).<br />
| v17 addition<br />
|-<br />
| ListItem.TimerIsActive<br />
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). <br />
| v17 addition<br />
|-<br />
| <code>ListItem.Property(Addon.Orphaned)</code><br />
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)<br />
| v17 addition<br />
|-<br />
| <code>ListItem.IsParentFolder</code><br />
| Returns true is the slected item is the 'up' item<br />
| v17 addition<br />
|}<br />
<br />
=== Player ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Player.HasMedia</code><br />
| Returns true if the player has an audio or video file.<br />
|<br />
|-<br />
| <code>Player.HasAudio</code><br />
| Returns true if the player has an audio file.<br />
|<br />
|-<br />
| <code>Player.HasDuration</code><br />
| Returns true if Media isn't a true stream<br />
|<br />
|-<br />
| <code>Player.HasVideo</code><br />
| Returns true if the player has a video file.<br />
|<br />
|-<br />
| <code>Player.Passthrough</code><br />
| Returns true if the player is using audio passthrough.<br />
|<br />
|-<br />
| <code>Player.Playing</code><br />
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)<br />
|<br />
|-<br />
| <code>Player.Paused</code><br />
| Returns true if the player is paused.<br />
|<br />
|-<br />
| <code>Player.Forwarding</code><br />
| Returns true if the player is fast forwarding.<br />
|<br />
|-<br />
| <code>Player.Forwarding2x</code><br />
| Returns true if the player is fast forwarding at 2x.<br />
|<br />
|-<br />
| <code>Player.Forwarding4x</code><br />
| Returns true if the player is fast forwarding at 4x.<br />
|<br />
|-<br />
| <code>Player.Forwarding8x</code><br />
| Returns true if the player is fast forwarding at 8x.<br />
|<br />
|-<br />
| <code>Player.Forwarding16x</code><br />
| Returns true if the player is fast forwarding at 16x.<br />
|<br />
|-<br />
| <code>Player.Forwarding32x</code><br />
| Returns true if the player is fast forwarding at 32x.<br />
|<br />
|-<br />
| <code>Player.Rewinding</code><br />
| Returns true if the player is rewinding.<br />
|<br />
|-<br />
| <code>Player.Rewinding2x</code><br />
| Returns true if the player is rewinding at 2x.<br />
|<br />
|-<br />
| <code>Player.Rewinding4x</code><br />
| Returns true if the player is rewinding at 4x.<br />
|<br />
|-<br />
| <code>Player.Rewinding8x</code><br />
| Returns true if the player is rewinding at 8x.<br />
|<br />
|-<br />
| <code>Player.Rewinding16x</code><br />
| Returns true if the player is rewinding at 16x.<br />
|<br />
|-<br />
| <code>Player.Rewinding32x</code><br />
| Returns true if the player is rewinding at 32x.<br />
|<br />
|-<br />
| <code>Player.CanRecord</code><br />
| Returns true if the player can record the current internet stream.<br />
|<br />
|-<br />
| <code>Player.Recording</code><br />
| Returns true if the player is recording the current internet stream.<br />
|<br />
|-<br />
| <code>Player.Caching</code><br />
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).<br />
|<br />
|-<br />
| <code>Player.DisplayAfterSeek</code><br />
| Returns true for the first 2.5 seconds after a seek.<br />
|<br />
|-<br />
| <code>Player.Seeking</code><br />
| Returns true if a seek is in progress<br />
|<br />
|-<br />
| <code>Player.ShowTime</code><br />
| Returns true if the user has requested the time to show (occurs in video fullscreen)<br />
|<br />
|-<br />
| <code>Player.ShowInfo</code><br />
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)<br />
|<br />
|-<br />
| <code>Player.IsInternetStream</code><br />
| Returns true if the player is playing an internet stream.<br />
|<br />
|-<br />
| <code>Player.Muted</code><br />
| Returns true if the volume is muted.<br />
|<br />
|-<br />
| <code>Player.Process(videohwdecoder)</code><br />
| Returns true if the currently playing video is decoded in hardware<br />
| v17 addition<br />
|-<br />
| <code>Player.TempoEnabled</code><br />
| Returns true if the current player supports changing the playback speed<br />
| v17 addition<br />
|-<br />
| <code>Player.IsTempo</code><br />
| Returns true if the current playbackspeed is not equal to 1<br />
| v17 addition<br />
|}<br />
<br />
==== MusicPlayer ====<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>MusicPlayer.HasNext</code><br />
| Returns true if the music player has a next song queued in the Playlist.<br />
|<br />
|-<br />
| <code>MusicPlayer.HasPrevious</code><br />
| Returns true if the music player has a a Previous Song in the Playlist .<br />
|<br />
|-<br />
| <code>MusicPlayer.Offset(number).Exists</code><br />
| Returns true if the music players playlist has a song queued in position (number).<br />
|<br />
|-<br />
| <code>MusicPartyMode.Enabled</code><br />
| Returns true if Party Mode is enabled<br />
|<br />
|}<br />
<br />
==== VideoPlayer ====<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>VideoPlayer.UsingOverlays</code><br />
| 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.<br />
|<br />
|-<br />
| <code>VideoPlayer.IsFullscreen</code><br />
| Returns true if the video player is in fullscreen mode.<br />
|<br />
|-<br />
| <code>VideoPlayer.HasMenu</code><br />
| Returns true if the video player has a menu (ie is playing a DVD)<br />
|<br />
|-<br />
| <code>VideoPlayer.HasInfo</code><br />
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)<br />
|<br />
|-<br />
| <code>VideoPlayer.Content(parameter)</code><br />
| 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<br />
|<br />
|-<br />
| <code>VideoPlayer.HasSubtitles</code><br />
| Returns true if there are subtitles available for video. (available for version 11.0 and above)<br />
|<br />
|-<br />
| <code>VideoPlayer.IsStereoscopic</code><br />
| Returns true when the currently playing video is a 3D (stereoscopic) video<br />
|<br />
|-<br />
| <code>VideoPlayer.SubtitlesEnabled</code><br />
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)<br />
|<br />
|-<br />
| <code>VideoPlayer.HasEpg</code><br />
| Returns true when epg information is available for the currently playing programme (PVR).<br />
|<br />
|}<br />
<br />
=== PlayList ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Playlist.IsRandom</code><br />
| Returns true if the player is in random mode.<br />
|<br />
|-<br />
| <code>Playlist.IsRepeat</code><br />
| Returns true if the player is in repeat all mode.<br />
|<br />
|-<br />
| <code>Playlist.IsRepeatOne</code><br />
| Returns true if the player is in repeat one mode.<br />
|<br />
|}<br />
<br />
=== PVR ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Pvr.HasTimer</code><br />
| Returns true when a recording timer is active.<br />
|<br />
|-<br />
| <code>Pvr.HasNonRecordingTimer</code><br />
| Returns true when a non recording timer is active.<br />
|<br />
|-<br />
| <code>Pvr.HasTVChannels</code><br />
| Returns true if there are tv channels available<br />
|<br />
|-<br />
| <code>Pvr.HasRadioChannels</code><br />
| Returns true if there are radio channels available<br />
|<br />
|-<br />
| <code>Pvr.IsPlayingTv</code><br />
| Returns true when live tv is being watched.<br />
|<br />
|-<br />
| <code>Pvr.IsPlayingRadio</code><br />
| Returns true when live radio is being listened to.<br />
|<br />
|-<br />
| <code>Pvr.IsPlayingRecording</code><br />
| Returns true when a recording is being watched.<br />
|<br />
|-<br />
| <code>Pvr.IsRecording</code><br />
| Returns true when the system is recording a tv programme.<br />
|<br />
|-<br />
| <code>Pvr.IsTimeShift</code><br />
| Returns true when the playback is timeshifted.<br />
|<br />
|-<br />
| <code>Pvr.ActStreamIsEncrypted</code><br />
| Returns true if the stream is encrypted<br />
|<br />
|-<br />
| Pvr.RadioNextRecordingChannelIcon<br />
| Icon of the next recording radio channel<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.IsRecordingTV<br />
| Returns true when the system is recording a tv programme.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasTVTimer<br />
| Returns true if at least one tv timer is active.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasNonRecordingTVTimer<br />
| Returns true if there are tv timers present who currently not do recording<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.IsRecordingRadio<br />
| Returns true when the system is recording a radio programme.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasRadioTimer<br />
| Returns true if at least one radio timer is active.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| Pvr.HasNonRecordingRadioTimer<br />
| Returns true if there are radio timers present who currently not do recording<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== RDS ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>RDS.HasRds</code><br />
| Returns true if RDS is present<br />
|<br />
|-<br />
| <code>RDS.HasRadioText</code><br />
| Returns true if RDS contains also Radiotext<br />
|<br />
|-<br />
| <code>RDS.HasRadioTextPlus</code><br />
| Returns true if RDS with Radiotext contains also the plus information<br />
|<br />
|-<br />
| <code>RDS.HasHotline</code><br />
| Returns true if a hotline phone number is present (Only be available on RadiotextPlus)<br />
|<br />
|-<br />
| <code>RDS.HasStudio</code><br />
| Returns true if a studio name is present (Only be available on RadiotextPlus)<br />
|<br />
|}<br />
<br />
=== Skin ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Skin.HasTheme(theme)</code><br />
| Returns true if the user has selected the theme with name ?theme?.<br />
|<br />
|-<br />
| <code>Skin.HasSetting(setting)</code><br />
| 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>.<br />
|<br />
|-<br />
| <code>Skin.String(string)</code><br />
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.<br />
|<br />
|-<br />
| <code>Skin.String(string1,string2)</code><br />
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.<br />
|<br />
|}<br />
<br />
=== SlideShow ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Slideshow.IsActive</code><br />
| Returns true if the picture slideshow is running<br />
|<br />
|-<br />
| <code>Slideshow.IsPaused</code><br />
| Returns true if the picture slideshow is paused<br />
|<br />
|-<br />
| <code>Slideshow.IsRandom</code><br />
| Returns true if the picture slideshow is in random mode<br />
|<br />
|-<br />
| <code>Slideshow.IsVideo</code><br />
| Returns true if the picture slideshow is playing a video<br />
|<br />
|}<br />
<br />
=== String ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>String.IsEmpty([[InfoLabels|info]])</code><br />
| 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.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.IsEqual([[InfoLabels|info]],string)</code><br />
| 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.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.StartsWith([[InfoLabels|info]],substring)</code><br />
| 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[]. Also note that in a panelview or similar this only works on the focused item.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.EndsWith([[InfoLabels|info]],substring)</code><br />
| 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[]. Also note that in a panelview or similar this only works on the focused item.<br />
| {{nowrap|v17 Addition}}<br />
|-<br />
| <code>String.Contains([[InfoLabels|info]],substring)</code><br />
| 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[]. Also note that in a panelview or similar this only works on the focused item.<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== System ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>System.HasAddon(id)</code><br />
| Returns true if the specified addon is installed on the system.<br />
|<br />
|-<br />
| <code>System.HasPVRAddon</code><br />
| Returns true if at least one PVR addon is installed on the system.<br />
|<br />
|-<br />
| <code>System.HasAlarm(alarm)</code><br />
| Returns true if the system has the ?alarm? alarm set.<br />
|<br />
|-<br />
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>System.HasNetwork</code><br />
| Returns true if the ethernet cable is plugged in.<br />
|<br />
|-<br />
| <code>System.HasMediadvd</code><br />
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.<br />
|<br />
|-<br />
| <code>System.IdleTime(time)</code><br />
| Returns true if Kodi has had no input for ?time? amount of seconds.<br />
|<br />
|-<br />
| <code>System.IsStandalone</code><br />
| Returns true if Kodi is running in standalone mode.<br />
|<br />
|-<br />
| <code>System.IsFullscreen</code><br />
| Returns true if Kodi is running fullscreen.<br />
|<br />
|-<br />
| <code>System.KaiConnected</code><br />
| Returns true if XBMC's Kai client is connected to the PC engine.<br />
|<br />
|-<br />
| <code>System.IsLoggedOn</code><br />
| Returns true if a user is currently logged on under a [[Profiles|profile]]<br />
|<br />
|-<br />
| <code>System.HasLoginScreen</code><br />
| Returns true if the [[Profiles|profile]] login screen is enabled<br />
|<br />
|-<br />
| <code>System.HasADSP</code><br />
| Returns true if ADSP is enabled<br />
|<br />
|-<br />
| <code>System.HasModalDialog</code><br />
| Returns true true if a modal dialog is visible<br />
|<br />
|-<br />
| <code>System.Time(startTime,endTime)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>System.Date(startDate,endDate)</code><br />
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.<br />
|<br />
|-<br />
| <code>System.Platform.Linux</code><br />
| Returns true if Kodi is running on a linux/unix based computer.<br />
|<br />
|-<br />
| <code>System.Platform.Linux.RaspberryPi</code><br />
| Returns true if Kodi is running on a Raspberry Pi.<br />
|<br />
|-<br />
| <code>System.Platform.Windows</code><br />
| Returns true if Kodi is running on a windows based computer.<br />
|<br />
|-<br />
| <code>System.Platform.OSX</code><br />
| Returns true if Kodi is running on an OSX based computer.<br />
|<br />
|-<br />
| <code>System.Platform.IOS</code><br />
| Returns true if Kodi is running on an IOS device.<br />
|<br />
|-<br />
| <code>System.Platform.Darwin</code><br />
| Returns true if Kodi is running on an OSX or IOS system.<br />
|<br />
|-<br />
| <code>System.Platform.ATV2</code><br />
| Returns true if Kodi is running on an atv2.<br />
|<br />
|-<br />
| <code>System.Platform.Android</code><br />
| Returns true if Kodi is running on an android device.<br />
|<br />
|-<br />
| <code>System.CanPowerDown</code><br />
| Returns true if Kodi can powerdown the system.<br />
|<br />
|-<br />
| <code>System.CanSuspend</code><br />
| Returns true if Kodi can suspend the system.<br />
|<br />
|-<br />
| <code>System.CanHibernate</code><br />
| Returns true if Kodi can hibernate the system.<br />
|<br />
|-<br />
| <code>System.HasHiddenInput</code><br />
| Return true when to osd keyboard/numeric dialog requests a password/pincode.<br />
|<br />
|-<br />
| <code>System.CanReboot</code><br />
| Returns true if Kodi can reboot the system.<br />
|<br />
|-<br />
| <code>System.ScreenSaverActive</code><br />
| Returns true if ScreenSaver is active.<br />
|<br />
|-<br />
| <code>System.Setting(hidewatched)</code><br />
| Returns true if 'hide watched items' is selected.<br />
|<br />
|-<br />
| <code>System.IsInhibit</code><br />
| Returns true when shutdown on idle is disabled.<br />
|<br />
|-<br />
| <code>System.HasShutdown</code><br />
| Returns true when shutdown on idle is enabled.<br />
|<br />
|-<br />
| <code>System.HasCMS</code><br />
| Returns true if colour management is supported in Kodi.<br />
| {{nowrap|v17 Addition}}<br />
|}<br />
<br />
=== Visualisation ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Visualisation.Enabled</code><br />
| Returns true if any visualisation has been set in settings (so not None).<br />
|<br />
|-<br />
| <code>Visualisation.HasPresets</code><br />
| Returns true if the visualisation has built in presets.<br />
|<br />
|-<br />
| <code>Visualisation.Locked</code><br />
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)<br />
|<br />
|}<br />
<br />
=== Weather ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Weather.IsFetched</code><br />
| Returns true if the weather data has been downloaded.<br />
|<br />
|}<br />
<br />
=== Window ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
! Version<br />
|-<br />
| <code>Window.IsVisible(window)</code><br />
| Returns true if the window is visible (includes fade out time on dialogs)<br />
|<br />
|-<br />
| <code>Window.IsActive(window)</code><br />
| 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]]<br />
|<br />
|-<br />
| <code>Window.IsTopMost(window)</code><br />
| 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]]<br />
|<br />
|-<br />
| <code>Window.IsMedia</code><br />
| Returns true if this window is a media window (programs, music, video, scripts, pictures)<br />
|<br />
|-<br />
| <code>Window.Next(window)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>Window.Previous(window)</code><br />
| 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.<br />
|<br />
|-<br />
| <code>Window.Property(IsRadio)</code><br />
| Returns true if the window is a radio window (for use in the PVR windows)<br />
|-<br />
| <code>Window.Is(name)</code><br />
| Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible<br />
| v17 addition<br />
|}<br />
<section end="main content" /><br />
<br />
<br />
== See also ==<br />
'''Development:'''<br />
* [[Add-on development]]<br />
* [[Skinning]]<br />
<br />
[[Category:Skin development]]<br />
[[Category:Add-on development]]</div>Phil65https://kodi.wiki/index.php?title=InfoLabels&diff=117592InfoLabels2016-03-18T02:44:13Z<p>Phil65: </p>
<hr />
<div>{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}<br />
<section begin="main content" /><br />
Skins can use infolabels with $INFO[infolabel] or the <info> tag. Scripts can read infolabels with <code>xbmc.getInfoLabel('infolabel')</code>.<br />
<br />
An up-to-date list can be found here [https://github.com/xbmc/xbmc/blob/master/xbmc/GUIInfoManager.cpp GUIInfoManager.cpp]<br />
<br />
=== ADSP ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| ADSP.ActiveStreamType<br />
| <br />
|-<br />
| ADSP.DetectedStreamType<br />
| <br />
|-<br />
| ADSP.MasterName<br />
| <br />
|-<br />
| ADSP.MasterInfo<br />
| <br />
|-<br />
| ADSP.MasterOwnIcon<br />
| <br />
|-<br />
| ADSP.MasterOverrideIcon<br />
| <br />
|}<br />
<br />
=== Container ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Container.Content<br />
| Shows content of the current container<br />
|-<br />
| Container.FolderPath<br />
| Shows complete path of currently displayed folder<br />
|-<br />
| Container.FolderName<br />
| Shows top most folder in currently displayed folder<br />
|-<br />
| Container.Viewmode<br />
| Returns the current viewmode (list, icons etc.)<br />
|-<br />
| Container.SortMethod<br />
| Returns the current sort method (name, year, rating, etc.)<br />
|-<br />
| Container.SortOrder<br />
| Returns the current sort order (Ascending/Descending)<br />
|-<br />
| Container.PluginName<br />
| Returns the current plugins base folder name<br />
|-<br />
| Container.PluginCategory<br />
| Returns the current plugins category (set by the scripter)<br />
|-<br />
| Container.ShowPlot<br />
| Returns the TV Show plot of the current container and can be used at season and episode level<br />
|-<br />
| Container.ShowTitle<br />
| Returns the TV Show title of the current container and can be used at season and episode level<br />
|-<br />
| Container(id).NumPages<br />
| Number of pages in the container with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).NumItems<br />
| Number of items in the container or grouplist with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).CurrentPage<br />
| Current page in the container with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).CurrentItem<br />
| Current item in the container or grouplist with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).Position<br />
| Returns the current focused position of container / grouplist (id) as a numeric label.<br />
|-<br />
| Container(id).Column<br />
| Returns the column number of the focused position in a panel container.<br />
|-<br />
| Container(id).Row<br />
| Returns the row number of the focused position in a panel container.<br />
|-<br />
| Container(id).Totaltime<br />
| Returns the total time of all items in the current container<br />
|-<br />
| Container(id).TotalWatched<br />
| Returns the number of watched items in the current container<br />
|-<br />
| Container(id).TotalUnWatched<br />
| Returns the number of unwatched items in the current container<br />
|-<br />
| Container(id).ListItem(offset).Label<br />
| Shows ListItem.Label for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(2).Label )''<br />
|-<br />
| Container(id).ListItem(offset).Label2<br />
| Shows ListItem.Label2 for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(-2).Label2 )''<br />
|-<br />
| Container(id).ListItem(offset).Icon<br />
| Shows ListItem.Icon for a specific List or Panel Container with a offset ''( eg: Container(52).Listitem(1).Icon)''<br />
|-<br />
| Container(id).ListItem(offset).ActualIcon<br />
| Shows ListItem.ActualIcon for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).ActualIcon )''<br />
|-<br />
| Container(id).ListItem(offset).Thumb<br />
| Shows ListItem.Thumb for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).Thumb )''<br />
|-<br />
| Container(id).ListItemNoWrap(offset).Property<br />
| Basically returns the same as ListItem(offset) but it won't wrap. That means if the last item of a list is focused, ListItemNoWrap(1) will be empty while ListItem(1) will return the first item of the list. ''Property'' has to be replaced with Label, Label2, Icon etc. ''( eg: Container(50).ListitemNoWrap(1).Plot )''<br />
|-<br />
| Container(id).ListItemPosition(id).[infolabel]<br />
| Shows the infolabel for an item in a Container. the item id is the position in the container relative to the cursor position. ''( eg: Container(50).ListItemPosition(4).Genre )''<br />
|-<br />
| Container(id).ListItemAbsolute(id).[infolabel]<br />
| Shows the infolabel for an item in a Container. the item id is the absolute position in the container. ''( eg: Container(50).ListItemAbsolute(4).Genre )''<br />
|-<br />
| Container.Property(addoncategory)<br />
| Returns the current add-on category<br />
|-<br />
| Container.Property(reponame)<br />
| Returns the current add-on repository name<br />
|}<br />
<br />
=== Control ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Control.GetLabel(id)[.index()]<br />
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.<br />
|}<br />
<br />
=== Fanart ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Fanart.Color1<br />
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.<br />
|-<br />
| Fanart.Color2<br />
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.<br />
|-<br />
| Fanart.Color3<br />
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.<br />
|}<br />
<br />
=== ListItem ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| ListItem.Label<br />
| Shows the left label of the currently selected item in a container<br />
|-<br />
| ListItem.Label2<br />
| Shows the right label of the currently selected item in a container<br />
|-<br />
| ListItem.Title<br />
| Shows the title of the currently selected song or movie in a container<br />
|-<br />
| ListItem.OriginalTitle<br />
| Shows the original title of the currently selected movie in a container<br />
|-<br />
| ListItem.SortLetter<br />
| Shows the first letter of the current file in a container<br />
|-<br />
| ListItem.TrackNumber<br />
| Shows the track number of the currently selected song in a container<br />
|-<br />
| ListItem.Artist<br />
| Shows the artist of the currently selected song in a container<br />
|-<br />
| ListItem.AlbumArtist<br />
| Shows the artist of the currently selected album in a list<br />
|-<br />
| ListItem.Property(Artist_Born)<br />
| Date of Birth of the currently selected Artist<br />
|-<br />
| ListItem.Property(Artist_Died)<br />
| Date of Death of the currently selected Artist<br />
|-<br />
| ListItem.Property(Artist_Formed)<br />
| Formation date of the currently selected Band<br />
|-<br />
| ListItem.Property(Artist_Disbanded)<br />
| Disbanding date of the currently selected Band<br />
|-<br />
| ListItem.Property(Artist_YearsActive)<br />
| Years the currently selected artist has been active<br />
|-<br />
| ListItem.Property(Artist_Instrument)<br />
| Instruments played by the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Description)<br />
| Shows a biography of the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Mood)<br />
| Shows the moods of the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Style)<br />
| Shows the styles of the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Genre)<br />
| Shows the genre of the currently selected artist<br />
|-<br />
| ListItem.Album<br />
| Shows the album of the currently selected song in a container<br />
|-<br />
| ListItem.Property(Album_Mood)<br />
| Shows the moods of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Style)<br />
| Shows the styles of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Theme)<br />
| Shows the themes of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Type)<br />
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Label)<br />
| Shows the record label of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Description)<br />
| Shows a review of the currently selected Album<br />
|-<br />
| ListItem.DiscNumber<br />
| Shows the disc number of the currently selected song in a container<br />
|-<br />
| ListItem.Year<br />
| Shows the year of the currently selected song, album or movie in a container<br />
|-<br />
| ListItem.Premiered<br />
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container<br />
|-<br />
| ListItem.Genre<br />
| Shows the genre of the currently selected song, album or movie in a container<br />
|-<br />
| ListItem.Director<br />
| Shows the director of the currently selected movie in a container<br />
|-<br />
| ListItem.Country<br />
| Shows the production country of the currently selected movie in a container<br />
|-<br />
| ListItem.Episode<br />
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.<br />
|-<br />
| ListItem.Season<br />
| Shows the season value for the currently selected tvshow<br />
|-<br />
| ListItem.TVShowTitle<br />
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library<br />
|-<br />
| ListItem.Property(TotalSeasons)<br />
| Shows the total number of seasons for the currently selected tvshow<br />
|-<br />
| ListItem.Property(TotalEpisodes)<br />
| Shows the total number of episodes for the currently selected tvshow or season<br />
|-<br />
| ListItem.Property(WatchedEpisodes)<br />
| Shows the number of watched episodes for the currently selected tvshow or season<br />
|-<br />
| ListItem.Property(UnWatchedEpisodes)<br />
| Shows the number of unwatched episodes for the currently selected tvshow or season<br />
|-<br />
| ListItem.Property(NumEpisodes)<br />
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.<br />
|-<br />
| ListItem.PictureAperture<br />
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).<br />
|-<br />
| ListItem.PictureAuthor<br />
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).<br />
|-<br />
| ListItem.PictureByline<br />
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).<br />
|-<br />
| ListItem.PictureBylineTitle<br />
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).<br />
|-<br />
| ListItem.PictureCamMake<br />
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).<br />
|-<br />
| ListItem.PictureCamModel<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureCaption<br />
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).<br />
|-<br />
| ListItem.PictureCategory<br />
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).<br />
|-<br />
| ListItem.PictureCCDWidth<br />
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).<br />
|-<br />
| ListItem.PictureCity<br />
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).<br />
|-<br />
| ListItem.PictureColour<br />
| Shows whether the selected picture is "Colour" or "Black and White".<br />
|-<br />
| ListItem.PictureComment<br />
| Shows a 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.<br />
|-<br />
| ListItem.PictureCopyrightNotice<br />
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).<br />
|-<br />
| ListItem.PictureCountry<br />
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).<br />
|-<br />
| ListItem.PictureCountryCode<br />
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).<br />
|-<br />
| ListItem.PictureCredit<br />
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).<br />
|-<br />
| ListItem.PictureDate<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureDatetime<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureDesc<br />
| Shows a 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).<br />
|-<br />
| ListItem.PictureDigitalZoom<br />
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).<br />
|-<br />
| ListItem.PictureExpMode<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureExposure<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureExposureBias<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureExpTime<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureFlashUsed<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureFocalLen<br />
| Shows the lens focal length of the selected picture<br />
|-<br />
| ListItem.PictureFocusDist<br />
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).<br />
|-<br />
| ListItem.PictureGPSLat<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureGPSLon<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureGPSAlt<br />
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.<br />
|-<br />
| ListItem.PictureHeadline<br />
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).<br />
|-<br />
| ListItem.PictureImageType<br />
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).<br />
|-<br />
| ListItem.PictureIPTCDate<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureIPTCTime<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureISO<br />
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).<br />
|-<br />
| ListItem.PictureKeywords<br />
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).<br />
|-<br />
| ListItem.PictureLightSource<br />
| 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).<br />
|-<br />
| ListItem.PictureLongDate<br />
| Shows only 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.<br />
|-<br />
| ListItem.PictureLongDatetime<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureMeteringMode<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureObjectName<br />
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).<br />
|-<br />
| ListItem.PictureOrientation<br />
| Shows 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).<br />
|- <br />
| ListItem.PicturePath<br />
| Shows the filename and path of the selected picture<br />
|-<br />
| ListItem.PictureProcess<br />
| Shows the process used to compress the selected picture<br />
|-<br />
| ListItem.PictureReferenceService<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureResolution<br />
| Shows the dimensions of the selected picture<br />
|-<br />
| ListItem.PictureSource<br />
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).<br />
|-<br />
| ListItem.PictureSpecialInstructions<br />
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).<br />
|-<br />
| ListItem.PictureState<br />
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).<br />
|-<br />
| ListItem.PictureSublocation<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureSupplementalCategories<br />
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).<br />
|-<br />
| ListItem.PictureTransmissionReference<br />
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).<br />
|-<br />
| ListItem.PictureUrgency<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureWhiteBalance<br />
| Shows 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).<br />
|-<br />
| ListItem.FileName<br />
| Shows the filename of the currently selected song or movie in a container<br />
|-<br />
| ListItem.Path<br />
| Shows the complete path of the currently selected song or movie in a container<br />
|-<br />
| ListItem.FolderName<br />
| Shows top most folder of the path of the currently selected song or movie in a container<br />
|-<br />
| ListItem.FolderPath<br />
| Shows the complete path of the currently selected song or movie in a container (without user details).<br />
|-<br />
| ListItem.FileNameAndPath<br />
| Shows the full path with filename of the currently selected song or movie in a container<br />
|-<br />
| ListItem.FileExtension<br />
| Shows the file extension (without leading dot) of the currently selected item in a container<br />
|-<br />
| ListItem.Date<br />
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)<br />
|-<br />
| ListItem.DateAdded<br />
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.<br />
|-<br />
| ListItem.Size<br />
| Shows the file size of the currently selected song or movie in a container<br />
|-<br />
| ListItem.Rating<br />
| Shows the IMDB rating of the currently selected movie in a container<br />
|-<br />
| ListItem.Set<br />
| Shows the name of the set the movie is part of<br />
|-<br />
| ListItem.SetId<br />
| Shows the id of the set the movie is part of<br />
|-<br />
| ListItem.UserRating<br />
| Shows the user rating of the currently selected item in a container<br />
|-<br />
| ListItem.Votes<br />
| Shows the IMDB votes of the currently selected movie in a container<br />
|-<br />
| ListItem.RatingAndVotes<br />
| Shows the IMDB rating and votes of the currently selected movie in a container<br />
|-<br />
| ListItem.Mpaa<br />
| Show the MPAA rating of the currently selected movie in a container<br />
|-<br />
| ListItem.ProgramCount<br />
| Shows the number of times an xbe has been run from "my programs"<br />
|-<br />
| ListItem.Duration<br />
| Shows the song or movie duration of the currently selected movie in a container<br />
|-<br />
| ListItem.DBTYPE<br />
| Shows the database type of the ListItem.DBID for videos (movie, set, genre, actor, tvshow, season, episode). It does not return any value for the music library. Beware 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.<br />
|-<br />
| ListItem.DBID<br />
| Shows the database id of the currently selected listitem in a container<br />
|-<br />
| ListItem.Cast<br />
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml<br />
|-<br />
| ListItem.CastAndRole<br />
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml<br />
|-<br />
| ListItem.Studio<br />
| Studio of current selected Music Video in a container<br />
|-<br />
| ListItem.Top250<br />
| Shows the IMDb top250 position of the currently selected listitem in a container.<br />
|-<br />
| ListItem.Trailer<br />
| Shows the full trailer path with filename of the currently selected movie in a container<br />
|-<br />
| ListItem.Writer<br />
| Name of Writer of current Video in a container<br />
|-<br />
| ListItem.Tagline<br />
| Small Summary of current Video in a container<br />
|-<br />
| ListItem.PlotOutline<br />
| Small Summary of current Video in a container<br />
|-<br />
| ListItem.Plot<br />
| Complete Text Summary of Video in a container<br />
|-<br />
| ListItem.IMDBNumber<br />
| The IMDB iD of the selected Video in a container<br />
|-<br />
| ListItem.EpisodeName<br />
| (PVR only) The name of the episode if the selected EPG item is a TV Show<br />
|-<br />
| ListItem.PercentPlayed<br />
| Returns percentage value [0-100] of how far the selected video has been played<br />
|-<br />
| ListItem.LastPlayed<br />
| Last play date of Video in a container<br />
|-<br />
| ListItem.PlayCount<br />
| Playcount of Video in a container<br />
|-<br />
| ListItem.StartTime<br />
| Start time of current selected TV programme in a container<br />
|-<br />
| ListItem.EndTime<br />
| End time of current selected TV programme in a container<br />
|-<br />
| ListItem.StartDate<br />
| Start date of current selected TV programme in a container<br />
|-<br />
| ListItem.ChannelNumber<br />
| Number of current selected TV channel in a container<br />
|-<br />
| ListItem.ChannelName<br />
| Name of current selected TV channel in a container<br />
|-<br />
| ListItem.VideoCodec<br />
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)<br />
|-<br />
| ListItem.VideoResolution<br />
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.<br />
|-<br />
| ListItem.VideoAspect<br />
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)<br />
|-<br />
| ListItem.AudioCodec<br />
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)<br />
|-<br />
| ListItem.AudioChannels<br />
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 8, 10)<br />
|-<br />
| ListItem.AudioLanguage<br />
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)<br />
|-<br />
| ListItem.SubtitleLanguage<br />
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)<br />
|-<br />
| ListItem.Property(AudioCodec.[n])<br />
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)<br />
|-<br />
| ListItem.Property(AudioChannels.[n])<br />
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)<br />
|-<br />
| ListItem.Property(AudioLanguage.[n])<br />
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)<br />
|-<br />
| ListItem.Property(SubtitleLanguage.[n])<br />
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)<br />
|-<br />
| ListItem.Property(Addon.Name)<br />
| Shows the name of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Version)<br />
| Shows the version of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Summary)<br />
| Shows a short description of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Description)<br />
| Shows the full description of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Type)<br />
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Creator)<br />
| Shows the name of the author the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Disclaimer)<br />
| Shows the disclaimer of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Changelog)<br />
| Shows the changelog of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.ID)<br />
| Shows the identifier of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Status)<br />
| Shows the status of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Broken)<br />
| Shows a message when the addon is marked as broken in the repo<br />
|-<br />
| ListItem.Property(Addon.Path)<br />
| Shows the path of the currently selected addon<br />
|-<br />
| ListItem.StartTime<br />
| Start time of the selected item (PVR).<br />
|-<br />
| ListItem.EndTime<br />
| End time of the selected item (PVR).<br />
|-<br />
| ListItem.StartDate<br />
| Start date of the selected item (PVR).<br />
|-<br />
| ListItem.EndDate<br />
| End date of the selected item (PVR).<br />
|-<br />
| ListItem.NextTitle<br />
| Title of the next item (PVR).<br />
|-<br />
| ListItem.NextGenre<br />
| Genre of the next item (PVR).<br />
|-<br />
| ListItem.NextPlot<br />
| Plot of the next item (PVR).<br />
|-<br />
| ListItem.NextPlotOutline<br />
| Plot outline of the next item (PVR).<br />
|-<br />
| ListItem.NextStartTime<br />
| Start time of the next item (PVR).<br />
|-<br />
| ListItem.NextEndTime<br />
| End of the next item (PVR).<br />
|-<br />
| ListItem.NextStartDate<br />
| Start date of the next item (PVR).<br />
|-<br />
| ListItem.NextEndDate<br />
| End date of the next item (PVR).<br />
|-<br />
| ListItem.ChannelName<br />
| Channelname of the selected item (PVR).<br />
|-<br />
| ListItem.ChannelNumber<br />
| Channel number of the selected item (PVR).<br />
|-<br />
| ListItem.ChannelGroup<br />
| Channel group of the selected item (PVR).<br />
|-<br />
| ListItem.SubChannelNumber<br />
| Subchannel number of the currently selected channel that's currently playing (PVR).<br />
|-<br />
| ListItem.ChannelNumberLabel<br />
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).<br />
|-<br />
| ListItem.Progress<br />
| Part of the programme that's been played (PVR).<br />
|-<br />
| ListItem.StereoscopicMode<br />
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)<br />
|-<br />
| ListItem.IsSelected<br />
| Whether the item is selected.<br />
|-<br />
| ListItem.IsPlaying<br />
| Whether the item is playing.<br />
|-<br />
| ListItem.IsResumable<br />
| Whether the item has a resume point set.<br />
|-<br />
| ListItem.IsFolder<br />
| Whether the item is a folder.<br />
|-<br />
| ListItem.IsCollection<br />
| Whether the item is a movie collection.<br />
|-<br />
| ListItem.IsRecording<br />
| Whether the item is a recording (PVR).<br />
|-<br />
| ListItem.HasTimer<br />
| Whether the item has a timer, not depending on it's state (PVR).<br />
|-<br />
| ListItem.HasTimerSchedule<br />
| Whether the item is part of a repeating timer schedule (PVR). (v16 addition)<br />
|-<br />
| ListItem.TimerHasError<br />
| Whether the item has a timer and it won't be recorded because of an error (PVR). (v17 addition)<br />
|-<br />
| ListItem.TimerHasConflict<br />
| Whether the item has a timer and it won't be recorded because of a conflict (PVR). (v17 addition)<br />
|-<br />
| ListItem.TimerIsActive<br />
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). (v17 addition)<br />
|-<br />
| ListItem.Comment<br />
| Comment assigned to the item (PVR/MUSIC).<br />
|}<br />
<br />
=== Musicpartymode labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| MusicPartyMode.SongsPlayed<br />
| Number of songs played during Party Mode<br />
|-<br />
| MusicPartyMode.MatchingSongs<br />
| Number of songs available to Party Mode<br />
|-<br />
| MusicPartyMode.MatchingSongsPicked<br />
| Number of songs picked already for Party Mode<br />
|-<br />
| MusicPartyMode.MatchingSongsLeft<br />
| Number of songs left to be picked from for Party Mode<br />
|-<br />
| MusicPartyMode.RelaxedSongsPicked<br />
| Not currently used<br />
|-<br />
| MusicPartyMode.RandomSongsPicked<br />
| Number of unique random songs picked during Party Mode<br />
|}<br />
<br />
=== Network labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Network.IsDHCP<br />
| Network type is DHCP or FIXED<br />
|-<br />
| Network.IPAddress<br />
| The system's IP Address (formatted as IP: <ipaddress>)<br />
|-<br />
| Network.LinkState<br />
| Network linkstate e.g. 10mbit/100mbit etc.<br />
|-<br />
| Network.MacAddress<br />
| The system's mac address<br />
|-<br />
| Network.SubnetMask<br />
| Network subnet mask<br />
|-<br />
| Network.GatewayAddress<br />
| Network gateway address<br />
|-<br />
| Network.DNS1Address<br />
| Network dns 1 address<br />
|-<br />
| Network.DNS2Address<br />
| Network dns 2 address<br />
|-<br />
| Network.DHCPAddress<br />
| DHCP ip address<br />
|}<br />
<br />
=== Player labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Player.FinishTime<br />
| Time playing media will end<br />
|-<br />
| Player.FinishTime(format)<br />
| 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).<br />
|-<br />
| Player.Chapter<br />
| Current chapter of current playing media<br />
|-<br />
| Player.ChapterCount<br />
| Total number of chapters of current playing media<br />
|-<br />
| Player.Time<br />
| Elapsed time of current playing media<br />
|-<br />
| Player.Time(format)<br />
| 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).<br />
|-<br />
| Player.TimeRemaining<br />
| Remaining time of current playing media<br />
|-<br />
| Player.TimeRemaining(format)<br />
| 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).<br />
|-<br />
| Player.Duration<br />
| Total duration of the current playing media<br />
|-<br />
| Player.Duration(format)<br />
| 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).<br />
|-<br />
| Player.SeekTime<br />
| Time to which the user is seeking<br />
|-<br />
| Player.SeekOffset<br />
| Indicates the seek offset after a seek press (eg user presses BigStepForward, player.seekoffset returns +10:00)<br />
|-<br />
| Player.SeekOffset(format)<br />
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).<br />
|-<br />
| Player.SeekStepSize<br />
| Displays the seek step size. (v15 addition)<br />
|-<br />
| Player.ProgressCache<br />
| Shows how much of the file is cached above current play percentage<br />
|-<br />
| Player.Folderpath<br />
| Shows the full path of the currently playing song or movie<br />
|-<br />
| Player.Filenameandpath<br />
| Shows the full path with filename of the currently playing song or movie<br />
|-<br />
| Player.StartTime<br />
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.<br />
|-<br />
| Player.StartTime(format)<br />
| 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).<br />
|-<br />
| Player.Title<br />
| Returns the musicplayer title for audio and the videoplayer title for videos.<br />
|-<br />
| Player.Filename<br />
| Returns the filename of the currently playing media.<br />
|}<br />
<br />
==== Music player ====<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| MusicPlayer.Title<br />
| 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<br />
|-<br />
| MusicPlayer.Album<br />
| 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<br />
|-<br />
| MusicPlayer.Property(Album_Mood)<br />
| Shows the moods of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Style)<br />
| Shows the styles of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Theme)<br />
| Shows the themes of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Type)<br />
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Label)<br />
| Shows the record label of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Description)<br />
| Shows a review of the currently playing Album<br />
|-<br />
| MusicPlayer.Artist<br />
| 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<br />
|-<br />
| MusicPlayer.Property(Artist_Born)<br />
| Date of Birth of the currently playing Artist<br />
|-<br />
| MusicPlayer.Property(Artist_Died)<br />
| Date of Death of the currently playing Artist<br />
|-<br />
| MusicPlayer.Property(Artist_Formed)<br />
| Formation date of the currently playing Artist/Band<br />
|-<br />
| MusicPlayer.Property(Artist_Disbanded)<br />
| Disbanding date of the currently playing Artist/Band<br />
|-<br />
| MusicPlayer.Property(Artist_YearsActive)<br />
| Years the currently Playing artist has been active<br />
|-<br />
| MusicPlayer.Property(Artist_Instrument)<br />
| Instruments played by the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Description)<br />
| Shows a biography of the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Mood)<br />
| Shows the moods of the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Style)<br />
| Shows the styles of the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Genre)<br />
| Shows the genre of the currently playing artist<br />
|-<br />
| MusicPlayer.Genre<br />
| 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<br />
|-<br />
| MusicPlayer.Lyrics<br />
| Lyrics of current song stored in ID tag info<br />
|-<br />
| MusicPlayer.Year<br />
| 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<br />
|-<br />
| MusicPlayer.Rating<br />
| 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<br />
|-<br />
| MusicPlayer.DiscNumber<br />
| 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<br />
|-<br />
| MusicPlayer.Comment<br />
| 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<br />
|-<br />
| MusicPlayer.Time<br />
| Current time in song<br />
|-<br />
| MusicPlayer.TimeRemaining<br />
| Current remaining time in song<br />
|-<br />
| MusicPlayer.TimeSpeed<br />
| Both the time and the playspeed formatted up. eg 1:23 (2x)<br />
|-<br />
| MusicPlayer.TrackNumber<br />
| 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<br />
|-<br />
| MusicPlayer.Duration<br />
| 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<br />
|-<br />
| MusicPlayer.BitRate<br />
| Bitrate of current song<br />
|-<br />
| MusicPlayer.Channels<br />
| Number of channels of current song<br />
|-<br />
| MusicPlayer.BitsPerSample<br />
| Number of bits per sample of current song<br />
|-<br />
| MusicPlayer.SampleRate<br />
| Samplerate of current song<br />
|-<br />
| MusicPlayer.Codec<br />
| Codec of current song<br />
|-<br />
| MusicPlayer.PlaylistPosition<br />
| Position of the current song in the current music playlist<br />
|-<br />
| MusicPlayer.PlaylistLength<br />
| Total size of the current music playlist<br />
|-<br />
| MusicPlayer.ChannelName<br />
| Channel name of the radio programme that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.ChannelNumber<br />
| Channel number of the radio programme that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.SubChannelNumber<br />
| Subchannel number of the radio channel that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.ChannelNumberLabel<br />
| Channel and subchannel number of the radio channel that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.ChannelGroup<br />
| Channel group of of the radio programme that's currently playing (PVR).<br />
|}<br />
<br />
==== Video player ====<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| VideoPlayer.Time<br />
| Current time in movie<br />
|-<br />
| VideoPlayer.TimeRemaining<br />
| Current remaining time in movie<br />
|-<br />
| VideoPlayer.TimeSpeed<br />
| Current time + playspeed. eg 1:23:14 (-4x)<br />
|-<br />
| VideoPlayer.Duration<br />
| Length of current movie<br />
|-<br />
| VideoPlayer.Title<br />
| Title of currently playing video. If it's in the database it will return the database title, else the filename<br />
|-<br />
| VideoPlayer.TVShowTitle<br />
| Title of currently playing episode's tvshow name<br />
|-<br />
| VideoPlayer.Season<br />
| Season number of the currently playing episode, if it's in the database<br />
|-<br />
| VideoPlayer.Episode<br />
| Episode number of the currently playing episode<br />
|-<br />
| VideoPlayer.Genre<br />
| Genre(s) of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Director<br />
| Director of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Country<br />
| Production country of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Year<br />
| Year of release of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Rating<br />
| IMDb user rating of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.UserRating<br />
| Shows the user rating of the currently playing item<br />
|-<br />
| VideoPlayer.Votes<br />
| IMDb votes of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.RatingAndVotes<br />
| IMDb user rating and votes of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.mpaa<br />
| MPAA rating of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.IMDBNumber<br />
| The IMDB iD of the current video, if it's in the database<br />
|-<br />
| VideoPlayer.EpisodeName<br />
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database<br />
|-<br />
| VideoPlayer.PlaylistPosition<br />
| Position of the current song in the current video playlist<br />
|-<br />
| VideoPlayer.PlaylistLength<br />
| Total size of the current video playlist<br />
|-<br />
| VideoPlayer.Cast<br />
| A concatenated string of cast members of the current movie, if it's in the database<br />
|-<br />
| VideoPlayer.CastAndRole<br />
| A concatenated string of cast members and roles of the current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Album<br />
| Album from which the current Music Video is from, if it's in the database<br />
|-<br />
| VideoPlayer.Artist<br />
| Artist(s) of current Music Video, if it's in the database<br />
|-<br />
| VideoPlayer.Studio<br />
| Studio of current Music Video, if it's in the database<br />
|-<br />
| VideoPlayer.Writer<br />
| Name of Writer of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.Tagline<br />
| Small Summary of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.PlotOutline<br />
| Small Summary of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.Plot<br />
| Complete Text Summary of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.LastPlayed<br />
| Last play date of current playing Video, if it's in the database<br />
|- class="userrow<br />
| VideoPlayer.PlayCount<br />
| Playcount of current playing Video, if it's in the database<br />
|- class="userrow<br />
| VideoPlayer.VideoCodec<br />
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)<br />
|-<br />
| VideoPlayer.VideoResolution<br />
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)<br />
|-<br />
| VideoPlayer.VideoAspect<br />
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)<br />
|-<br />
| VideoPlayer.AudioCodec<br />
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)<br />
|-<br />
| VideoPlayer.AudioChannels<br />
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)<br />
|-<br />
| VideoPlayer.AudioLanguage<br />
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)<br />
|-<br />
| VideoPlayer.SubtitlesLanguage<br />
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)<br />
|-<br />
| VideoPlayer.StereoscopicMode<br />
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)<br />
|-<br />
| VideoPlayer.EndTime<br />
| End date of the currently playing programme (PVR).<br />
|-<br />
| VideoPlayer.NextTitle<br />
| Title of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextGenre<br />
| Genre of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextPlot<br />
| Plot of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextPlotOutline<br />
| Plot outline of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextStartTime<br />
| Start time of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextEndTime<br />
| End time of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextDuration<br />
| Duration of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.ChannelName<br />
| Name of the curently tuned channel (PVR).<br />
|-<br />
| VideoPlayer.ChannelNumber<br />
| Number of the curently tuned channel (PVR).<br />
|-<br />
| VideoPlayer.SubChannelNumber<br />
| Subchannel number of the tv channel that's currently playing (PVR).<br />
|-<br />
| VideoPlayer.ChannelNumberLabel<br />
| Channel and subchannel number of the tv channel that's currently playing (PVR).<br />
|-<br />
| VideoPlayer.ChannelGroup<br />
| Group of the curently tuned channel (PVR).<br />
|-<br />
| VideoPlayer.ParentalRating<br />
| Parental rating of the currently playing programme (PVR).<br />
|}<br />
<br />
=== Playlist ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Playlist.Length(media)<br />
| Total size of the current playlist. optional parameter media is either video or music.<br />
|-<br />
| Playlist.Position(media)<br />
| Position of the current item in the current playlist. optional parameter media is either video or music.<br />
|-<br />
| Playlist.Random<br />
| Returns string ID's 590 (Randomize Play Enabled) or 591 (Disabled)<br />
|-<br />
| Playlist.Repeat<br />
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)<br />
|}<br />
<br />
=== PVR ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Pvr.NowRecordingTitle<br />
| Title of the programme being recorded<br />
|-<br />
| Pvr.NowRecordingDateTime<br />
| Start date and time of the current recording<br />
|-<br />
| Pvr.NowRecordingChannel<br />
| Channel number that's being recorded<br />
|-<br />
| Pvr.NextRecordingTitle<br />
| Title of the next programme that will be recorded<br />
|-<br />
| Pvr.NextRecordingDateTime<br />
| Start date and time of the next recording<br />
|-<br />
| Pvr.NextRecordingChannel<br />
| Channel name of the next recording<br />
|-<br />
| Pvr.BackendName<br />
| Name of the backend being used<br />
|-<br />
| Pvr.BackendVersion<br />
| Version of the backend that's being used<br />
|-<br />
| Pvr.BackendHost<br />
| Backend hostname<br />
|-<br />
| Pvr.BackendDiskSpace<br />
| Available diskspace on the backend<br />
|-<br />
| Pvr.BackendChannels<br />
| Number of available channels the backend provides<br />
|-<br />
| Pvr.BackendTimers<br />
| Number of timers set for the backend<br />
|-<br />
| Pvr.BackendRecordings<br />
| Number of recording available on the backend<br />
|- <br />
| Pvr.BackendDiskspace<br />
| Free diskspace available for recordings on the backend<br />
|-<br />
| Pvr.BackendNumber<br />
| Backend number<br />
|-<br />
| Pvr.TotalDiscSpace<br />
| Total diskspace available for recordings<br />
|-<br />
| Pvr.NextTimer<br />
| Next timer date<br />
|-<br />
| Pvr.Duration<br />
| {{?}}<br />
|-<br />
| Pvr.Time<br />
| {{?}}<br />
|-<br />
| Pvr.Progress<br />
| {{?}}<br />
|-<br />
| Pvr.TimeShiftStart<br />
| Start position of the timeshift<br />
|-<br />
| Pvr.TimeShiftEnd<br />
| End position of the timeshift<br />
|-<br />
| Pvr.TimeShiftCur<br />
| Current position of the timeshift<br />
|-<br />
| Pvr.TimeShiftProgress<br />
| {{?}}<br />
|-<br />
| Pvr.ActStreamClient<br />
| Stream client name<br />
|-<br />
| Pvr.ActStreamDevice<br />
| Stream device name<br />
|-<br />
| Pvr.ActStreamStatus<br />
| Status of the stream<br />
|-<br />
| Pvr.ActStreamSignal<br />
| Signal quality of the stream<br />
|-<br />
| Pvr.ActStreamSnr<br />
| Signal to noise ratio of the stream<br />
|-<br />
| Pvr.ActStreamBer<br />
| Bit error rate of the stream<br />
|-<br />
| Pvr.ActStreamUnc<br />
| UNC value of the stream<br />
|-<br />
| Pvr.ActStreamVideoBitRate<br />
| Video bitrate of the stream<br />
|-<br />
| Pvr.ActStreamAudioBitRate<br />
| Audio bitrate of the stream<br />
|-<br />
| Pvr.ActStreamDolbyBitRate<br />
| Dolby bitrate of the stream<br />
|-<br />
| Pvr.ActStreamProgrSignal<br />
| Signal quality of the programme<br />
|-<br />
| Pvr.ActStreamProgrSnr<br />
| Signal to noise ratio of the programme<br />
|-<br />
| Pvr.ActStreamEncryptionName<br />
| Encryption used on the stream<br />
|}<br />
<br />
=== RDS ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| RDS.AudioLanguage<br />
| <br />
|-<br />
| RDS.ChannelCountry<br />
| <br />
|-<br />
| RDS.Title<br />
| <br />
|-<br />
| RDS.GetLine<br />
| <br />
|-<br />
| RDS.Artist<br />
| <br />
|-<br />
| RDS.Band<br />
| <br />
|-<br />
| RDS.Composer<br />
| <br />
|-<br />
| RDS.Conductor<br />
| <br />
|-<br />
| RDS.Album<br />
| <br />
|-<br />
| RDS.TrackNumber<br />
| <br />
|-<br />
| RDS.RadioStyle<br />
| <br />
|-<br />
| RDS.Comment<br />
| <br />
|-<br />
| RDS.InfoNews<br />
| <br />
|-<br />
| RDS.InfoNewsLocal<br />
| <br />
|-<br />
| RDS.InfoStock<br />
| <br />
|-<br />
| RDS.InfoStockSize<br />
| <br />
|-<br />
| RDS.InfoSport<br />
| <br />
|-<br />
| RDS.InfoSportSize<br />
| <br />
|-<br />
| RDS.InfoLottery<br />
| <br />
|-<br />
| RDS.InfoLotterySize<br />
| <br />
|-<br />
| RDS.InfoWeather<br />
| <br />
|-<br />
| RDS.InfoWeatherSize<br />
| <br />
|-<br />
| RDS.InfoCinema<br />
| <br />
|-<br />
| RDS.InfoCinemaSize<br />
| <br />
|-<br />
| RDS.InfoHoroscope<br />
| <br />
|-<br />
| RDS.InfoHoroscopeSize<br />
| <br />
|-<br />
| RDS.InfoOther<br />
| <br />
|-<br />
| RDS.InfoOtherSize<br />
| <br />
|-<br />
| RDS.ProgStation<br />
| <br />
|-<br />
| RDS.ProgNow<br />
| <br />
|-<br />
| RDS.ProgNext<br />
| <br />
|-<br />
| RDS.ProgHost<br />
| <br />
|-<br />
| RDS.ProgEditStaff<br />
| <br />
|-<br />
| RDS.ProgHomepage<br />
| <br />
|-<br />
| RDS.ProgStyle<br />
| <br />
|-<br />
| RDS.PhoneHotline<br />
| <br />
|-<br />
| RDS.PhoneStudio<br />
| <br />
|-<br />
| RDS.SmsStudio<br />
| <br />
|-<br />
| RDS.EmailHotline<br />
| <br />
|-<br />
| RDS.EmailStudio<br />
| <br />
|}<br />
<br />
=== Skin ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Skin.CurrentTheme<br />
| Returns the current selected skin theme.<br />
|-<br />
| Skin.CurrentColourTheme<br />
| Returns the current selected colour theme of the skin.<br />
|-<br />
| Skin.String(name)<br />
| 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.<br />
|-<br />
| Skin.AspectRatio<br />
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.<br />
|}<br />
<br />
=== Slideshow ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|- <br />
| Slideshow.Altitude<br />
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.<br />
|-<br />
| Slideshow.Aperture<br />
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).<br />
|-<br />
| Slideshow.Author<br />
| 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).<br />
|-<br />
| Slideshow.Byline<br />
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).<br />
|-<br />
| Slideshow.BylineTitle<br />
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).<br />
|-<br />
| Slideshow.CameraMake<br />
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).<br />
|-<br />
| Slideshow.CameraModel<br />
| 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).<br />
|-<br />
| Slideshow.Caption<br />
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).<br />
|-<br />
| Slideshow.Category<br />
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).<br />
|-<br />
| Slideshow.CCDWidth<br />
| 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).<br />
|-<br />
| Slideshow.City<br />
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).<br />
|-<br />
| Slideshow.Colour<br />
| Shows whether the current picture is "Colour" or "Black and White".<br />
|-<br />
| Slideshow.CopyrightNotice<br />
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).<br />
|-<br />
| Slideshow.Country<br />
| 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).<br />
|-<br />
| Slideshow.CountryCode<br />
| 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).<br />
|-<br />
| Slideshow.Credit<br />
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).<br />
|-<br />
| Slideshow.DigitalZoom<br />
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404). <br />
|-<br />
| Slideshow.EXIFComment<br />
| 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.<br />
|-<br />
| Slideshow.EXIFDate<br />
| 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.<br />
|-<br />
| Slideshow.EXIFDescription<br />
| 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).<br />
|-<br />
| Slideshow.EXIFSoftware<br />
| 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).<br />
|-<br />
| Slideshow.EXIFTime<br />
| 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.<br />
|-<br />
| Slideshow.Exposure<br />
| 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).<br />
|-<br />
| Slideshow.ExposureBias<br />
| 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).<br />
|-<br />
| Slideshow.ExposureMode<br />
| 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).<br />
|-<br />
| Slideshow.ExposureTime<br />
| 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.<br />
|-<br />
| Slideshow.Filedate<br />
| Shows the file date of the current picture<br />
|-<br />
| Slideshow.Filename<br />
| Shows the file name of the current picture<br />
|-<br />
| Slideshow.Filesize<br />
| Shows the file size of the current picture<br />
|-<br />
| Slideshow.FlashUsed<br />
| 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). <br />
|-<br />
| Slideshow.FocalLength<br />
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).<br />
|-<br />
| Slideshow.FocusDistance<br />
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).<br />
|-<br />
| Slideshow.Headline<br />
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).<br />
|-<br />
| Slideshow.ImageType<br />
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).<br />
|-<br />
| Slideshow.IPTCDate<br />
| 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).<br />
|-<br />
| Slideshow.ISOEquivalence<br />
| 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).<br />
|-<br />
| Slideshow.Keywords<br />
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).<br />
|-<br />
| Slideshow.Latitude<br />
| 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.<br />
|-<br />
| Slideshow.LightSource<br />
| 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).<br />
|-<br />
| Slideshow.LongEXIFDate<br />
| 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.<br />
|-<br />
| Slideshow.LongEXIFTime<br />
| 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.<br />
|-<br />
| Slideshow.Longitude<br />
| 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.<br />
|-<br />
| Slideshow.MeteringMode<br />
| 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).<br />
|-<br />
| Slideshow.ObjectName<br />
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).<br />
|-<br />
| Slideshow.Orientation<br />
| 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).<br />
|-<br />
| Slideshow.Path<br />
| Shows the file path of the current picture<br />
|-<br />
| Slideshow.Process<br />
| Shows the process used to compress the current picture<br />
|-<br />
| Slideshow.ReferenceService<br />
| 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).<br />
|-<br />
| Slideshow.Resolution<br />
| Shows the dimensions of the current picture (Width x Height)<br />
|-<br />
| Slideshow.SlideComment<br />
| 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.<br />
|-<br />
| Slideshow.SlideIndex<br />
| Shows the slide index of the current picture<br />
|-<br />
| Slideshow.Source<br />
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).<br />
|-<br />
| Slideshow.SpecialInstructions<br />
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).<br />
|-<br />
| Slideshow.State<br />
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).<br />
|-<br />
| Slideshow.Sublocation<br />
| 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).<br />
|-<br />
| Slideshow.SupplementalCategories<br />
| 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).<br />
|-<br />
| Slideshow.TimeCreated<br />
| 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).<br />
|-<br />
| Slideshow.TransmissionReference<br />
| 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).<br />
|-<br />
| Slideshow.Urgency<br />
| 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).<br />
|-<br />
| Slideshow.WhiteBalance<br />
| 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).<br />
|}<br />
<br />
=== System ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| System.Time<br />
| Current time<br />
|-<br />
| System.Time(format)<br />
| 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<br />
|-<br />
| System.Date<br />
| Current date<br />
|-<br />
| System.Date(format)<br />
| 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.<br />
|-<br />
| System.AlarmPos<br />
| Shutdown Timer position<br />
|-<br />
| System.BatteryLevel<br />
| Returns the remaining battery level in range 0-100<br />
|-<br />
| System.FreeSpace<br />
| Total Freespace on the drive<br />
|-<br />
| System.UsedSpace<br />
| Total Usedspace on the drive<br />
|-<br />
| System.TotalSpace<br />
| Totalspace on the drive<br />
|-<br />
| System.UsedSpacePercent<br />
| Total Usedspace Percent on the drive<br />
|-<br />
| System.FreeSpacePercent<br />
| Total Freespace Percent on the drive<br />
|-<br />
| System.CPUTemperature<br />
| Current CPU temperature<br />
|-<br />
| System.CpuUsage<br />
| Displays the cpu usage for each individual cpu core.<br />
|-<br />
| System.CoreUsage(id)<br />
| Displays the usage of the cpu core with the given 'id'<br />
|-<br />
| System.GPUTemperature<br />
| Current GPU temperature<br />
|-<br />
| System.FanSpeed<br />
| Current fan speed<br />
|-<br />
| System.BuildVersion<br />
| Version of build<br />
|-<br />
| System.BuildDate<br />
| Date of build<br />
|-<br />
| System.FriendlyName<br />
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. eg. "Kodi (htpc)"<br />
|-<br />
| System.FPS<br />
| Current rendering speed (frames per second)<br />
|-<br />
| System.FreeMemory<br />
| Amount of free memory in Mb<br />
|-<br />
| System.Memory(format)<br />
| Available formats: used, used.percent, free, free.percent, total<br />
|-<br />
| System.ScreenMode<br />
| Screenmode (eg windowed / fullscreen)<br />
|-<br />
| System.ScreenWidth<br />
| Width of screen in pixels<br />
|-<br />
| System.ScreenHeight<br />
| Height of screen in pixels<br />
|-<br />
| System.StartupWindow<br />
| The Window Kodi will load on startup<br />
|-<br />
| System.CurrentWindow<br />
| Current Window we are in<br />
|-<br />
| System.CurrentControl<br />
| Current focused control<br />
|-<br />
| System.DVDLabel<br />
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive<br />
|-<br />
| System.HddTemperature<br />
| Hdd temperature<br />
|-<br />
| System.KernelVersion<br />
| System kernel version<br />
|-<br />
| System.Uptime<br />
| System current uptime<br />
|-<br />
| System.TotalUptime<br />
| System total uptime<br />
|-<br />
| System.CpuFrequency<br />
| System cpu frequency<br />
|-<br />
| System.ScreenResolution<br />
| Screen resolution<br />
|-<br />
| System.VideoEncoderInfo<br />
| Video encoder info<br />
|-<br />
| System.InternetState<br />
| Will return the internet state, connected or not connected<br />
and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.<br />
|-<br />
| System.Language<br />
| Shows the current language<br />
|-<br />
| System.GetBool(boolean)<br />
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml<br />
|-<br />
| System.ProfileName<br />
| Shows the User name of the currently logged in Kodi user<br />
|-<br />
| System.ProfileCount<br />
| Shows the number of defined profiles<br />
|-<br />
| System.ProfileAutoLogin<br />
| The profile Kodi will auto login to<br />
|-<br />
| System.StereoscopicMode<br />
| The prefered stereoscopic mode (settings > video > playback)<br />
|-<br />
| System.TemperatureUnits<br />
| Shows Celsius or Fahrenheit symbol<br />
|-<br />
| System.AddonTitle(id)<br />
| Returns the title of the addon with the given id<br />
|-<br />
| System.AddonVersion(id)<br />
| Returns the version of the addon with the given id<br />
|}<br />
<br />
=== Visualisation ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Visualisation.Preset<br />
| Shows the current preset of the visualisation.<br />
|-<br />
| Visualisation.Name<br />
| Shows the name of the visualisation.<br />
|}<br />
<br />
=== Weather labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Weather.Conditions<br />
| Current weather conditions – this is looked up in a background process.<br />
|-<br />
| Weather.Temperature<br />
| Current weather temperature<br />
|-<br />
| Weather.Location<br />
| City/town which the above two items are for<br />
|-<br />
| Weather.fanartcode<br />
| Current weather fanartcode.<br />
|-<br />
| Weather.plugin<br />
| Current weather plugin.<br />
|}<br />
<br />
=== Window ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Window([window]).Property(key)<br />
| Window property. (key can be any value, optional window can be id or name)<br />
|-<br />
| Window.Property(xmlfile)<br />
| Displays the name of the xml file currently shown<br />
|-<br />
| Window(AddonBrowser).Property(Updated)<br />
| Shows the date and time the addon repo was last checked for updates<br />
|-<br />
| Window(Home).Property(key)<br />
| The home window has the following info labels.<br />
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<br />
<br />
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<br />
<br />
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<br />
<br />
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<br />
<br />
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<br />
<br />
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<br />
|-<br />
| Window(Weather).Property(key)<br />
| The weather window has the following info labels.<br />
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<br />
<br />
<br />
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<br />
|}<br />
<br />
=== Images Available in Kodi ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Container.Art(tvshow.fanart)<br />
| Fanart Image of the parent TV show<br />
|-<br />
| Container.Art(season.poster)<br />
| Thumbnail Image of the parent season<br />
|-<br />
| Container.Art(artist.fanart)<br />
| Fanart Image of the parent album artist<br />
|-<br />
| Container.Art(artist.thumb)<br />
| Thumbnail Image of the parent album artist<br />
|-<br />
| Fanart.Image<br />
| Fanart image for the parent TV Show<br />
|-<br />
| ListItem.Thumb<br />
| 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).<br />
|-<br />
| ListItem.Icon<br />
| 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 icon.<br />
|-<br />
| ListItem.ActualIcon<br />
| Shows the icon of the currently selected item in a list or thumb control.<br />
|-<br />
| ListItem.Art(clearart)<br />
| Returns the clearart (if it exists) of the currently selected movie or tv show.<br />
|-<br />
| ListItem.Art(clearlogo)<br />
| Returns the clearlogo (if it exists) of the currently selected movie or tv show.<br />
|-<br />
| ListItem.Art(thumb)<br />
| Returns the thumbnail of the currently selected item.<br />
|-<br />
| ListItem.Art(poster)<br />
| Returns the poster of the currently selected movie or tv show.<br />
|-<br />
| ListItem.Art(banner)<br />
| Returns the banner of the currently selected tv show.<br />
|-<br />
| ListItem.Art(fanart)<br />
| Returns the fanart image of the currently selected item.<br />
|-<br />
| ListItem.Art(set.fanart)<br />
| Returns the fanart image of the currently selected movieset.<br />
|-<br />
| ListItem.Art(landscape)<br />
| Returns the landscape art of the currently selected item.<br />
|-<br />
| ListItem.Art(tvshow.poster)<br />
| Returns the tv show poster of the parent container.<br />
|-<br />
| ListItem.Art(tvshow.banner)<br />
| Returns the tv show banner of the parent container.<br />
|-<br />
| ListItem.Art(season.poster)<br />
| Returns the season poster of the currently selected season. (Only available in DialogVideoInfo.xml)<br />
|-<br />
| ListItem.Art(season.banner)<br />
| Returns the season banner of the currently selected season. (Only available in DialogVideoInfo.xml)<br />
|-<br />
| ListItem.Art(season.fanart)<br />
| Returns the fanart image of the currently selected season. (Only available in DialogVideoInfo.xml)<br />
|-<br />
| ListItem.Overlay<br />
| 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.<br />
|-<br />
| ListItem.StarRating<br />
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin<br />
|-<br />
| ListItem.Property(ArtistThumb)<br />
| Thumbnail Image of the parent artist, for use in dialogalbuminfo.xml and dialogsonginfo.xml<br />
|-<br />
| ListItem.Property(Addon.StarRating)<br />
| Returns a value of rating0.png to rating5.png for the currently selected addon<br />
|-<br />
| ListItem.Property(Fanart_Image)<br />
| Fanart Image currently selected item or of the parent TV show<br />
|-<br />
| ListItem.Property(SeasonThumb)<br />
| Thumbnail Image of the parent TV show season, for use in dialogvideoinfo.xml<br />
|-<br />
| ListItem.Property(TVShowThumb)<br />
| Thumbnail Image of the parent TV show, for use in dialogvideoinfo.xml (available anywhere)<br />
|-<br />
| MusicPlayer.Cover<br />
| Cover of currently playing album<br />
|-<br />
| MusicPlayer.Property(Fanart_Image)<br />
| Fanart image of the currently playing artist<br />
|-<br />
| Player.Art(fanart)<br />
| Fanart Image of the currently playing episode's parent TV show <br />
|-<br />
| Player.Art(thumb)<br />
| Returns the thumbnail image of the currently playing item.<br />
|-<br />
| Player.Art(poster)<br />
| Returns the poster of the currently playing movie.<br />
|-<br />
| Player.Art(tvshow.poster)<br />
| Returns the tv show poster of the currently playing episode's parent TV show.<br />
|-<br />
| Player.Art(tvshow.banner)<br />
| Returns the tv show banner of the currently playing episode's parent TV show.<br />
|-<br />
| Player.StarRating<br />
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin<br />
|-<br />
| Pvr.NowRecordingChannelIcon<br />
| Channel icon of the programme currently being recorded.<br />
|-<br />
| Pvr.NextRecordingChannelIcon<br />
| Channel icon of the programme that will be recorded next.<br />
|-<br />
| Skin.String(name)<br />
| 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.<br />
|-<br />
| System.AddonIcon(id)<br />
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (eg. $INFO[Skin.String(Foo)])<br />
|-<br />
| System.ProfileThumb<br />
| Shows the Thumbnail image of the currently logged in Kodi user<br />
|-<br />
| VideoPlayer.Cover<br />
| Cover of currently playing movie<br />
|-<br />
| Weather.Conditions<br />
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)<br />
|-<br />
| Window([window]).Property(key)<br />
| Window property. (key can be any value, optional window can be id or name)<br />
|-<br />
| Window(Weather).Property(key)<br />
| The weather window has the following info images.<br />
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo<br />
|}<br />
<br />
<section end="main content" /><br />
<br />
== See also ==<br />
'''Development:'''<br />
* [[Add-on development]]<br />
* [[Skinning]]<br />
<br />
[[Category:Skin development]]<br />
[[Category:Add-on development]]</div>Phil65https://kodi.wiki/index.php?title=InfoLabels&diff=117567InfoLabels2016-03-14T06:23:43Z<p>Phil65: </p>
<hr />
<div>{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}<br />
<section begin="main content" /><br />
Skins can use infolabels with $INFO[infolabel] or the <info> tag. Scripts can read infolabels with <code>xbmc.getInfoLabel('infolabel')</code>.<br />
<br />
An up-to-date list can be found here [https://github.com/xbmc/xbmc/blob/master/xbmc/GUIInfoManager.cpp GUIInfoManager.cpp]<br />
<br />
=== ADSP ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| ADSP.ActiveStreamType<br />
| <br />
|-<br />
| ADSP.DetectedStreamType<br />
| <br />
|-<br />
| ADSP.MasterName<br />
| <br />
|-<br />
| ADSP.MasterInfo<br />
| <br />
|-<br />
| ADSP.MasterOwnIcon<br />
| <br />
|-<br />
| ADSP.MasterOverrideIcon<br />
| <br />
|}<br />
<br />
=== Container ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Container.Content<br />
| Shows content of the current container<br />
|-<br />
| Container.FolderPath<br />
| Shows complete path of currently displayed folder<br />
|-<br />
| Container.FolderName<br />
| Shows top most folder in currently displayed folder<br />
|-<br />
| Container.Viewmode<br />
| Returns the current viewmode (list, icons etc.)<br />
|-<br />
| Container.SortMethod<br />
| Returns the current sort method (name, year, rating, etc.)<br />
|-<br />
| Container.SortOrer<br />
| Returns the current sort order (Ascending/Descending)<br />
|-<br />
| Container.PluginName<br />
| Returns the current plugins base folder name<br />
|-<br />
| Container.PluginCategory<br />
| Returns the current plugins category (set by the scripter)<br />
|-<br />
| Container.ShowPlot<br />
| Returns the TV Show Plot of the current container and can be used at season and episode level<br />
|-<br />
| Container(id).NumPages<br />
| Number of pages in the container with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).NumItems<br />
| Number of items in the container or grouplist with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).CurrentPage<br />
| Current page in the container with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).CurrentItem<br />
| Current item in the container or grouplist with given id. If no id is specified it grabs the current container.<br />
|-<br />
| Container(id).Position<br />
| Returns the current focused position of container / grouplist (id) as a numeric label.<br />
|-<br />
| Container(id).Column<br />
| Returns the column number of the focused position in a panel container.<br />
|-<br />
| Container(id).Row<br />
| Returns the row number of the focused position in a panel container.<br />
|-<br />
| Container(id).Totaltime<br />
| Returns the total time of all items in the current container<br />
|-<br />
| Container(id).TotalWatched<br />
| Returns the number of watched items in the current container<br />
|-<br />
| Container(id).TotalUnWatched<br />
| Returns the number of unwatched items in the current container<br />
|-<br />
| Container(id).ListItem(offset).Label<br />
| Shows ListItem.Label for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(2).Label )''<br />
|-<br />
| Container(id).ListItem(offset).Label2<br />
| Shows ListItem.Label2 for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(-2).Label2 )''<br />
|-<br />
| Container(id).ListItem(offset).Icon<br />
| Shows ListItem.Icon for a specific List or Panel Container with a offset ''( eg: Container(52).Listitem(1).Icon)''<br />
|-<br />
| Container(id).ListItem(offset).ActualIcon<br />
| Shows ListItem.ActualIcon for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).ActualIcon )''<br />
|-<br />
| Container(id).ListItem(offset).Thumb<br />
| Shows ListItem.Thumb for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).Thumb )''<br />
|-<br />
| Container(id).ListItemNoWrap(offset).Property<br />
| Basically returns the same as ListItem(offset) but it won't wrap. That means if the last item of a list is focused, ListItemNoWrap(1) will be empty while ListItem(1) will return the first item of the list. ''Property'' has to be replaced with Label, Label2, Icon etc. ''( eg: Container(50).ListitemNoWrap(1).Plot )''<br />
|-<br />
| Container(id).ListItemPosition(id).[infolabel]<br />
| Shows the infolabel for an item in a Container. the item id is the position in the container relative to the cursor position. ''( eg: Container(50).ListItemPosition(4).Genre )''<br />
|-<br />
| Container(id).ListItemAbsolute(id).[infolabel]<br />
| Shows the infolabel for an item in a Container. the item id is the absolute position in the container. ''( eg: Container(50).ListItemAbsolute(4).Genre )''<br />
|-<br />
| Container.Property(addoncategory)<br />
| Returns the current add-on category<br />
|-<br />
| Container.Property(reponame)<br />
| Returns the current add-on repository name<br />
|}<br />
<br />
=== Control ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Control.GetLabel(id)[.index()]<br />
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.<br />
|}<br />
<br />
=== Fanart ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Fanart.Color1<br />
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.<br />
|-<br />
| Fanart.Color2<br />
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.<br />
|-<br />
| Fanart.Color3<br />
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.<br />
|}<br />
<br />
=== ListItem ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| ListItem.Label<br />
| Shows the left label of the currently selected item in a container<br />
|-<br />
| ListItem.Label2<br />
| Shows the right label of the currently selected item in a container<br />
|-<br />
| ListItem.Title<br />
| Shows the title of the currently selected song or movie in a container<br />
|-<br />
| ListItem.OriginalTitle<br />
| Shows the original title of the currently selected movie in a container<br />
|-<br />
| ListItem.SortLetter<br />
| Shows the first letter of the current file in a container<br />
|-<br />
| ListItem.TrackNumber<br />
| Shows the track number of the currently selected song in a container<br />
|-<br />
| ListItem.Artist<br />
| Shows the artist of the currently selected song in a container<br />
|-<br />
| ListItem.AlbumArtist<br />
| Shows the artist of the currently selected album in a list<br />
|-<br />
| ListItem.Property(Artist_Born)<br />
| Date of Birth of the currently selected Artist<br />
|-<br />
| ListItem.Property(Artist_Died)<br />
| Date of Death of the currently selected Artist<br />
|-<br />
| ListItem.Property(Artist_Formed)<br />
| Formation date of the currently selected Band<br />
|-<br />
| ListItem.Property(Artist_Disbanded)<br />
| Disbanding date of the currently selected Band<br />
|-<br />
| ListItem.Property(Artist_YearsActive)<br />
| Years the currently selected artist has been active<br />
|-<br />
| ListItem.Property(Artist_Instrument)<br />
| Instruments played by the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Description)<br />
| Shows a biography of the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Mood)<br />
| Shows the moods of the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Style)<br />
| Shows the styles of the currently selected artist<br />
|-<br />
| ListItem.Property(Artist_Genre)<br />
| Shows the genre of the currently selected artist<br />
|-<br />
| ListItem.Album<br />
| Shows the album of the currently selected song in a container<br />
|-<br />
| ListItem.Property(Album_Mood)<br />
| Shows the moods of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Style)<br />
| Shows the styles of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Theme)<br />
| Shows the themes of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Type)<br />
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Label)<br />
| Shows the record label of the currently selected Album<br />
|-<br />
| ListItem.Property(Album_Description)<br />
| Shows a review of the currently selected Album<br />
|-<br />
| ListItem.DiscNumber<br />
| Shows the disc number of the currently selected song in a container<br />
|-<br />
| ListItem.Year<br />
| Shows the year of the currently selected song, album or movie in a container<br />
|-<br />
| ListItem.Premiered<br />
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container<br />
|-<br />
| ListItem.Genre<br />
| Shows the genre of the currently selected song, album or movie in a container<br />
|-<br />
| ListItem.Director<br />
| Shows the director of the currently selected movie in a container<br />
|-<br />
| ListItem.Country<br />
| Shows the production country of the currently selected movie in a container<br />
|-<br />
| ListItem.Episode<br />
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.<br />
|-<br />
| ListItem.Season<br />
| Shows the season value for the currently selected tvshow<br />
|-<br />
| ListItem.TVShowTitle<br />
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library<br />
|-<br />
| ListItem.Property(TotalSeasons)<br />
| Shows the total number of seasons for the currently selected tvshow<br />
|-<br />
| ListItem.Property(TotalEpisodes)<br />
| Shows the total number of episodes for the currently selected tvshow or season<br />
|-<br />
| ListItem.Property(WatchedEpisodes)<br />
| Shows the number of watched episodes for the currently selected tvshow or season<br />
|-<br />
| ListItem.Property(UnWatchedEpisodes)<br />
| Shows the number of unwatched episodes for the currently selected tvshow or season<br />
|-<br />
| ListItem.Property(NumEpisodes)<br />
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.<br />
|-<br />
| ListItem.PictureAperture<br />
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).<br />
|-<br />
| ListItem.PictureAuthor<br />
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).<br />
|-<br />
| ListItem.PictureByline<br />
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).<br />
|-<br />
| ListItem.PictureBylineTitle<br />
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).<br />
|-<br />
| ListItem.PictureCamMake<br />
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).<br />
|-<br />
| ListItem.PictureCamModel<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureCaption<br />
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).<br />
|-<br />
| ListItem.PictureCategory<br />
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).<br />
|-<br />
| ListItem.PictureCCDWidth<br />
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).<br />
|-<br />
| ListItem.PictureCity<br />
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).<br />
|-<br />
| ListItem.PictureColour<br />
| Shows whether the selected picture is "Colour" or "Black and White".<br />
|-<br />
| ListItem.PictureComment<br />
| Shows a 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.<br />
|-<br />
| ListItem.PictureCopyrightNotice<br />
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).<br />
|-<br />
| ListItem.PictureCountry<br />
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).<br />
|-<br />
| ListItem.PictureCountryCode<br />
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).<br />
|-<br />
| ListItem.PictureCredit<br />
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).<br />
|-<br />
| ListItem.PictureDate<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureDatetime<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureDesc<br />
| Shows a 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).<br />
|-<br />
| ListItem.PictureDigitalZoom<br />
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).<br />
|-<br />
| ListItem.PictureExpMode<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureExposure<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureExposureBias<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureExpTime<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureFlashUsed<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureFocalLen<br />
| Shows the lens focal length of the selected picture<br />
|-<br />
| ListItem.PictureFocusDist<br />
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).<br />
|-<br />
| ListItem.PictureGPSLat<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureGPSLon<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureGPSAlt<br />
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.<br />
|-<br />
| ListItem.PictureHeadline<br />
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).<br />
|-<br />
| ListItem.PictureImageType<br />
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).<br />
|-<br />
| ListItem.PictureIPTCDate<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureIPTCTime<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureISO<br />
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).<br />
|-<br />
| ListItem.PictureKeywords<br />
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).<br />
|-<br />
| ListItem.PictureLightSource<br />
| 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).<br />
|-<br />
| ListItem.PictureLongDate<br />
| Shows only 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.<br />
|-<br />
| ListItem.PictureLongDatetime<br />
| Shows 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.<br />
|-<br />
| ListItem.PictureMeteringMode<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureObjectName<br />
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).<br />
|-<br />
| ListItem.PictureOrientation<br />
| Shows 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).<br />
|- <br />
| ListItem.PicturePath<br />
| Shows the filename and path of the selected picture<br />
|-<br />
| ListItem.PictureProcess<br />
| Shows the process used to compress the selected picture<br />
|-<br />
| ListItem.PictureReferenceService<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureResolution<br />
| Shows the dimensions of the selected picture<br />
|-<br />
| ListItem.PictureSource<br />
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).<br />
|-<br />
| ListItem.PictureSpecialInstructions<br />
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).<br />
|-<br />
| ListItem.PictureState<br />
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).<br />
|-<br />
| ListItem.PictureSublocation<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureSupplementalCategories<br />
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).<br />
|-<br />
| ListItem.PictureTransmissionReference<br />
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).<br />
|-<br />
| ListItem.PictureUrgency<br />
| Shows 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).<br />
|-<br />
| ListItem.PictureWhiteBalance<br />
| Shows 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).<br />
|-<br />
| ListItem.FileName<br />
| Shows the filename of the currently selected song or movie in a container<br />
|-<br />
| ListItem.Path<br />
| Shows the complete path of the currently selected song or movie in a container<br />
|-<br />
| ListItem.FolderName<br />
| Shows top most folder of the path of the currently selected song or movie in a container<br />
|-<br />
| ListItem.FolderPath<br />
| Shows the complete path of the currently selected song or movie in a container (without user details).<br />
|-<br />
| ListItem.FileNameAndPath<br />
| Shows the full path with filename of the currently selected song or movie in a container<br />
|-<br />
| ListItem.FileExtension<br />
| Shows the file extension (without leading dot) of the currently selected item in a container<br />
|-<br />
| ListItem.Date<br />
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)<br />
|-<br />
| ListItem.DateAdded<br />
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.<br />
|-<br />
| ListItem.Size<br />
| Shows the file size of the currently selected song or movie in a container<br />
|-<br />
| ListItem.Rating<br />
| Shows the IMDB rating of the currently selected movie in a container<br />
|-<br />
| ListItem.Set<br />
| Shows the name of the set the movie is part of<br />
|-<br />
| ListItem.SetId<br />
| Shows the id of the set the movie is part of<br />
|-<br />
| ListItem.UserRating<br />
| Shows the user rating of the currently selected item in a container<br />
|-<br />
| ListItem.Votes<br />
| Shows the IMDB votes of the currently selected movie in a container<br />
|-<br />
| ListItem.RatingAndVotes<br />
| Shows the IMDB rating and votes of the currently selected movie in a container<br />
|-<br />
| ListItem.Mpaa<br />
| Show the MPAA rating of the currently selected movie in a container<br />
|-<br />
| ListItem.ProgramCount<br />
| Shows the number of times an xbe has been run from "my programs"<br />
|-<br />
| ListItem.Duration<br />
| Shows the song or movie duration of the currently selected movie in a container<br />
|-<br />
| ListItem.DBTYPE<br />
| Shows the database type of the ListItem.DBID for videos (movie, set, genre, actor, tvshow, season, episode). It does not return any value for the music library. Beware 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.<br />
|-<br />
| ListItem.DBID<br />
| Shows the database id of the currently selected listitem in a container<br />
|-<br />
| ListItem.Cast<br />
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml<br />
|-<br />
| ListItem.CastAndRole<br />
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml<br />
|-<br />
| ListItem.Studio<br />
| Studio of current selected Music Video in a container<br />
|-<br />
| ListItem.Top250<br />
| Shows the IMDb top250 position of the currently selected listitem in a container.<br />
|-<br />
| ListItem.Trailer<br />
| Shows the full trailer path with filename of the currently selected movie in a container<br />
|-<br />
| ListItem.Writer<br />
| Name of Writer of current Video in a container<br />
|-<br />
| ListItem.Tagline<br />
| Small Summary of current Video in a container<br />
|-<br />
| ListItem.PlotOutline<br />
| Small Summary of current Video in a container<br />
|-<br />
| ListItem.Plot<br />
| Complete Text Summary of Video in a container<br />
|-<br />
| ListItem.IMDBNumber<br />
| The IMDB iD of the selected Video in a container<br />
|-<br />
| ListItem.EpisodeName<br />
| (PVR only) The name of the episode if the selected EPG item is a TV Show<br />
|-<br />
| ListItem.PercentPlayed<br />
| Returns percentage value [0-100] of how far the selected video has been played<br />
|-<br />
| ListItem.LastPlayed<br />
| Last play date of Video in a container<br />
|-<br />
| ListItem.PlayCount<br />
| Playcount of Video in a container<br />
|-<br />
| ListItem.StartTime<br />
| Start time of current selected TV programme in a container<br />
|-<br />
| ListItem.EndTime<br />
| End time of current selected TV programme in a container<br />
|-<br />
| ListItem.StartDate<br />
| Start date of current selected TV programme in a container<br />
|-<br />
| ListItem.ChannelNumber<br />
| Number of current selected TV channel in a container<br />
|-<br />
| ListItem.ChannelName<br />
| Name of current selected TV channel in a container<br />
|-<br />
| ListItem.VideoCodec<br />
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)<br />
|-<br />
| ListItem.VideoResolution<br />
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.<br />
|-<br />
| ListItem.VideoAspect<br />
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)<br />
|-<br />
| ListItem.AudioCodec<br />
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)<br />
|-<br />
| ListItem.AudioChannels<br />
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 8, 10)<br />
|-<br />
| ListItem.AudioLanguage<br />
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)<br />
|-<br />
| ListItem.SubtitleLanguage<br />
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)<br />
|-<br />
| ListItem.Property(AudioCodec.[n])<br />
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)<br />
|-<br />
| ListItem.Property(AudioChannels.[n])<br />
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)<br />
|-<br />
| ListItem.Property(AudioLanguage.[n])<br />
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)<br />
|-<br />
| ListItem.Property(SubtitleLanguage.[n])<br />
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)<br />
|-<br />
| ListItem.Property(Addon.Name)<br />
| Shows the name of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Version)<br />
| Shows the version of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Summary)<br />
| Shows a short description of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Description)<br />
| Shows the full description of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Type)<br />
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Creator)<br />
| Shows the name of the author the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Disclaimer)<br />
| Shows the disclaimer of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Changelog)<br />
| Shows the changelog of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.ID)<br />
| Shows the identifier of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Status)<br />
| Shows the status of the currently selected addon<br />
|-<br />
| ListItem.Property(Addon.Broken)<br />
| Shows a message when the addon is marked as broken in the repo<br />
|-<br />
| ListItem.Property(Addon.Path)<br />
| Shows the path of the currently selected addon<br />
|-<br />
| ListItem.StartTime<br />
| Start time of the selected item (PVR).<br />
|-<br />
| ListItem.EndTime<br />
| End time of the selected item (PVR).<br />
|-<br />
| ListItem.StartDate<br />
| Start date of the selected item (PVR).<br />
|-<br />
| ListItem.EndDate<br />
| End date of the selected item (PVR).<br />
|-<br />
| ListItem.NextTitle<br />
| Title of the next item (PVR).<br />
|-<br />
| ListItem.NextGenre<br />
| Genre of the next item (PVR).<br />
|-<br />
| ListItem.NextPlot<br />
| Plot of the next item (PVR).<br />
|-<br />
| ListItem.NextPlotOutline<br />
| Plot outline of the next item (PVR).<br />
|-<br />
| ListItem.NextStartTime<br />
| Start time of the next item (PVR).<br />
|-<br />
| ListItem.NextEndTime<br />
| End of the next item (PVR).<br />
|-<br />
| ListItem.NextStartDate<br />
| Start date of the next item (PVR).<br />
|-<br />
| ListItem.NextEndDate<br />
| End date of the next item (PVR).<br />
|-<br />
| ListItem.ChannelName<br />
| Channelname of the selected item (PVR).<br />
|-<br />
| ListItem.ChannelNumber<br />
| Channel number of the selected item (PVR).<br />
|-<br />
| ListItem.ChannelGroup<br />
| Channel group of the selected item (PVR).<br />
|-<br />
| ListItem.SubChannelNumber<br />
| Subchannel number of the currently selected channel that's currently playing (PVR).<br />
|-<br />
| ListItem.ChannelNumberLabel<br />
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).<br />
|-<br />
| ListItem.Progress<br />
| Part of the programme that's been played (PVR).<br />
|-<br />
| ListItem.StereoscopicMode<br />
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)<br />
|-<br />
| ListItem.IsSelected<br />
| Whether the item is selected.<br />
|-<br />
| ListItem.IsPlaying<br />
| Whether the item is playing.<br />
|-<br />
| ListItem.IsResumable<br />
| Whether the item has a resume point set.<br />
|-<br />
| ListItem.IsFolder<br />
| Whether the item is a folder.<br />
|-<br />
| ListItem.IsCollection<br />
| Whether the item is a movie collection.<br />
|-<br />
| ListItem.IsRecording<br />
| Whether the item is a recording (PVR).<br />
|-<br />
| ListItem.HasTimer<br />
| Whether the item has a timer, not depending on it's state (PVR).<br />
|-<br />
| ListItem.HasTimerSchedule<br />
| Whether the item is part of a repeating timer schedule (PVR). (v16 addition)<br />
|-<br />
| ListItem.TimerHasError<br />
| Whether the item has a timer and it won't be recorded because of an error (PVR). (v17 addition)<br />
|-<br />
| ListItem.TimerHasConflict<br />
| Whether the item has a timer and it won't be recorded because of a conflict (PVR). (v17 addition)<br />
|-<br />
| ListItem.TimerIsActive<br />
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). (v17 addition)<br />
|-<br />
| ListItem.Comment<br />
| Comment assigned to the item (PVR/MUSIC).<br />
|}<br />
<br />
=== Musicpartymode labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| MusicPartyMode.SongsPlayed<br />
| Number of songs played during Party Mode<br />
|-<br />
| MusicPartyMode.MatchingSongs<br />
| Number of songs available to Party Mode<br />
|-<br />
| MusicPartyMode.MatchingSongsPicked<br />
| Number of songs picked already for Party Mode<br />
|-<br />
| MusicPartyMode.MatchingSongsLeft<br />
| Number of songs left to be picked from for Party Mode<br />
|-<br />
| MusicPartyMode.RelaxedSongsPicked<br />
| Not currently used<br />
|-<br />
| MusicPartyMode.RandomSongsPicked<br />
| Number of unique random songs picked during Party Mode<br />
|}<br />
<br />
=== Network labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Network.IsDHCP<br />
| Network type is DHCP or FIXED<br />
|-<br />
| Network.IPAddress<br />
| The system's IP Address (formatted as IP: <ipaddress>)<br />
|-<br />
| Network.LinkState<br />
| Network linkstate e.g. 10mbit/100mbit etc.<br />
|-<br />
| Network.MacAddress<br />
| The system's mac address<br />
|-<br />
| Network.SubnetMask<br />
| Network subnet mask<br />
|-<br />
| Network.GatewayAddress<br />
| Network gateway address<br />
|-<br />
| Network.DNS1Address<br />
| Network dns 1 address<br />
|-<br />
| Network.DNS2Address<br />
| Network dns 2 address<br />
|-<br />
| Network.DHCPAddress<br />
| DHCP ip address<br />
|}<br />
<br />
=== Player labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Player.FinishTime<br />
| Time playing media will end<br />
|-<br />
| Player.FinishTime(format)<br />
| 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).<br />
|-<br />
| Player.Chapter<br />
| Current chapter of current playing media<br />
|-<br />
| Player.ChapterCount<br />
| Total number of chapters of current playing media<br />
|-<br />
| Player.Time<br />
| Elapsed time of current playing media<br />
|-<br />
| Player.Time(format)<br />
| 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).<br />
|-<br />
| Player.TimeRemaining<br />
| Remaining time of current playing media<br />
|-<br />
| Player.TimeRemaining(format)<br />
| 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).<br />
|-<br />
| Player.Duration<br />
| Total duration of the current playing media<br />
|-<br />
| Player.Duration(format)<br />
| 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).<br />
|-<br />
| Player.SeekTime<br />
| Time to which the user is seeking<br />
|-<br />
| Player.SeekOffset<br />
| Indicates the seek offset after a seek press (eg user presses BigStepForward, player.seekoffset returns +10:00)<br />
|-<br />
| Player.SeekOffset(format)<br />
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).<br />
|-<br />
| Player.SeekStepSize<br />
| Displays the seek step size. (v15 addition)<br />
|-<br />
| Player.ProgressCache<br />
| Shows how much of the file is cached above current play percentage<br />
|-<br />
| Player.Folderpath<br />
| Shows the full path of the currently playing song or movie<br />
|-<br />
| Player.Filenameandpath<br />
| Shows the full path with filename of the currently playing song or movie<br />
|-<br />
| Player.StartTime<br />
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.<br />
|-<br />
| Player.StartTime(format)<br />
| 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).<br />
|-<br />
| Player.Title<br />
| Returns the musicplayer title for audio and the videoplayer title for videos.<br />
|-<br />
| Player.Filename<br />
| Returns the filename of the currently playing media.<br />
|}<br />
<br />
==== Music player ====<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| MusicPlayer.Title<br />
| 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<br />
|-<br />
| MusicPlayer.Album<br />
| 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<br />
|-<br />
| MusicPlayer.Property(Album_Mood)<br />
| Shows the moods of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Style)<br />
| Shows the styles of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Theme)<br />
| Shows the themes of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Type)<br />
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Label)<br />
| Shows the record label of the currently playing Album<br />
|-<br />
| MusicPlayer.Property(Album_Description)<br />
| Shows a review of the currently playing Album<br />
|-<br />
| MusicPlayer.Artist<br />
| 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<br />
|-<br />
| MusicPlayer.Property(Artist_Born)<br />
| Date of Birth of the currently playing Artist<br />
|-<br />
| MusicPlayer.Property(Artist_Died)<br />
| Date of Death of the currently playing Artist<br />
|-<br />
| MusicPlayer.Property(Artist_Formed)<br />
| Formation date of the currently playing Artist/Band<br />
|-<br />
| MusicPlayer.Property(Artist_Disbanded)<br />
| Disbanding date of the currently playing Artist/Band<br />
|-<br />
| MusicPlayer.Property(Artist_YearsActive)<br />
| Years the currently Playing artist has been active<br />
|-<br />
| MusicPlayer.Property(Artist_Instrument)<br />
| Instruments played by the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Description)<br />
| Shows a biography of the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Mood)<br />
| Shows the moods of the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Style)<br />
| Shows the styles of the currently playing artist<br />
|-<br />
| MusicPlayer.Property(Artist_Genre)<br />
| Shows the genre of the currently playing artist<br />
|-<br />
| MusicPlayer.Genre<br />
| 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<br />
|-<br />
| MusicPlayer.Lyrics<br />
| Lyrics of current song stored in ID tag info<br />
|-<br />
| MusicPlayer.Year<br />
| 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<br />
|-<br />
| MusicPlayer.Rating<br />
| 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<br />
|-<br />
| MusicPlayer.DiscNumber<br />
| 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<br />
|-<br />
| MusicPlayer.Comment<br />
| 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<br />
|-<br />
| MusicPlayer.Time<br />
| Current time in song<br />
|-<br />
| MusicPlayer.TimeRemaining<br />
| Current remaining time in song<br />
|-<br />
| MusicPlayer.TimeSpeed<br />
| Both the time and the playspeed formatted up. eg 1:23 (2x)<br />
|-<br />
| MusicPlayer.TrackNumber<br />
| 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<br />
|-<br />
| MusicPlayer.Duration<br />
| 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<br />
|-<br />
| MusicPlayer.BitRate<br />
| Bitrate of current song<br />
|-<br />
| MusicPlayer.Channels<br />
| Number of channels of current song<br />
|-<br />
| MusicPlayer.BitsPerSample<br />
| Number of bits per sample of current song<br />
|-<br />
| MusicPlayer.SampleRate<br />
| Samplerate of current song<br />
|-<br />
| MusicPlayer.Codec<br />
| Codec of current song<br />
|-<br />
| MusicPlayer.PlaylistPosition<br />
| Position of the current song in the current music playlist<br />
|-<br />
| MusicPlayer.PlaylistLength<br />
| Total size of the current music playlist<br />
|-<br />
| MusicPlayer.ChannelName<br />
| Channel name of the radio programme that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.ChannelNumber<br />
| Channel number of the radio programme that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.SubChannelNumber<br />
| Subchannel number of the radio channel that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.ChannelNumberLabel<br />
| Channel and subchannel number of the radio channel that's currently playing (PVR).<br />
|-<br />
| MusicPlayer.ChannelGroup<br />
| Channel group of of the radio programme that's currently playing (PVR).<br />
|}<br />
<br />
==== Video player ====<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| VideoPlayer.Time<br />
| Current time in movie<br />
|-<br />
| VideoPlayer.TimeRemaining<br />
| Current remaining time in movie<br />
|-<br />
| VideoPlayer.TimeSpeed<br />
| Current time + playspeed. eg 1:23:14 (-4x)<br />
|-<br />
| VideoPlayer.Duration<br />
| Length of current movie<br />
|-<br />
| VideoPlayer.Title<br />
| Title of currently playing video. If it's in the database it will return the database title, else the filename<br />
|-<br />
| VideoPlayer.TVShowTitle<br />
| Title of currently playing episode's tvshow name<br />
|-<br />
| VideoPlayer.Season<br />
| Season number of the currently playing episode, if it's in the database<br />
|-<br />
| VideoPlayer.Episode<br />
| Episode number of the currently playing episode<br />
|-<br />
| VideoPlayer.Genre<br />
| Genre(s) of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Director<br />
| Director of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Country<br />
| Production country of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Year<br />
| Year of release of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Rating<br />
| IMDb user rating of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.UserRating<br />
| Shows the user rating of the currently playing item<br />
|-<br />
| VideoPlayer.Votes<br />
| IMDb votes of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.RatingAndVotes<br />
| IMDb user rating and votes of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.mpaa<br />
| MPAA rating of current movie, if it's in the database<br />
|-<br />
| VideoPlayer.IMDBNumber<br />
| The IMDB iD of the current video, if it's in the database<br />
|-<br />
| VideoPlayer.EpisodeName<br />
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database<br />
|-<br />
| VideoPlayer.PlaylistPosition<br />
| Position of the current song in the current video playlist<br />
|-<br />
| VideoPlayer.PlaylistLength<br />
| Total size of the current video playlist<br />
|-<br />
| VideoPlayer.Cast<br />
| A concatenated string of cast members of the current movie, if it's in the database<br />
|-<br />
| VideoPlayer.CastAndRole<br />
| A concatenated string of cast members and roles of the current movie, if it's in the database<br />
|-<br />
| VideoPlayer.Album<br />
| Album from which the current Music Video is from, if it's in the database<br />
|-<br />
| VideoPlayer.Artist<br />
| Artist(s) of current Music Video, if it's in the database<br />
|-<br />
| VideoPlayer.Studio<br />
| Studio of current Music Video, if it's in the database<br />
|-<br />
| VideoPlayer.Writer<br />
| Name of Writer of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.Tagline<br />
| Small Summary of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.PlotOutline<br />
| Small Summary of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.Plot<br />
| Complete Text Summary of current playing Video, if it's in the database<br />
|-<br />
| VideoPlayer.LastPlayed<br />
| Last play date of current playing Video, if it's in the database<br />
|- class="userrow<br />
| VideoPlayer.PlayCount<br />
| Playcount of current playing Video, if it's in the database<br />
|- class="userrow<br />
| VideoPlayer.VideoCodec<br />
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)<br />
|-<br />
| VideoPlayer.VideoResolution<br />
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)<br />
|-<br />
| VideoPlayer.VideoAspect<br />
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)<br />
|-<br />
| VideoPlayer.AudioCodec<br />
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)<br />
|-<br />
| VideoPlayer.AudioChannels<br />
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)<br />
|-<br />
| VideoPlayer.AudioLanguage<br />
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)<br />
|-<br />
| VideoPlayer.SubtitlesLanguage<br />
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)<br />
|-<br />
| VideoPlayer.StereoscopicMode<br />
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)<br />
|-<br />
| VideoPlayer.EndTime<br />
| End date of the currently playing programme (PVR).<br />
|-<br />
| VideoPlayer.NextTitle<br />
| Title of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextGenre<br />
| Genre of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextPlot<br />
| Plot of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextPlotOutline<br />
| Plot outline of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextStartTime<br />
| Start time of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextEndTime<br />
| End time of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.NextDuration<br />
| Duration of the programme that will be played next (PVR).<br />
|-<br />
| VideoPlayer.ChannelName<br />
| Name of the curently tuned channel (PVR).<br />
|-<br />
| VideoPlayer.ChannelNumber<br />
| Number of the curently tuned channel (PVR).<br />
|-<br />
| VideoPlayer.SubChannelNumber<br />
| Subchannel number of the tv channel that's currently playing (PVR).<br />
|-<br />
| VideoPlayer.ChannelNumberLabel<br />
| Channel and subchannel number of the tv channel that's currently playing (PVR).<br />
|-<br />
| VideoPlayer.ChannelGroup<br />
| Group of the curently tuned channel (PVR).<br />
|-<br />
| VideoPlayer.ParentalRating<br />
| Parental rating of the currently playing programme (PVR).<br />
|}<br />
<br />
=== Playlist ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Playlist.Length(media)<br />
| Total size of the current playlist. optional parameter media is either video or music.<br />
|-<br />
| Playlist.Position(media)<br />
| Position of the current item in the current playlist. optional parameter media is either video or music.<br />
|-<br />
| Playlist.Random<br />
| Returns string ID's 590 (Randomize Play Enabled) or 591 (Disabled)<br />
|-<br />
| Playlist.Repeat<br />
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)<br />
|}<br />
<br />
=== PVR ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Pvr.NowRecordingTitle<br />
| Title of the programme being recorded<br />
|-<br />
| Pvr.NowRecordingDateTime<br />
| Start date and time of the current recording<br />
|-<br />
| Pvr.NowRecordingChannel<br />
| Channel number that's being recorded<br />
|-<br />
| Pvr.NextRecordingTitle<br />
| Title of the next programme that will be recorded<br />
|-<br />
| Pvr.NextRecordingDateTime<br />
| Start date and time of the next recording<br />
|-<br />
| Pvr.NextRecordingChannel<br />
| Channel name of the next recording<br />
|-<br />
| Pvr.BackendName<br />
| Name of the backend being used<br />
|-<br />
| Pvr.BackendVersion<br />
| Version of the backend that's being used<br />
|-<br />
| Pvr.BackendHost<br />
| Backend hostname<br />
|-<br />
| Pvr.BackendDiskSpace<br />
| Available diskspace on the backend<br />
|-<br />
| Pvr.BackendChannels<br />
| Number of available channels the backend provides<br />
|-<br />
| Pvr.BackendTimers<br />
| Number of timers set for the backend<br />
|-<br />
| Pvr.BackendRecordings<br />
| Number of recording available on the backend<br />
|- <br />
| Pvr.BackendDiskspace<br />
| Free diskspace available for recordings on the backend<br />
|-<br />
| Pvr.BackendNumber<br />
| Backend number<br />
|-<br />
| Pvr.TotalDiscSpace<br />
| Total diskspace available for recordings<br />
|-<br />
| Pvr.NextTimer<br />
| Next timer date<br />
|-<br />
| Pvr.Duration<br />
| {{?}}<br />
|-<br />
| Pvr.Time<br />
| {{?}}<br />
|-<br />
| Pvr.Progress<br />
| {{?}}<br />
|-<br />
| Pvr.TimeShiftStart<br />
| Start position of the timeshift<br />
|-<br />
| Pvr.TimeShiftEnd<br />
| End position of the timeshift<br />
|-<br />
| Pvr.TimeShiftCur<br />
| Current position of the timeshift<br />
|-<br />
| Pvr.TimeShiftProgress<br />
| {{?}}<br />
|-<br />
| Pvr.ActStreamClient<br />
| Stream client name<br />
|-<br />
| Pvr.ActStreamDevice<br />
| Stream device name<br />
|-<br />
| Pvr.ActStreamStatus<br />
| Status of the stream<br />
|-<br />
| Pvr.ActStreamSignal<br />
| Signal quality of the stream<br />
|-<br />
| Pvr.ActStreamSnr<br />
| Signal to noise ratio of the stream<br />
|-<br />
| Pvr.ActStreamBer<br />
| Bit error rate of the stream<br />
|-<br />
| Pvr.ActStreamUnc<br />
| UNC value of the stream<br />
|-<br />
| Pvr.ActStreamVideoBitRate<br />
| Video bitrate of the stream<br />
|-<br />
| Pvr.ActStreamAudioBitRate<br />
| Audio bitrate of the stream<br />
|-<br />
| Pvr.ActStreamDolbyBitRate<br />
| Dolby bitrate of the stream<br />
|-<br />
| Pvr.ActStreamProgrSignal<br />
| Signal quality of the programme<br />
|-<br />
| Pvr.ActStreamProgrSnr<br />
| Signal to noise ratio of the programme<br />
|-<br />
| Pvr.ActStreamEncryptionName<br />
| Encryption used on the stream<br />
|}<br />
<br />
=== RDS ===<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| RDS.AudioLanguage<br />
| <br />
|-<br />
| RDS.ChannelCountry<br />
| <br />
|-<br />
| RDS.Title<br />
| <br />
|-<br />
| RDS.GetLine<br />
| <br />
|-<br />
| RDS.Artist<br />
| <br />
|-<br />
| RDS.Band<br />
| <br />
|-<br />
| RDS.Composer<br />
| <br />
|-<br />
| RDS.Conductor<br />
| <br />
|-<br />
| RDS.Album<br />
| <br />
|-<br />
| RDS.TrackNumber<br />
| <br />
|-<br />
| RDS.RadioStyle<br />
| <br />
|-<br />
| RDS.Comment<br />
| <br />
|-<br />
| RDS.InfoNews<br />
| <br />
|-<br />
| RDS.InfoNewsLocal<br />
| <br />
|-<br />
| RDS.InfoStock<br />
| <br />
|-<br />
| RDS.InfoStockSize<br />
| <br />
|-<br />
| RDS.InfoSport<br />
| <br />
|-<br />
| RDS.InfoSportSize<br />
| <br />
|-<br />
| RDS.InfoLottery<br />
| <br />
|-<br />
| RDS.InfoLotterySize<br />
| <br />
|-<br />
| RDS.InfoWeather<br />
| <br />
|-<br />
| RDS.InfoWeatherSize<br />
| <br />
|-<br />
| RDS.InfoCinema<br />
| <br />
|-<br />
| RDS.InfoCinemaSize<br />
| <br />
|-<br />
| RDS.InfoHoroscope<br />
| <br />
|-<br />
| RDS.InfoHoroscopeSize<br />
| <br />
|-<br />
| RDS.InfoOther<br />
| <br />
|-<br />
| RDS.InfoOtherSize<br />
| <br />
|-<br />
| RDS.ProgStation<br />
| <br />
|-<br />
| RDS.ProgNow<br />
| <br />
|-<br />
| RDS.ProgNext<br />
| <br />
|-<br />
| RDS.ProgHost<br />
| <br />
|-<br />
| RDS.ProgEditStaff<br />
| <br />
|-<br />
| RDS.ProgHomepage<br />
| <br />
|-<br />
| RDS.ProgStyle<br />
| <br />
|-<br />
| RDS.PhoneHotline<br />
| <br />
|-<br />
| RDS.PhoneStudio<br />
| <br />
|-<br />
| RDS.SmsStudio<br />
| <br />
|-<br />
| RDS.EmailHotline<br />
| <br />
|-<br />
| RDS.EmailStudio<br />
| <br />
|}<br />
<br />
=== Skin ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Skin.CurrentTheme<br />
| Returns the current selected skin theme.<br />
|-<br />
| Skin.CurrentColourTheme<br />
| Returns the current selected colour theme of the skin.<br />
|-<br />
| Skin.String(name)<br />
| 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.<br />
|-<br />
| Skin.AspectRatio<br />
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.<br />
|}<br />
<br />
=== Slideshow ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|- <br />
| Slideshow.Altitude<br />
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.<br />
|-<br />
| Slideshow.Aperture<br />
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).<br />
|-<br />
| Slideshow.Author<br />
| 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).<br />
|-<br />
| Slideshow.Byline<br />
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).<br />
|-<br />
| Slideshow.BylineTitle<br />
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).<br />
|-<br />
| Slideshow.CameraMake<br />
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).<br />
|-<br />
| Slideshow.CameraModel<br />
| 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).<br />
|-<br />
| Slideshow.Caption<br />
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).<br />
|-<br />
| Slideshow.Category<br />
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).<br />
|-<br />
| Slideshow.CCDWidth<br />
| 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).<br />
|-<br />
| Slideshow.City<br />
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).<br />
|-<br />
| Slideshow.Colour<br />
| Shows whether the current picture is "Colour" or "Black and White".<br />
|-<br />
| Slideshow.CopyrightNotice<br />
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).<br />
|-<br />
| Slideshow.Country<br />
| 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).<br />
|-<br />
| Slideshow.CountryCode<br />
| 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).<br />
|-<br />
| Slideshow.Credit<br />
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).<br />
|-<br />
| Slideshow.DigitalZoom<br />
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404). <br />
|-<br />
| Slideshow.EXIFComment<br />
| 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.<br />
|-<br />
| Slideshow.EXIFDate<br />
| 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.<br />
|-<br />
| Slideshow.EXIFDescription<br />
| 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).<br />
|-<br />
| Slideshow.EXIFSoftware<br />
| 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).<br />
|-<br />
| Slideshow.EXIFTime<br />
| 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.<br />
|-<br />
| Slideshow.Exposure<br />
| 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).<br />
|-<br />
| Slideshow.ExposureBias<br />
| 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).<br />
|-<br />
| Slideshow.ExposureMode<br />
| 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).<br />
|-<br />
| Slideshow.ExposureTime<br />
| 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.<br />
|-<br />
| Slideshow.Filedate<br />
| Shows the file date of the current picture<br />
|-<br />
| Slideshow.Filename<br />
| Shows the file name of the current picture<br />
|-<br />
| Slideshow.Filesize<br />
| Shows the file size of the current picture<br />
|-<br />
| Slideshow.FlashUsed<br />
| 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). <br />
|-<br />
| Slideshow.FocalLength<br />
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).<br />
|-<br />
| Slideshow.FocusDistance<br />
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).<br />
|-<br />
| Slideshow.Headline<br />
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).<br />
|-<br />
| Slideshow.ImageType<br />
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).<br />
|-<br />
| Slideshow.IPTCDate<br />
| 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).<br />
|-<br />
| Slideshow.ISOEquivalence<br />
| 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).<br />
|-<br />
| Slideshow.Keywords<br />
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).<br />
|-<br />
| Slideshow.Latitude<br />
| 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.<br />
|-<br />
| Slideshow.LightSource<br />
| 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).<br />
|-<br />
| Slideshow.LongEXIFDate<br />
| 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.<br />
|-<br />
| Slideshow.LongEXIFTime<br />
| 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.<br />
|-<br />
| Slideshow.Longitude<br />
| 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.<br />
|-<br />
| Slideshow.MeteringMode<br />
| 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).<br />
|-<br />
| Slideshow.ObjectName<br />
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).<br />
|-<br />
| Slideshow.Orientation<br />
| 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).<br />
|-<br />
| Slideshow.Path<br />
| Shows the file path of the current picture<br />
|-<br />
| Slideshow.Process<br />
| Shows the process used to compress the current picture<br />
|-<br />
| Slideshow.ReferenceService<br />
| 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).<br />
|-<br />
| Slideshow.Resolution<br />
| Shows the dimensions of the current picture (Width x Height)<br />
|-<br />
| Slideshow.SlideComment<br />
| 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.<br />
|-<br />
| Slideshow.SlideIndex<br />
| Shows the slide index of the current picture<br />
|-<br />
| Slideshow.Source<br />
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).<br />
|-<br />
| Slideshow.SpecialInstructions<br />
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).<br />
|-<br />
| Slideshow.State<br />
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).<br />
|-<br />
| Slideshow.Sublocation<br />
| 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).<br />
|-<br />
| Slideshow.SupplementalCategories<br />
| 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).<br />
|-<br />
| Slideshow.TimeCreated<br />
| 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).<br />
|-<br />
| Slideshow.TransmissionReference<br />
| 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).<br />
|-<br />
| Slideshow.Urgency<br />
| 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).<br />
|-<br />
| Slideshow.WhiteBalance<br />
| 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).<br />
|}<br />
<br />
=== System ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| System.Time<br />
| Current time<br />
|-<br />
| System.Time(format)<br />
| 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<br />
|-<br />
| System.Date<br />
| Current date<br />
|-<br />
| System.Date(format)<br />
| 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.<br />
|-<br />
| System.AlarmPos<br />
| Shutdown Timer position<br />
|-<br />
| System.BatteryLevel<br />
| Returns the remaining battery level in range 0-100<br />
|-<br />
| System.FreeSpace<br />
| Total Freespace on the drive<br />
|-<br />
| System.UsedSpace<br />
| Total Usedspace on the drive<br />
|-<br />
| System.TotalSpace<br />
| Totalspace on the drive<br />
|-<br />
| System.UsedSpacePercent<br />
| Total Usedspace Percent on the drive<br />
|-<br />
| System.FreeSpacePercent<br />
| Total Freespace Percent on the drive<br />
|-<br />
| System.CPUTemperature<br />
| Current CPU temperature<br />
|-<br />
| System.CpuUsage<br />
| Displays the cpu usage for each individual cpu core.<br />
|-<br />
| System.CoreUsage(id)<br />
| Displays the usage of the cpu core with the given 'id'<br />
|-<br />
| System.GPUTemperature<br />
| Current GPU temperature<br />
|-<br />
| System.FanSpeed<br />
| Current fan speed<br />
|-<br />
| System.BuildVersion<br />
| Version of build<br />
|-<br />
| System.BuildDate<br />
| Date of build<br />
|-<br />
| System.FriendlyName<br />
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. eg. "Kodi (htpc)"<br />
|-<br />
| System.FPS<br />
| Current rendering speed (frames per second)<br />
|-<br />
| System.FreeMemory<br />
| Amount of free memory in Mb<br />
|-<br />
| System.Memory(format)<br />
| Available formats: used, used.percent, free, free.percent, total<br />
|-<br />
| System.ScreenMode<br />
| Screenmode (eg windowed / fullscreen)<br />
|-<br />
| System.ScreenWidth<br />
| Width of screen in pixels<br />
|-<br />
| System.ScreenHeight<br />
| Height of screen in pixels<br />
|-<br />
| System.StartupWindow<br />
| The Window Kodi will load on startup<br />
|-<br />
| System.CurrentWindow<br />
| Current Window we are in<br />
|-<br />
| System.CurrentControl<br />
| Current focused control<br />
|-<br />
| System.DVDLabel<br />
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive<br />
|-<br />
| System.HddTemperature<br />
| Hdd temperature<br />
|-<br />
| System.KernelVersion<br />
| System kernel version<br />
|-<br />
| System.Uptime<br />
| System current uptime<br />
|-<br />
| System.TotalUptime<br />
| System total uptime<br />
|-<br />
| System.CpuFrequency<br />
| System cpu frequency<br />
|-<br />
| System.ScreenResolution<br />
| Screen resolution<br />
|-<br />
| System.VideoEncoderInfo<br />
| Video encoder info<br />
|-<br />
| System.InternetState<br />
| Will return the internet state, connected or not connected<br />
and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.<br />
|-<br />
| System.Language<br />
| Shows the current language<br />
|-<br />
| System.GetBool(boolean)<br />
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml<br />
|-<br />
| System.ProfileName<br />
| Shows the User name of the currently logged in Kodi user<br />
|-<br />
| System.ProfileCount<br />
| Shows the number of defined profiles<br />
|-<br />
| System.ProfileAutoLogin<br />
| The profile Kodi will auto login to<br />
|-<br />
| System.StereoscopicMode<br />
| The prefered stereoscopic mode (settings > video > playback)<br />
|-<br />
| System.TemperatureUnits<br />
| Shows Celsius or Fahrenheit symbol<br />
|-<br />
| System.AddonTitle(id)<br />
| Returns the title of the addon with the given id<br />
|-<br />
| System.AddonVersion(id)<br />
| Returns the version of the addon with the given id<br />
|}<br />
<br />
=== Visualisation ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Visualisation.Preset<br />
| Shows the current preset of the visualisation.<br />
|-<br />
| Visualisation.Name<br />
| Shows the name of the visualisation.<br />
|}<br />
<br />
=== Weather labels ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Weather.Conditions<br />
| Current weather conditions – this is looked up in a background process.<br />
|-<br />
| Weather.Temperature<br />
| Current weather temperature<br />
|-<br />
| Weather.Location<br />
| City/town which the above two items are for<br />
|-<br />
| Weather.fanartcode<br />
| Current weather fanartcode.<br />
|-<br />
| Weather.plugin<br />
| Current weather plugin.<br />
|}<br />
<br />
=== Window ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Window([window]).Property(key)<br />
| Window property. (key can be any value, optional window can be id or name)<br />
|-<br />
| Window.Property(xmlfile)<br />
| Displays the name of the xml file currently shown<br />
|-<br />
| Window(AddonBrowser).Property(Updated)<br />
| Shows the date and time the addon repo was last checked for updates<br />
|-<br />
| Window(Home).Property(key)<br />
| The home window has the following info labels.<br />
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<br />
<br />
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<br />
<br />
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<br />
<br />
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<br />
<br />
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<br />
<br />
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<br />
|-<br />
| Window(Weather).Property(key)<br />
| The weather window has the following info labels.<br />
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<br />
<br />
<br />
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<br />
|}<br />
<br />
=== Images Available in Kodi ===<br />
<br />
{| class="prettytable" width="100%"<br />
! InfoLabels<br />
! style="80%" | Definition<br />
|-<br />
| Container.Art(tvshow.fanart)<br />
| Fanart Image of the parent TV show<br />
|-<br />
| Container.Art(season.poster)<br />
| Thumbnail Image of the parent season<br />
|-<br />
| Container.Art(artist.fanart)<br />
| Fanart Image of the parent album artist<br />
|-<br />
| Container.Art(artist.thumb)<br />
| Thumbnail Image of the parent album artist<br />
|-<br />
| Fanart.Image<br />
| Fanart image for the parent TV Show<br />
|-<br />
| ListItem.Thumb<br />
| 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).<br />
|-<br />
| ListItem.Icon<br />
| 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 icon.<br />
|-<br />
| ListItem.ActualIcon<br />
| Shows the icon of the currently selected item in a list or thumb control.<br />
|-<br />
| ListItem.Art(clearart)<br />
| Returns the clearart (if it exists) of the currently selected movie or tv show.<br />
|-<br />
| ListItem.Art(clearlogo)<br />
| Returns the clearlogo (if it exists) of the currently selected movie or tv show.<br />
|-<br />
| ListItem.Art(thumb)<br />
| Returns the thumbnail of the currently selected item.<br />
|-<br />
| ListItem.Art(poster)<br />
| Returns the poster of the currently selected movie or tv show.<br />
|-<br />
| ListItem.Art(banner)<br />
| Returns the banner of the currently selected tv show.<br />
|-<br />
| ListItem.Art(fanart)<br />
| Returns the fanart image of the currently selected item.<br />
|-<br />
| ListItem.Art(set.fanart)<br />
| Returns the fanart image of the currently selected movieset.<br />
|-<br />
| ListItem.Art(landscape)<br />
| Returns the landscape art of the currently selected item.<br />
|-<br />
| ListItem.Art(tvshow.poster)<br />
| Returns the tv show poster of the parent container.<br />
|-<br />
| ListItem.Art(tvshow.banner)<br />
| Returns the tv show banner of the parent container.<br />
|-<br />
| ListItem.Art(season.poster)<br />
| Returns the season poster of the currently selected season. (Only available in DialogVideoInfo.xml)<br />
|-<br />
| ListItem.Art(season.banner)<br />
| Returns the season banner of the currently selected season. (Only available in DialogVideoInfo.xml)<br />
|-<br />
| ListItem.Art(season.fanart)<br />
| Returns the fanart image of the currently selected season. (Only available in DialogVideoInfo.xml)<br />
|-<br />
| ListItem.Overlay<br />
| 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.<br />
|-<br />
| ListItem.StarRating<br />
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin<br />
|-<br />
| ListItem.Property(ArtistThumb)<br />
| Thumbnail Image of the parent artist, for use in dialogalbuminfo.xml and dialogsonginfo.xml<br />
|-<br />
| ListItem.Property(Addon.StarRating)<br />
| Returns a value of rating0.png to rating5.png for the currently selected addon<br />
|-<br />
| ListItem.Property(Fanart_Image)<br />
| Fanart Image currently selected item or of the parent TV show<br />
|-<br />
| ListItem.Property(SeasonThumb)<br />
| Thumbnail Image of the parent TV show season, for use in dialogvideoinfo.xml<br />
|-<br />
| ListItem.Property(TVShowThumb)<br />
| Thumbnail Image of the parent TV show, for use in dialogvideoinfo.xml (available anywhere)<br />
|-<br />
| MusicPlayer.Cover<br />
| Cover of currently playing album<br />
|-<br />
| MusicPlayer.Property(Fanart_Image)<br />
| Fanart image of the currently playing artist<br />
|-<br />
| Player.Art(fanart)<br />
| Fanart Image of the currently playing episode's parent TV show <br />
|-<br />
| Player.Art(thumb)<br />
| Returns the thumbnail image of the currently playing item.<br />
|-<br />
| Player.Art(poster)<br />
| Returns the poster of the currently playing movie.<br />
|-<br />
| Player.Art(tvshow.poster)<br />
| Returns the tv show poster of the currently playing episode's parent TV show.<br />
|-<br />
| Player.Art(tvshow.banner)<br />
| Returns the tv show banner of the currently playing episode's parent TV show.<br />
|-<br />
| Player.StarRating<br />
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin<br />
|-<br />
| Pvr.NowRecordingChannelIcon<br />
| Channel icon of the programme currently being recorded.<br />
|-<br />
| Pvr.NextRecordingChannelIcon<br />
| Channel icon of the programme that will be recorded next.<br />
|-<br />
| Skin.String(name)<br />
| 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.<br />
|-<br />
| System.AddonIcon(id)<br />
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (eg. $INFO[Skin.String(Foo)])<br />
|-<br />
| System.ProfileThumb<br />
| Shows the Thumbnail image of the currently logged in Kodi user<br />
|-<br />
| VideoPlayer.Cover<br />
| Cover of currently playing movie<br />
|-<br />
| Weather.Conditions<br />
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)<br />
|-<br />
| Window([window]).Property(key)<br />
| Window property. (key can be any value, optional window can be id or name)<br />
|-<br />
| Window(Weather).Property(key)<br />
| The weather window has the following info images.<br />
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo<br />
|}<br />
<br />
<section end="main content" /><br />
<br />
== See also ==<br />
'''Development:'''<br />
* [[Add-on development]]<br />
* [[Skinning]]<br />
<br />
[[Category:Skin development]]<br />
[[Category:Add-on development]]</div>Phil65https://kodi.wiki/index.php?title=List_of_built-in_functions&diff=117481List of built-in functions2016-03-08T02:42:41Z<p>Phil65: </p>
<hr />
<div>{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}<br />
<section begin="main content" /><br />
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>.<br />
<br />
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].<br />
<br />
In addition to the following list, for most <onclick> and <onfocus> button actions in the skin you can also use the functions from [[Keyboard.xml]].<br />
<br />
<poem><br />
'''Example:'''<br />
<onclick>VolumeUp</onclick><br />
<onclick>VolumeDown</onclick><br />
</poem><br />
<br />
'''You can use parameters with all media windows, as can be seen here:'''<br />
* [[Opening Windows and Dialogs]]<br />
<br />
== List of functions ==<br />
<section begin="functions" /><br />
{| class="prettytable sort sortable"<br />
! Function<br />
! Description<br />
! Version<br />
|-<br />
| <code>Action(action[,window])</code><br />
| 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 here for a list of window names, and their respective ids. <br />
| <br />
|-<br />
| <code>ActivateScreensaver</code><br />
| Starts the screensaver<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>ActivateWindow(window[,dir,return])</code><br />
| 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 here for a list of window names, and their respective ids. If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder Kodi should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that Kodi should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating. <br />
| <br />
|-<br />
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code><br />
| 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).<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>Addon.Default.OpenSettings(extensionpoint)</code><br />
| Open a settings dialog for the default addon of the given type (extensionpoint)<br />
| <br />
|-<br />
| <code>Addon.Default.Set(extensionpoint)</code><br />
| Open a select dialog to allow choosing the default addon of the given type (extensionpoint)<br />
| <br />
|-<br />
| <code>Addon.OpenSettings(id)</code><br />
| Open a settings dialog for the addon of the given id <br />
| <br />
|-<br />
| <code>AlarmClock(name,command,time[,silent,loop])</code><br />
| Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the 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. <br />
| <br />
|-<br />
| <code>AllowIdleShutdown</code><br />
| Allow the system to shutdown on idle.<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>CancelAlarm(name[,silent])</code><br />
| Cancel a running alarm. Set silent to true to hide the alarm notification. <br />
| <br />
|-<br />
| <code>CECActivateSource</code><br />
| Wake up playing device via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CECStandby</code><br />
| Put playing device on standby via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CECToggleState</code><br />
| Toggle state of playing device via a CEC peripheral<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>CleanLibrary(database)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ClearProperty(key[,id])</code><br />
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id). <br />
| <br />
|-<br />
| <code>Container.NextSortMethod</code><br />
| Change to the next sort method. <br />
| <br />
|-<br />
| <code>Container.NextViewMode</code><br />
| Select the next view mode. <br />
| <br />
|-<br />
| <code>Container.PreviousSortMethod</code><br />
| Change to the previous sort method. <br />
| <br />
|-<br />
| <code>Container.PreviousViewMode</code><br />
| Select the previous view mode. <br />
| <br />
|-<br />
| <code>Container.Refresh</code><br />
| Refresh current listing. <br />
| <br />
|-<br />
| <code>Container.SetSortMethod(id)</code><br />
| Change to the specified sort method. (For list of ID's see List of sort methods below) <br />
| <br />
|-<br />
| <code>Container.SetViewMode(id)</code><br />
| Set the current view mode (list, icons etc.) to the given container id. <br />
| <br />
|-<br />
| <code>Container.SetSortDirection</code><br />
| Toggle the sort direction. <br />
| <br />
|-<br />
| <code>Container.Update</code><br />
| Update current listing. Send Container.Update(path,replace) to reset the path history. <br />
| <br />
|-<br />
| <code>Control.Message(id,message,[windowid])</code><br />
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click. <br />
| <br />
|-<br />
| <code>Control.Move(id,offset)</code><br />
| Will make a Container with the "id" specified in the command move focus by "offset". <br />
| <br />
|-<br />
| <code>Control.SetFocus(id,position)</code><br />
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position) <br />
| <br />
|-<br />
| <code>Dialog.Close(dialog[,force])</code><br />
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once. <br />
| <br />
|-<br />
| <code>EjectTray()</code><br />
| Either opens or closes the DVD tray, depending on its current state <br />
| <br />
|-<br />
| <code>exportlibrary(music,false,filepath)</code><br />
| The music library will be exported to a single file stored at filepath location. <br />
| <br />
|-<br />
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code><br />
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false). <br />
| <br />
|-<br />
| <code>Extract</code><br />
| Extracts a specified archive to an optionally specified 'absolute' path. <br />
| <br />
|-<br />
| <code>Help</code><br />
| This help message (??? probably broken) <br />
| <br />
|-<br />
| <code>Hibernate</code><br />
| Hibernate (S4) the System <br />
| <br />
|-<br />
| <code>InhibitIdleShutdown(true/false)</code><br />
| Prevent the system to shutdown on idle.<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>LIRC.Send(command)</code><br />
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup) <br />
| <br />
|-<br />
| <code>LIRC.Start</code><br />
| Adds Kodi as a LIRC client. <br />
| <br />
|-<br />
| <code>LIRC.Stop</code><br />
| Removes Kodi as a LIRC client. <br />
| <br />
|-<br />
| <code>LoadProfile(profilename,[prompt])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Mastermode</code><br />
| Runs Kodi in master mode <br />
| <br />
|-<br />
| <code>Minimize</code><br />
| Minimizes Kodi <br />
| <br />
|-<br />
| <code>Mute</code><br />
| Mutes (or unmutes) the volume. <br />
| <br />
|-<br />
| <code>NextChannelGroup</code><br />
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>NextStereoMode</code><br />
| Changes the stereo mode of the GUI to the next available mode.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>Notification(header,message[,time,image])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>NotifyAll</code><br />
| Notify all connected clients<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PageDown</code><br />
| Send a page down event to the pagecontrol with given id. <br />
| <br />
|-<br />
| <code>PageUp</code><br />
| Send a page up event to the pagecontrol with given id. <br />
| <br />
|-<br />
| <code>PlayDVD</code><br />
| Will play the inserted CD or DVD media from the DVD-ROM drive. <br />
| <br />
|-<br />
| <code>PlayerControl(command)</code><br />
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file), and Record. Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. <br />
| <br />
|-<br />
| <code>Playlist.Clear</code><br />
| Clear the current playlist <br />
| <br />
|-<br />
| <code>Playlist.PlayOffset</code><br />
| Start playing from a particular offset in the playlist <br />
| <br />
|-<br />
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code><br />
| Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. <br />
| <br />
|-<br />
| <code>PlayWith()</code><br />
| Play the selected item with the specified player core. <br />
| <br />
|-<br />
| <code>Powerdown</code><br />
| Powerdown system <br />
| <br />
|-<br />
| <code>PreviousChannelGroup</code><br />
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PreviousStereoMode</code><br />
| Changes the stereo mode of the GUI to the previous available mode.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>PVR.SearchMissingChannelIcons</code><br />
| Will start a search for missing channel icons<br />
| {{nowrap|v16 Addition}}<br />
|-<br />
| <code>Quit</code><br />
| Quits Kodi <br />
| <br />
|-<br />
| <code>Reboot</code><br />
| Cold reboots the system (power cycle) <br />
| <br />
|-<br />
| <code>RecursiveSlideShow(dir)</code><br />
| Run a slideshow from the specified directory, including all subdirs <br />
| <br />
|-<br />
| <code>RefreshRSS</code><br />
| Reload RSS feeds from RSSFeeds.xml <br />
| <br />
|-<br />
| <code>ReloadSkin()</code><br />
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling) <br />
| <br />
|-<br />
| <code>ReplaceWindow(window,dir)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code><br />
| 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).<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>Reset</code><br />
| Reset the system (same as reboot) <br />
| <br />
|-<br />
| <code>Resolution</code><br />
| Change Kodi's Resolution. <br />
| <br />
|-<br />
| <code>RestartApp</code><br />
| Restarts Kodi (only implemented under Windows and Linux) <br />
| <br />
|-<br />
| <code>RipCD</code><br />
| Will rip the inserted CD from the DVD-ROM drive. <br />
| <br />
|-<br />
| <code>RunAddon(id)</code><br />
| Runs the specified plugin/script <br />
| <br />
|-<br />
| <code>RunAppleScript(script[,args]*)</code><br />
| Run the specified AppleScript command <br />
| <br />
|-<br />
| <code>RunPlugin(plugin)</code><br />
| Runs the plugin. Full path must be specified. Does not work for folder plugins <br />
| <br />
|-<br />
| <code>RunScript(script[,args]*)</code><br />
| Runs the python script. You must specify the full path to the script. One way to specify the full path is through the [[Special protocol|special protocol]]. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv <br />
| <br />
|-<br />
| <code>Seek(seconds)</code><br />
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.<br />
| {{nowrap|v15 Addition}}<br />
|-<br />
| <code>SendClick(windowid,id)</code><br />
| Sends a click to a control in a given window (or active window if omitted). <br />
| <br />
|-<br />
| <code>SetFocus(id,position)</code><br />
| Will make a container with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position) <br />
| <br />
|-<br />
| <code>SetGUILanguage</code><br />
| Set GUI Language<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>SetProperty(key,value[,id])</code><br />
| Sets a window property for the current window (key,value), or the specified window (key,value,id). <br />
| <br />
|-<br />
| <code>SetStereoMode</code><br />
| 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)<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>settingslevelchange</code><br />
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>SetVolume(percent[,showvolumebar])</code><br />
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume. <br />
| <br />
|-<br />
| <code>ShowPicture(picture)</code><br />
| Show a picture by its file path/url.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>ShutDown</code><br />
| Trigger default Shutdown action defined in System Settings <br />
| <br />
|-<br />
| <code>Skin.Reset(setting)</code><br />
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty. <br />
| <br />
|-<br />
| <code>Skin.ResetSettings</code><br />
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.) <br />
| <br />
|-<br />
| <code>Skin.SetAddon(string,type)</code><br />
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image and xbmc.addon.executable. <br />
| <br />
|-<br />
| <code>Skin.SetBool(setting)</code><br />
| Sets the skin setting ?setting? to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings. <br />
| <br />
|-<br />
| <code>Skin.SetFile(string,mask,folderpath)</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetImage(string[,value,path])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetLargeImage(string[,value])</code><br />
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the 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. <br />
| <br />
|-<br />
| <code>Skin.SetNumeric(numeric[,value])</code><br />
| Pops up a keyboard dialog and allows the user to input a numerical. <br />
| <br />
|-<br />
| <code>Skin.SetPath(string[,folderpath])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.SetString(string[,value])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>Skin.Theme</code><br />
| Cycles the skin theme. Skin.theme(-1) will go backwards. <br />
| <br />
|-<br />
| <code>Skin.ToggleDebug</code><br />
| Toggles skin debug info on/off <br />
| <br />
|-<br />
| <code>Skin.ToggleSetting(setting)</code><br />
| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting). <br />
| <br />
|-<br />
| <code>SlideShow(dir [,recursive, [not]random])</code><br />
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window. <br />
| <br />
|-<br />
| <code>StartAndroidActivity(package,[intent,dataType,dataURI])</code><br />
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>StartPVRManager</code><br />
| (Re)Starts the PVR manager<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>StereoModeToMono</code><br />
| Toggle the stereoscopic mode to 2D.<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>StopPVRManager</code><br />
| Stops the PVR manager<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>StopScript(id)</code><br />
| Stop the script by ID or path, if running<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>Suspend</code><br />
| Suspends (S3 / S1 depending on bios setting) the System <br />
| <br />
|-<br />
| <code>System.Exec</code><br />
| Execute shell commands. <br />
| <br />
|-<br />
| <code>System.ExecWait</code><br />
| Execute shell commands and freezes Kodi until shell is closed. <br />
| <br />
|-<br />
| <code>System.LogOff</code><br />
| Log off current user. <br />
| <br />
|-<br />
| <code>TakeScreenshot</code><br />
| Takes a Screenshot <br />
| <br />
|-<br />
| <code>ToggleDebug</code><br />
| Enables/disables debug mode<br />
| {{nowrap|v12 Addition}}<br />
|-<br />
| <code>ToggleDirtyRegionVisualization</code><br />
| makes dirty regions visible for debugging proposes.<br />
| {{nowrap|v16 Addition}}<br />
|-<br />
| <code>ToggleDPMS</code><br />
| Toggle DPMS mode manually <br />
| <br />
|-<br />
| <code>ToggleStereoMode</code><br />
| Toggle the stereoscopic mode of the GUI (on/off).<br />
| {{nowrap|v13 Addition}}<br />
|-<br />
| <code>UnloadSkin()</code><br />
| Unloads the current skin <br />
| <br />
|-<br />
| <code>UpdateAddonRepos</code><br />
| Triggers a forced update of enabled add-on repositories. <br />
| <br />
|-<br />
| <code>UpdateLibrary(database,[path])</code><br />
| 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. <br />
| <br />
|-<br />
| <code>UpdateLocalAddons</code><br />
| Triggers a scan of local add-on directories. <br />
| <br />
|-<br />
| <code>VideoLibrary.Search</code><br />
| Brings up a search dialog which will search the library <br />
| <br />
|-<br />
| <code>WakeOnLan(mac)</code><br />
| 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). <br />
| <br />
|-<br />
| <code>Weather.LocationNext</code><br />
| Switch to next weather location <br />
| <br />
|-<br />
| <code>Weather.LocationPrevious</code><br />
| Switch to previous weather location <br />
| <br />
|-<br />
| <code>Weather.LocationSet</code><br />
| Switch to given weather location (parameter can be 1-3) <br />
| <br />
|-<br />
| <code>Weather.Refresh</code><br />
| Force weather data refresh<br />
| <br />
|}<br />
<section end="functions" /><br />
<section end="main content" /><br />
<br />
== Removed functions ==<br />
* <code>LastFM.Love</code> - Removed in v13 Gotham<br />
* <code>LastFM.Ban</code> - Removed in v13 Gotham<br />
* <code>LCD.Suspend</code> - Removed in v13 Gotham<br />
* <code>LCD.Resume</code> - Removed in v13 Gotham<br />
<br />
== List of sort methods ==<br />
These ID's can be used with the Container.SetSortMethod(id) function as listed [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.cpp#L529-L577 here]:<br />
{| class="prettytable"<br />
! ID<br />
! Description<br />
|-<br />
| <code>1</code><br />
| Name<br />
|-<br />
| <code>2</code><br />
| Date<br />
|-<br />
| <code>3</code><br />
| Size<br />
|-<br />
| <code>4</code><br />
| File<br />
|-<br />
| <code>5</code><br />
| Path<br />
|-<br />
| <code>6</code><br />
| DriveType<br />
|-<br />
| <code>7</code><br />
| Title<br />
|-<br />
| <code>8</code><br />
| TrackNumber<br />
|-<br />
| <code>9</code><br />
| Time<br />
|-<br />
| <code>10</code><br />
| Artist<br />
|-<br />
| <code>11</code><br />
| Album<br />
|-<br />
| <code>12</code><br />
| AlbumType<br />
|-<br />
| <code>13</code><br />
| Genre<br />
|-<br />
| <code>14</code><br />
| Country<br />
|-<br />
| <code>15</code><br />
| Year<br />
|-<br />
| <code>16</code><br />
| Rating<br />
|-<br />
| <code>17</code><br />
| Votes<br />
|-<br />
| <code>18</code><br />
| Top250<br />
|-<br />
| <code>19</code><br />
| ProgramCount<br />
|-<br />
| <code>20</code><br />
| PlaylistOrder<br />
|-<br />
| <code>21</code><br />
| EpisodeNumber<br />
|-<br />
| <code>22</code><br />
| Season<br />
|-<br />
| <code>23</code><br />
| NumberOfEpisodes<br />
|-<br />
| <code>24</code><br />
| NumberOfWatchedEpisodes<br />
|-<br />
| <code>25</code><br />
| TvShowStatus<br />
|-<br />
| <code>26</code><br />
| TvShowTitle<br />
|-<br />
| <code>27</code><br />
| SortTitle<br />
|-<br />
| <code>28</code><br />
| ProductionCode<br />
|-<br />
| <code>29</code><br />
| MPAA<br />
|-<br />
| <code>30</code><br />
| VideoResolution<br />
|-<br />
| <code>31</code><br />
| VideoCodec<br />
|-<br />
| <code>32</code><br />
| VideoAspectRatio<br />
|-<br />
| <code>33</code><br />
| AudioChannels<br />
|-<br />
| <code>34</code><br />
| AudioCodec<br />
|-<br />
| <code>35</code><br />
| AudioLanguage<br />
|-<br />
| <code>36</code><br />
| SubtitleLanguage<br />
|-<br />
| <code>37</code><br />
| Studio<br />
|-<br />
| <code>38</code><br />
| DateAdded<br />
|-<br />
| <code>39</code><br />
| LastPlayed<br />
|-<br />
| <code>40</code><br />
| Playcount<br />
|-<br />
| <code>41</code><br />
| Listeners<br />
|-<br />
| <code>42</code><br />
| Bitrate<br />
|-<br />
| <code>43</code><br />
| Random<br />
|-<br />
| <code>44</code><br />
| Channel<br />
|-<br />
| <code>45</code><br />
| ChannelNumber<br />
|-<br />
| <code>46</code> <br />
| DateTaken<br />
|}<br />
<br />
== See also ==<br />
* [[Action IDs]]<br />
<br />
[[Category:Python]]<br />
[[Category:Add-on development]]<br />
[[Category:Skin development]]</div>Phil65https://kodi.wiki/index.php?title=List_of_boolean_conditions&diff=117480List of boolean conditions2016-03-07T21:57:12Z<p>Phil65: </p>
<hr />
<div>{{see also|Conditional Visibility}}<br />
<section begin="main content" /><br />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.<br />
<br />
{| class="prettytable"<br />
! Condition !! Description<br />
|-<br />
| <code>ADSP.IsActive</code><br />
| <br />
|-<br />
| <code>ADSP.HasInputResample</code><br />
| <br />
|-<br />
| <code>ADSP.HasPreProcess</code><br />
| <br />
|-<br />
| <code>ADSP.HasMasterProcess</code><br />
| <br />
|-<br />
| <code>ADSP.HasPostProcess</code><br />
| <br />
|-<br />
| <code>ADSP.HasOutputResample</code><br />
| <br />
|-<br />
| <code>ADSP.MasterActive</code><br />
| <br />
|-<br />
| <code>Container.HasThumb</code><br />
| Returns true if the current container you are in has a thumb assigned to it<br />
|-<br />
| <code>Container.Content(parameter)</code><br />
| Returns true if the current container you are in contains the following: '''files, songs, artists, albums, movies, tvshows, seasons, episodes, musicvideos, genres, years, actors, playlists, plugins, studios, directors, sets, tags''' (Note: these currently only work in the Video and Music Library or unless a Plugin has set the value) also available are '''Addons''' true when a list of add-ons is shown '''LiveTV''' true when a htsp (tvheadend) directory is shown<br />
|-<br />
| <code>Container(id).OnNext</code><br />
| Returns true if the container with id (or current container if id is omitted) is moving to the next item. Allows views to be custom-designed (such as 3D coverviews etc.)<br />
|-<br />
| <code>Container(id).OnScrollNext</code><br />
| Returns true if the container with id (or current container if id is omitted) is scrolling to the next item. Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.<br />
|-<br />
| <code>Container(id).OnPrevious</code><br />
| Returns true if the container with id (or current container if id is omitted) is moving to the previous item. Allows views to be custom-designed (such as 3D coverviews etc.)<br />
|-<br />
| <code>Container(id).OnScrollPrevious</code><br />
| Returns true if the container with id (or current container if id is omitted) is scrolling to the previous item. Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.<br />
|-<br />
| <code>Container(id).HasFocus(item_number)</code><br />
| Returns true if the container with id (or current container if id is omitted) has static content and is focused on the item with id item_number.<br />
|-<br />
| <code>Container(id).HasFiles</code><br />
| Returns true if the container contains files (or current container if id is omitted).<br />
|-<br />
| <code>Container(id).HasFolders</code><br />
| Returns true if the container contains folders (or current container if id is omitted).<br />
|-<br />
| <code>Container(id).HasNext</code><br />
| Returns true if the container or textbox with id (id) has a next page.<br />
|-<br />
| <code>Container(id).HasPrevious</code><br />
| Returns true if the container or textbox with id (id) has a previous page.<br />
|-<br />
| <code>Container(id).IsUpdating</code><br />
| Returns true if the container with [[Dynamic List Content|dynamic list content]] is currently updating.<br />
|-<br />
| <code>Container(id).IsStacked</code><br />
| Returns true if the container is currently in stacked mode (or current container if id is omitted).<br />
|-<br />
| <code>Container.CanFilter</code><br />
| Returns true when the current container can be filtered.<br />
|-<br />
| <code>Container.CanFilterAdvanced</code><br />
| Returns true when advanced filtering can be applied to the current container.<br />
|-<br />
| <code>Container.Filtered</code><br />
| Returns true when a mediafilter is applied to the current container.<br />
|-<br />
| <code>Container.HasParent</code><br />
| Return true when the container contains a parent ('..') item.<br />
|-<br />
| <code>Container.SortDirection(ascending)</code><br />
| Returns true the sort direction of a container is ascending.<br />
|-<br />
| <code>Container.SortDirection(descending)</code><br />
| Returns true the sort direction of a container is descending.<br />
|-<br />
| <code>Container(id).Row(row)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.<br />
|-<br />
| <code>Container(id).Column(col)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.<br />
|-<br />
| <code>Container(id).Position(pos)</code><br />
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.<br />
|-<br />
| <code>Container(id).Scrolling</code><br />
| Returns true if the user is currently scrolling through the container with id (or current container if id is omitted). Note that this is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.<br />
|-<br />
| <code>Control.IsEnabled(id)</code><br />
| Returns true if the control with id "id" is enabled.<br />
|-<br />
| <code>Control.IsVisible(id)</code><br />
| Returns true if the control with id "id" is visible.<br />
|-<br />
| <code>Control.HasFocus(id)</code><br />
| Returns true if the currently focused control has id "id".<br />
|-<br />
| <code>ControlGroup(group).HasFocus(id)</code><br />
| Returns true if the control group with id “group” has control id “id” as it's focused item. 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”. Note that 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 />
|-<br />
| <code>IntegerGreaterThan([[InfoLabels|info]],number)</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than the supplied number.<br />Example: IntegerGreaterThan(ListItem.Year,2000)<br />
|-<br />
| <code>IsEmpty([[InfoLabels|info]])</code><br />
| Returns true if the value of the [[InfoLabels|infolabel]] is empty.<br />Example: IsEmpty(ListItem.Plot)<br />
|-<br />
| <code>Library.HasContent(string)</code><br />
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)<br />
|-<br />
| <code>Library.IsScanningMusic</code><br />
| Returns true if the music library is being updated<br />
|-<br />
| <code>Library.IsScanningVideo</code><br />
| Returns true if the video library is being updated<br />
|-<br />
| <code>ListItem.IsFolder</code><br />
| Returns whether the current ListItem is a folder<br />
|-<br />
| <code>ListItem.IsPlaying</code><br />
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media<br />
|-<br />
| <code>ListItem.IsResumable</code><br />
| Returns true when the current ListItem has been partially played<br />
|-<br />
| <code>ListItem.IsCollection</code><br />
| Returns true when the current ListItem is a movie set<br />
|-<br />
| <code>ListItem.IsSelected</code><br />
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)<br />
|-<br />
| <code>ListItem.HasEpg</code><br />
| Returns true when the selected programme has epg info (PVR)<br />
|-<br />
| <code>ListItem.HasTimer</code><br />
| Returns true when a recording timer has been set for the selected programme (PVR)<br />
|-<br />
| <code>ListItem.IsRecording</code><br />
| Returns true when the selected programme is being recorded (PVR)<br />
|-<br />
| <code>ListItem.IsEncrypted</code><br />
| Returns true when the selected programme is encrypted (PVR)<br />
|-<br />
| <code>ListItem.IsStereoscopic</code><br />
| Returns true when the selected video is a 3D (stereoscopic) video<br />
|-<br />
| <code>ListItem.Property(IsSpecial)</code><br />
| Returns whether the current Season/Episode is a Special<br />
|-<br />
| <code>ListItem.Property(DateLabel)</code><br />
| 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.<br />
|-<br />
| <code>ListItem.Property(Addon.Enabled)</code><br />
| Returns true when the selected addon is enabled (for use in the addon info dialog only).<br />
|-<br />
| <code>ListItem.Property(Addon.Installed)</code><br />
| Returns true when the selected addon is installed (for use in the addon info dialog only).<br />
|-<br />
| <code>ListItem.Property(Addon.UpdateAvail)</code><br />
| Returns true when there's an update available for the selected addon.<br />
|-<br />
| <code>MusicPlayer.HasNext</code><br />
| Returns true if the music player has a next song queued in the Playlist.<br />
|-<br />
| <code>MusicPlayer.HasPrevious</code><br />
| Returns true if the music player has a a Previous Song in the Playlist .<br />
|-<br />
| <code>MusicPlayer.Offset(number).Exists</code><br />
| Returns true if the music players playlist has a song queued in position (number).<br />
|-<br />
| <code>MusicPartyMode.Enabled</code><br />
| Returns true if Party Mode is enabled<br />
|-<br />
| <code>Player.HasMedia</code><br />
| Returns true if the player has an audio or video file.<br />
|-<br />
| <code>Player.HasAudio</code><br />
| Returns true if the player has an audio file.<br />
|-<br />
| <code>Player.HasDuration</code><br />
| Returns true if Media isn't a true stream<br />
|-<br />
| <code>Player.HasVideo</code><br />
| Returns true if the player has a video file.<br />
|-<br />
| <code>Player.Passthrough</code><br />
| Returns true if the player is using audio passthrough.<br />
|-<br />
| <code>Player.Playing</code><br />
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)<br />
|-<br />
| <code>Player.Paused</code><br />
| Returns true if the player is paused.<br />
|-<br />
| <code>Player.Forwarding</code><br />
| Returns true if the player is fast forwarding.<br />
|-<br />
| <code>Player.Forwarding2x</code><br />
| Returns true if the player is fast forwarding at 2x.<br />
|-<br />
| <code>Player.Forwarding4x</code><br />
| Returns true if the player is fast forwarding at 4x.<br />
|-<br />
| <code>Player.Forwarding8x</code><br />
| Returns true if the player is fast forwarding at 8x.<br />
|-<br />
| <code>Player.Forwarding16x</code><br />
| Returns true if the player is fast forwarding at 16x.<br />
|-<br />
| <code>Player.Forwarding32x</code><br />
| Returns true if the player is fast forwarding at 32x.<br />
|-<br />
| <code>Player.Rewinding</code><br />
| Returns true if the player is rewinding.<br />
|-<br />
| <code>Player.Rewinding2x</code><br />
| Returns true if the player is rewinding at 2x.<br />
|-<br />
| <code>Player.Rewinding4x</code><br />
| Returns true if the player is rewinding at 4x.<br />
|-<br />
| <code>Player.Rewinding8x</code><br />
| Returns true if the player is rewinding at 8x.<br />
|-<br />
| <code>Player.Rewinding16x</code><br />
| Returns true if the player is rewinding at 16x.<br />
|-<br />
| <code>Player.Rewinding32x</code><br />
| Returns true if the player is rewinding at 32x.<br />
|-<br />
| <code>Player.CanRecord</code><br />
| Returns true if the player can record the current internet stream.<br />
|-<br />
| <code>Player.Recording</code><br />
| Returns true if the player is recording the current internet stream.<br />
|-<br />
| <code>Player.Caching</code><br />
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).<br />
|-<br />
| <code>Player.DisplayAfterSeek</code><br />
| Returns true for the first 2.5 seconds after a seek.<br />
|-<br />
| <code>Player.Seeking</code><br />
| Returns true if a seek is in progress<br />
|-<br />
| <code>Player.ShowTime</code><br />
| Returns true if the user has requested the time to show (occurs in video fullscreen)<br />
|-<br />
| <code>Player.ShowInfo</code><br />
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)<br />
|-<br />
| <code>Player.ShowCodec</code><br />
| Returns true if the user has requested the codec to show (occurs in visualisation and video fullscreen)<br />
|-<br />
| <code>Player.IsInternetStream</code><br />
| Returns true if the player is playing an internet stream.<br />
|-<br />
| <code>Player.Muted</code><br />
| Returns true if the volume is muted.<br />
|-<br />
| <code>Playlist.IsRandom</code><br />
| Returns true if the player is in random mode.<br />
|-<br />
| <code>Playlist.IsRepeat</code><br />
| Returns true if the player is in repeat all mode.<br />
|-<br />
| <code>Playlist.IsRepeatOne</code><br />
| Returns true if the player is in repeat one mode.<br />
|-<br />
| <code>Pvr.HasTimer</code><br />
| Returns true when a recording timer is active.<br />
|-<br />
| <code>Pvr.HasNonRecordingTimer</code><br />
| Returns true when a non recording timer is active.<br />
|-<br />
| <code>Pvr.HasEpg</code><br />
| Returns true when an epg is available.<br />
|-<br />
| <code>Pvr.HasTxt</code><br />
| Returns true when teletext is available.<br />
|-<br />
| <code>Pvr.HasDirector</code><br />
| ?<br />
|-<br />
| <code>Pvr.HasTVChannels</code><br />
| Returns true if there are tv channels available<br />
|-<br />
| <code>Pvr.HasRadioChannels</code><br />
| Returns true if there are radio channels available<br />
|-<br />
| <code>Pvr.IsPlayingTv</code><br />
| Returns true when live tv is being watched.<br />
|-<br />
| <code>Pvr.IsPlayingRadio</code><br />
| Returns true when live radio is being listened to.<br />
|-<br />
| <code>Pvr.IsPlayingRecording</code><br />
| Returns true when a recording is being watched.<br />
|-<br />
| <code>Pvr.IsRecording</code><br />
| Returns true when the system is recording a tv programme.<br />
|-<br />
| <code>Pvr.IsTimeShift</code><br />
| Returns true when the playback is timeshifted.<br />
|-<br />
| <code>Pvr.ActStreamIsEncrypted</code><br />
| Returns true if the stream is encrypted<br />
|-<br />
| <code>RDS.HasRds</code><br />
| <br />
|-<br />
| <code>RDS.HasRadioText</code><br />
| <br />
|-<br />
| <code>RDS.HasRadioTextPlus</code><br />
| <br />
|-<br />
| <code>RDS.HasHotline</code><br />
| <br />
|-<br />
| <code>RDS.HasStudio</code><br />
| <br />
|-<br />
| <code>Skin.HasTheme(theme)</code><br />
| Returns true if the user has selected the theme with name ?theme?.<br />
|-<br />
| <code>Skin.HasSetting(setting)</code><br />
| 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>.<br />
|-<br />
| <code>Skin.String(string)</code><br />
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.<br />
|-<br />
| <code>Skin.String(string1,string2)</code><br />
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.<br />
|-<br />
| <code>Slideshow.IsActive</code><br />
| Returns true if the picture slideshow is running<br />
|-<br />
| <code>Slideshow.IsPaused</code><br />
| Returns true if the picture slideshow is paused<br />
|-<br />
| <code>Slideshow.IsRandom</code><br />
| Returns true if the picture slideshow is in random mode<br />
|-<br />
| <code>Slideshow.IsVideo</code><br />
| Returns true if the picture slideshow is playing a video<br />
|-<br />
| <code>StringCompare([[InfoLabels|info]],string)</code><br />
| Returns true if the [[InfoLabels|info]] equals the string. 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.<br />
|-<br />
| <code>SubString([[InfoLabels|info]],string)</code><br />
| Returns true if the string is found anywhere in the [[InfoLabels|info]]<br />
|-<br />
| <code>SubString([[InfoLabels|info]],string,[Left or Right])</code><br />
| Returns true if the string is found from the start or the end.<br />Example:<br /><br />
(foobars,foob,Left) -> true<br /><br />
(foobars,foob,Right) -> False<br /><br />
(foobars,bars,Right) -> true<br />
|-<br />
| <code>System.HasAddon(id)</code><br />
| Returns true if the specified addon is installed on the system.<br />
|-<br />
| <code>System.HasAlarm(alarm)</code><br />
| Returns true if the system has the ?alarm? alarm set.<br />
|-<br />
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code><br />
| 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.<br />
|-<br />
| <code>System.HasNetwork</code><br />
| Returns true if the ethernet cable is plugged in.<br />
|-<br />
| <code>System.HasMediadvd</code><br />
| Returns true if there is a CD or DVD in the <span class="nobr">DVD-ROM</span> drive.<br />
|-<br />
| <code>System.IdleTime(time)</code><br />
| Returns true if Kodi has had no input for ?time? amount of seconds.<br />
|-<br />
| <code>System.IsStandalone</code><br />
| Returns true if Kodi is running in standalone mode.<br />
|-<br />
| <code>System.IsFullscreen</code><br />
| Returns true if Kodi is running fullscreen.<br />
|-<br />
| <code>System.KaiConnected</code><br />
| Returns true if XBMC's Kai client is connected to the PC engine.<br />
|-<br />
| <code>System.IsLoggedOn</code><br />
| Returns true if a user is currently logged on under a [[Profiles|profile]]<br />
|-<br />
| <code>System.HasLoginScreen</code><br />
| Returns true if the [[Profiles|profile]] login screen is enabled<br />
|-<br />
| <code>System.HasADSP</code><br />
| Returns true if ADSP is enabled<br />
|-<br />
| <code>System.HasModalDialog</code><br />
| Returns true true if a modal dialog is visible<br />
|-<br />
| <code>System.Time(startTime,endTime)</code><br />
| 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.<br />
|-<br />
| <code>System.Date(startDate,endDate)</code><br />
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.<br />
|-<br />
| <code>System.Platform.Linux</code><br />
| Returns true if Kodi is running on a linux/unix based computer.<br />
|-<br />
| <code>System.Platform.Linux.RaspberryPi</code><br />
| Returns true if Kodi is running on a Raspberry Pi.<br />
|-<br />
| <code>System.Platform.Windows</code><br />
| Returns true if Kodi is running on a windows based computer.<br />
|-<br />
| <code>System.Platform.OSX</code><br />
| Returns true if Kodi is running on an OSX based computer.<br />
|-<br />
| <code>System.Platform.IOS</code><br />
| Returns true if Kodi is running on an IOS device.<br />
|-<br />
| <code>System.Platform.Darwin</code><br />
| Returns true if Kodi is running on an OSX or IOS system.<br />
|-<br />
| <code>System.Platform.ATV2</code><br />
| Returns true if Kodi is running on an atv2.<br />
|-<br />
| <code>System.Platform.Android</code><br />
| Returns true if Kodi is running on an android device.<br />
|-<br />
| <code>System.CanPowerDown</code><br />
| Returns true if Kodi can powerdown the system.<br />
|-<br />
| <code>System.CanSuspend</code><br />
| Returns true if Kodi can suspend the system.<br />
|-<br />
| <code>System.CanHibernate</code><br />
| Returns true if Kodi can hibernate the system.<br />
|-<br />
| <code>System.HasHiddenInput</code><br />
| Return true when to osd keyboard/numeric dialog requests a password/pincode.<br />
|-<br />
| <code>System.CanReboot</code><br />
| Returns true if Kodi can reboot the system.<br />
|-<br />
| <code>System.ScreenSaverActive</code><br />
| Returns true if ScreenSaver is active.<br />
|-<br />
| <code>System.Setting(hidewatched)</code><br />
| Returns true if 'hide watched items' is selected.<br />
|-<br />
| <code>System.IsInhibit</code><br />
| Returns true when shutdown on idle is disabled.<br />
|-<br />
| <code>System.HasShutdown</code><br />
| Returns true when shutdown on idle is enabled.<br />
|-<br />
| <code>VideoPlayer.UsingOverlays</code><br />
| 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.<br />
|-<br />
| <code>VideoPlayer.IsFullscreen</code><br />
| Returns true if the video player is in fullscreen mode.<br />
|-<br />
| <code>VideoPlayer.HasMenu</code><br />
| Returns true if the video player has a menu (ie is playing a DVD)<br />
|-<br />
| <code>VideoPlayer.HasInfo</code><br />
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)<br />
|-<br />
| <code>VideoPlayer.Content(parameter)</code><br />
| 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<br />
|-<br />
| <code>VideoPlayer.HasSubtitles</code><br />
| Returns true if there are subtitles available for video. (available for version 11.0 and above)<br />
|-<br />
| <code>VideoPlayer.IsStereoscopic</code><br />
| Returns true when the currently playing video is a 3D (stereoscopic) video<br />
|-<br />
| <code>VideoPlayer.SubtitlesEnabled</code><br />
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)<br />
|-<br />
| <code>VideoPlayer.HasEpg</code><br />
| Returns true when epg information is available for the currently playing programme (PVR).<br />
|-<br />
| <code>Visualisation.Enabled</code><br />
| Returns true if any visualisation has been set in settings (so not None).<br />
|-<br />
| <code>Visualisation.HasPresets</code><br />
| Returns true if the visualisation has built in presets.<br />
|-<br />
| <code>Visualisation.Locked</code><br />
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)<br />
|-<br />
| <code>Weather.IsFetched</code><br />
| Returns true if the weather data has been downloaded.<br />
|-<br />
| <code>Window.IsVisible(window)</code><br />
| Returns true if the window is visible (includes fade out time on dialogs)<br />
|-<br />
| <code>Window.IsActive(window)</code><br />
| 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]]<br />
|-<br />
| <code>Window.IsTopMost(window)</code><br />
| 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]]<br />
|-<br />
| <code>Window.IsMedia</code><br />
| Returns true if this window is a media window (programs, music, video, scripts, pictures)<br />
|-<br />
| <code>Window.Next(window)</code><br />
| 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.<br />
|-<br />
| <code>Window.Previous(window)</code><br />
| 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.<br />
|-<br />
| <code>Window.Property(IsRadio)</code><br />
| Returns true if the window is a radio window (for use in the PVR windows)<br />
|}<br />
<section end="main content" /><br />
<br />
<br />
== See also ==<br />
'''Development:'''<br />
* [[Add-on development]]<br />
* [[Skinning]]<br />
<br />
[[Category:Skin development]]<br />
[[Category:Add-on development]]</div>Phil65https://kodi.wiki/index.php?title=Window_IDs&diff=96640Window IDs2015-05-29T21:36:36Z<p>Phil65: </p>
<hr />
<div>{{mininav|[[Development]]|[[Add-on development]]}}<br />
{{see also|Opening Windows and Dialogs|Python development|Skinning}}<br />
<section begin="main content" /><br />
This table cross-references Window names, Window definitions, Window ID, and the delta Window ID's (this is the delta from the home window.) The code that performs the cross-reference is found in [https://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk/xbmc/ButtonTranslator.cpp?view=markup ButtonTranslator.cpp].<br />
<br />
* [[keymap.xml]] uses the Window name.<br />
* Kodi's C++ code uses the Window definitions and Window ID's.<br />
* ActivateWindow() should use the Window name.<br />
* sounds.xml should use the window name<br /><br />
<br />
'''You can use secondary parameters with all media windows, as can be seen here:'''<br />
* '''[[Opening Windows and Dialogs]]'''<br />
<br />
'''Example:'''<br />
* You want a button in your skin or on your remote taking you directly to the movie listing you let that button do<br />
<br />
<pre>ActivateWindow(Videos,videodb://movies/titles/)</pre><br />
<br />
<br />
<br />
<br />
{| class="prettytable sortable"<br />
|- <br />
! Name !! Definition !! Window ID !! Delta window ID !! source XML file<br />
|- <br />
| <code>home</code><br />
| <code>WINDOW_HOME</code><br />
| <code>10000</code><br />
| <code>0</code><br />
| Home.xml<br />
|- <br />
| <code>programs</code><br />
| <code>WINDOW_PROGRAMS</code><br />
| <code>10001</code><br />
| <code>1</code><br />
| MyPrograms.xml<br />
|- <br />
| <code>pictures</code><br />
| <code>WINDOW_PICTURES</code><br />
| <code>10002</code><br />
| <code>2</code><br />
| MyPics.xml<br />
|- <br />
| <code>filemanager</code><br />
| <code>WINDOW_FILES</code><br />
| <code>10003</code><br />
| <code>3</code><br />
| FileManager.xml<br />
|- <br />
| <code>settings</code><br />
| <code>WINDOW_SETTINGS_MENU</code><br />
| <code>10004</code><br />
| <code>4</code><br />
| Settings.xml<br />
|- <br />
| <code>music</code><br />
| <code>WINDOW_MUSIC</code><br />
| <code>10005</code><br />
| <code>5</code><br />
| None – this is just a wrapper for the current My Music view (who's IDs are 501 and 502)<br />
|- <br />
| <code>video</code><br />
| <code>WINDOW_VIDEOS</code><br />
| <code>10006</code><br />
| <code>6</code><br />
| None – this is just a wrapper for the current My Video view (who's IDs are 21-25) <br />
|- <br />
| <code>systeminfo</code><br />
| <code>WINDOW_SYSTEM_INFORMATION</code><br />
| <code>10007</code><br />
| <code>7</code><br />
| SettingsSystemInfo.xml<br />
|- <br />
| <code>screencalibration</code><br />
| <code>WINDOW_MOVIE_CALIBRATION</code><br />
| <code>10011</code><br />
| <code>11</code><br />
| SettingsScreenCalibration.xml<br />
|- <br />
| <code>picturessettings</code><br />
| <code>WINDOW_SETTINGS_MYPICTURES</code><br />
| <code>10012</code><br />
| <code>12</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>programssettings</code><br />
| <code>WINDOW_SETTINGS_MYPROGRAMS</code><br />
| <code>10013</code><br />
| <code>13</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>weathersettings</code><br />
| <code>WINDOW_SETTINGS_MYWEATHER</code><br />
| <code>10014</code><br />
| <code>14</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>musicsettings</code><br />
| <code>WINDOW_SETTINGS_MYMUSIC</code><br />
| <code>10015</code><br />
| <code>15</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>systemsettings</code><br />
| <code>WINDOW_SETTINGS_SYSTEM</code><br />
| <code>10016</code><br />
| <code>16</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>videossettings</code><br />
| <code>WINDOW_SETTINGS_MYVIDEOS</code><br />
| <code>10017</code><br />
| <code>17</code><br />
| SettingsCategory.xml<br />
|-<br />
| <code>servicesettings</code><br />
| <code>WINDOW_SETTINGS_SERVICE</code><br />
| <code>10018</code><br />
| <code>18</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>appearancesettings</code><br />
| <code>WINDOW_SETTINGS_APPEARANCE</code><br />
| <code>10019</code><br />
| <code>19</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>pvrsettings</code><br />
| <code>WINDOW_SETTINGS_MYPVR</code><br />
| <code>10021</code><br />
| <code>21</code><br />
| SettingsCategory.xml<br />
|- <br />
| <code>videos</code><br />
| <code>WINDOW_VIDEO_NAV</code><br />
| <code>10025</code><br />
| <code>25</code><br />
| MyVideoNav.xml - Replaces the following .XML files: MyVideoGenre (WINDOW_VIDEO_GENRE), MyVideoActors (WINDOW_VIDEO_ACTOR), MyVideoYear (WINDOW_VIDEO_YEAR), MyVideoTitle (WINDOW_VIDEO_TITLE)<br />
|- <br />
| <code>videoplaylist</code><br />
| <code>WINDOW_VIDEO_PLAYLIST</code><br />
| <code>10028</code><br />
| <code>28</code><br />
| MyVideoPlaylist.xml<br />
|- <br />
| <code>loginscreen</code><br />
| <code>WINDOW_LOGINSCREEN</code><br />
| <code>10029</code><br />
| <code>29</code><br />
| LoginScreen.xml<br />
|- <br />
| <code>profiles</code><br />
| <code>WINDOW_SETTINGS_PROFILES</code><br />
| <code>10034</code><br />
| <code>34</code><br />
| SettingsProfile.xml<br />
|- <br />
| <code>addonbrowser</code><br />
| <code>WINDOW_ADDON_BROWSER</code><br />
| <code>10040</code><br />
| <code>40</code><br />
| AddonBrowser.xml<br />
|- <br />
| <code>yesnodialog</code><br />
| <code>WINDOW_DIALOG_YES_NO</code><br />
| <code>10100</code><br />
| <code>100</code><br />
| DialogYesNo.xml<br />
|- <br />
| <code>progressdialog</code><br />
| <code>WINDOW_DIALOG_PROGRESS</code><br />
| <code>10101</code><br />
| <code>101</code><br />
| DialogProgress.xml<br />
|- <br />
| <code>virtualkeyboard</code><br />
| <code>WINDOW_DIALOG_KEYBOARD</code><br />
| <code>10103</code><br />
| <code>103</code><br />
| DialogKeyboard.xml<br />
|- <br />
| <code>volumebar</code><br />
| <code>WINDOW_DIALOG_VOLUME_BAR</code><br />
| <code>10104</code><br />
| <code>104</code><br />
| DialogVolumeBar.xml<br />
|- <br />
| <code>contextmenu</code><br />
| <code>WINDOW_DIALOG_CONTEXT_MENU</code><br />
| <code>10106</code><br />
| <code>106</code><br />
| DialogContextMenu.xml<br />
|- <br />
| <code>infodialog</code><br />
| <code>WINDOW_DIALOG_KAI_TOAST</code><br />
| <code>10107</code><br />
| <code>107</code><br />
| DialogKaiToast.xml<br />
|- <br />
| <code>numericinput</code><br />
| <code>WINDOW_DIALOG_NUMERIC</code><br />
| <code>10109</code><br />
| <code>109</code><br />
| DialogNumeric.xml<br />
|- <br />
| <code>shutdownmenu</code><br />
| <code>WINDOW_DIALOG_BUTTON_MENU</code><br />
| <code>10111</code><br />
| <code>111</code><br />
| DialogButtonMenu.xml<br />
|- <br />
| <code>mutebug</code><br />
| <code>WINDOW_DIALOG_MUTE_BUG</code><br />
| <code>10113</code><br />
| <code>113</code><br />
| DialogMuteBug.xml<br />
|- <br />
| <code>playercontrols</code><br />
| <code>WINDOW_DIALOG_PLAYER_CONTROLS</code><br />
| <code>10114</code><br />
| <code>114</code><br />
| PlayerControls.xml<br />
|- <br />
| <code>seekbar</code><br />
| <code>WINDOW_DIALOG_SEEK_BAR</code><br />
| <code>10115</code><br />
| <code>115</code><br />
| DialogSeekBar.xml<br />
|- <br />
| <code>musicosd</code><br />
| <code>WINDOW_DIALOG_MUSIC_OSD</code><br />
| <code>10120</code><br />
| <code>120</code><br />
| MusicOSD.xml<br />
|- <br />
| <code>visualisationpresetlist</code><br />
| <code>WINDOW_DIALOG_VIS_PRESET_LIST</code><br />
| <code>10122</code><br />
| <code>122</code><br />
| VisualisationPresetList.xml<br />
|- <br />
| <code>osdvideosettings</code><br />
| <code>WINDOW_DIALOG_VIDEO_OSD_SETTINGS</code><br />
| <code>10123</code><br />
| <code>123</code><br />
| VideoOSDSettings.xml<br />
|- <br />
| <code>osdaudiosettings</code><br />
| <code>WINDOW_DIALOG_AUDIO_OSD_SETTINGS</code><br />
| <code>10124</code><br />
| <code>124</code><br />
| VideoOSDSettings.xml<br />
|- <br />
| <code>videobookmarks</code><br />
| <code>WINDOW_DIALOG_VIDEO_BOOKMARKS</code><br />
| <code>10125</code><br />
| <code>125</code><br />
| VideoOSDBookmarks.xml<br />
|- <br />
| <code>filebrowser</code><br />
| <code>WINDOW_DIALOG_FILE_BROWSER</code><br />
| <code>10126</code><br />
| <code>126</code><br />
| FileBrowser.xml<br />
|- <br />
| <code>networksetup</code><br />
| <code>WINDOW_DIALOG_NETWORK_SETUP</code><br />
| <code>10128</code><br />
| <code>128</code><br />
| DialogNetworkSetup.xml<br />
|- <br />
| <code>mediasource</code><br />
| <code>WINDOW_DIALOG_MEDIA_SOURCE</code><br />
| <code>10129</code><br />
| <code>129</code><br />
| DialogMediaSource.xml<br />
|- <br />
| <code>profilesettings</code><br />
| <code>WINDOW_PROFILE_SETTINGS</code><br />
| <code>10130</code><br />
| <code>130</code><br />
| ProfileSettings.xml<br />
|- <br />
| <code>locksettings</code><br />
| <code>WINDOW_LOCK_SETTINGS</code><br />
| <code>10131</code><br />
| <code>131</code><br />
| LockSettings.xml<br />
|- <br />
| <code>contentsettings</code><br />
| <code>WINDOW_DIALOG_CONTENT_SETTINGS</code><br />
| <code>10132</code><br />
| <code>132</code><br />
| DialogContentSettings.xml<br />
|- <br />
| <code>favourites</code><br />
| <code>WINDOW_DIALOG_FAVOURITES</code><br />
| <code>10134</code><br />
| <code>134</code><br />
| DialogFavourites.xml<br />
|- <br />
| <code>songinformation</code><br />
| <code>WINDOW_DIALOG_SONG_INFO</code><br />
| <code>10135</code><br />
| <code>135</code><br />
| DialogSongInfo.xml<br />
|- <br />
| <code>smartplaylisteditor</code><br />
| <code>WINDOW_DIALOG_SMART_PLAYLIST_EDITOR</code><br />
| <code>10136</code><br />
| <code>136</code><br />
| SmartPlaylistEditor.xml<br />
|- <br />
| <code>smartplaylistrule</code><br />
| <code>WINDOW_DIALOG_SMART_PLAYLIST_RULE</code><br />
| <code>10137</code><br />
| <code>137</code><br />
| SmartPlaylistRule.xml<br />
|- <br />
| <code>busydialog</code><br />
| <code>WINDOW_DIALOG_BUSY</code><br />
| <code>10138</code><br />
| <code>138</code><br />
| DialogBusy.xml<br />
|- <br />
| <code>pictureinfo</code><br />
| <code>WINDOW_DIALOG_PICTURE_INFO</code><br />
| <code>10139</code><br />
| <code>139</code><br />
| DialogPictureInfo.xml<br />
|- <br />
| <code>addonsettings</code><br />
| <code>WINDOW_DIALOG_ADDON_SETTINGS</code><br />
| <code>10140</code><br />
| <code>140</code><br />
| DialogAddonSettings.xml<br />
|- <br />
| <code>accesspoints</code><br />
| <code>WINDOW_DIALOG_ACCESS_POINTS</code><br />
| <code>10141</code><br />
| <code>141</code><br />
| DialogAccessPoints.xml<br />
|- <br />
| <code>fullscreeninfo</code><br />
| <code>WINDOW_DIALOG_FULLSCREEN_INFO</code><br />
| <code>10142</code><br />
| <code>142</code><br />
| DialogFullScreenInfo.xml<br />
|- <br />
| <code>karaokeselector</code><br />
| <code>WINDOW_DIALOG_KARAOKE_SONGSELECT</code><br />
| <code>10143</code><br />
| <code>143</code><br />
| DialogKaraokeSongSelector.xml<br />
|- <br />
| <code>karaokelargeselector</code><br />
| <code>WINDOW_DIALOG_KARAOKE_SELECTOR</code><br />
| <code>10144</code><br />
| <code>144</code><br />
| DialogKaraokeSongSelectorLarge.xml<br />
|- <br />
| <code>sliderdialog</code><br />
| <code>WINDOW_DIALOG_SLIDER</code><br />
| <code>10145</code><br />
| <code>145</code><br />
| DialogSlider.xml<br />
|- <br />
| <code>addoninformation</code><br />
| <code>WINDOW_DIALOG_ADDON_INFO</code><br />
| <code>10146</code><br />
| <code>146</code><br />
| DialogAddonInfo.xml<br />
|- <br />
| <code>textviewer</code><br />
| <code>WINDOW_DIALOG_TEXT_VIEWER</code><br />
| <code>10147</code><br />
| <code>147</code><br />
| DialogTextViewer.xml<br />
|- <br />
| <code>peripherals</code><br />
| <code>WINDOW_DIALOG_PERIPHERAL_MANAGER</code><br />
| <code>10149</code><br />
| <code>149</code><br />
| DialogPeripheralManager.xml<br />
|- <br />
| <code>peripheralsettings</code><br />
| <code>WINDOW_DIALOG_PERIPHERAL_SETTINGS</code><br />
| <code>10150</code><br />
| <code>150</code><br />
| DialogPeripheralSettings.xml<br />
|- <br />
| <code>extendedprogressdialog</code><br />
| <code>WINDOW_DIALOG_EXT_PROGRESS</code><br />
| <code>10151</code><br />
| <code>151</code><br />
| DialogExtendedProgressBar.xml<br />
|-<br />
| <code>mediafilter</code><br />
| <code>WINDOW_DIALOG_MEDIA_FILTER</code><br />
| <code>10152</code><br />
| <code>152</code><br />
| DialogMediaFilter.xml<br />
|-<br />
| <code>subtitlesearch</code><br />
| <code>WINDOW_DIALOG_SUBTITLES</code><br />
| <code>10153</code><br />
| <code>153</code><br />
| DialogSubtitles.xml<br />
|- <br />
| <code>musicplaylist</code><br />
| <code>WINDOW_MUSIC_PLAYLIST</code><br />
| <code>10500</code><br />
| <code>500</code><br />
| MyMusicPlaylist.xml<br />
|- <br />
| <code>musicfiles</code><br />
| <code>WINDOW_MUSIC_FILES</code><br />
| <code>10501</code><br />
| <code>501</code><br />
| MyMusicSongs.xml<br />
|- <br />
| <code>musiclibrary</code><br />
| <code>WINDOW_MUSIC_NAV</code><br />
| <code>10502</code><br />
| <code>502</code><br />
| MyMusicNav.xml<br />
|- <br />
| <code>musicplaylisteditor</code><br />
| <code>WINDOW_MUSIC_PLAYLIST_EDITOR</code><br />
| <code>10503</code><br />
| <code>503</code><br />
| MyMusicPlaylistEditor.xml<br />
|-<br />
| <code>FullscreenLiveTV</code><br />
| <code>WINDOW_FULLSCREEN_LIVETV</code><br />
| <code>10614</code><br />
| <code>614</code><br />
| None (shortcut to fullscreenvideo)<br />
|-<br />
| <code>tvchannels</code><br />
| <code>WINDOW_TV_CHANNELS</code><br />
| <code>10615</code><br />
| <code>615</code><br />
| MyPVRChannels.xml<br />
|-<br />
| <code>tvrecordings</code><br />
| <code>WINDOW_TV_RECORDINGS</code><br />
| <code>10616</code><br />
| <code>616</code><br />
| MyPVRRecordings.xml<br />
|-<br />
| <code>tvguide</code><br />
| <code>WINDOW_TV_GUIDE</code><br />
| <code>10617</code><br />
| <code>617</code><br />
| MyPVRGuide.xml<br />
|-<br />
| <code>tvtimers</code><br />
| <code>WINDOW_TV_TIMERS</code><br />
| <code>10618</code><br />
| <code>618</code><br />
| MyPVRTimers.xml<br />
|-<br />
| <code>tvsearch</code><br />
| <code>WINDOW_TV_SEARCH</code><br />
| <code>10619</code><br />
| <code>619</code><br />
| MyPVRSearch.xml<br />
|-<br />
| <code>radiochannels</code><br />
| <code>WINDOW_RADIO_CHANNELS</code><br />
| <code>10620</code><br />
| <code>620</code><br />
| MyPVRChannels.xml<br />
|-<br />
| <code>radiorecordings</code><br />
| <code>WINDOW_RADIO_RECORDINGS</code><br />
| <code>10621</code><br />
| <code>621</code><br />
| MyPVRRecordings.xml<br />
|-<br />
| <code>radioguide</code><br />
| <code>WINDOW_RADIO_GUIDE</code><br />
| <code>10622</code><br />
| <code>622</code><br />
| MyPVRGuide.xml<br />
|-<br />
| <code>radiotimers</code><br />
| <code>WINDOW_RADIO_TIMERS</code><br />
| <code>10623</code><br />
| <code>623</code><br />
| MyPVRTimers.xml<br />
|-<br />
| <code>radiosearch</code><br />
| <code>WINDOW_RADIO_SEARCH</code><br />
| <code>10624</code><br />
| <code>624</code><br />
| MyPVRSearch.xml<br />
|-<br />
| <code>pvrguideinfo</code><br />
| <code>WINDOW_DIALOG_PVR_GUIDE_INFO</code><br />
| <code>10602</code><br />
| <code>602</code><br />
| DialogPVRGuideInfo.xml<br />
|-<br />
| <code>pvrrecordinginfo</code><br />
| <code>WINDOW_DIALOG_PVR_RECORDING_INFO</code><br />
| <code>10603</code><br />
| <code>603</code><br />
| DialogPVRRecordingInfo.xml<br />
|-<br />
| <code>pvrtimersetting</code><br />
| <code>WINDOW_DIALOG_PVR_TIMER_SETTING</code><br />
| <code>10604</code><br />
| <code>604</code><br />
| DialogPVRTimerSettings.xml<br />
|-<br />
| <code>pvrgroupmanager</code><br />
| <code>WINDOW_DIALOG_PVR_GROUP_MANAGER</code><br />
| <code>10605</code><br />
| <code>605</code><br />
| DialogPVRGroupManager.xml<br />
|-<br />
| <code>pvrchannelmanager</code><br />
| <code>WINDOW_DIALOG_PVR_CHANNEL_MANAGER</code><br />
| <code>10606</code><br />
| <code>606</code><br />
| DialogPVRChannelManager.xml<br />
|-<br />
| <code>pvrguidesearch</code><br />
| <code>WINDOW_DIALOG_PVR_GUIDE_SEARCH</code><br />
| <code>10607</code><br />
| <code>607</code><br />
| DialogPVRGuideSearch.xml<br />
|-<br />
| <code>pvrosdchannels</code><br />
| <code>WINDOW_DIALOG_PVR_OSD_CHANNELS</code><br />
| <code>10610</code><br />
| <code>610</code><br />
| DialogPVRChannelsOSD.xml<br />
|-<br />
| <code>pvrosdguide</code><br />
| <code>WINDOW_DIALOG_PVR_OSD_GUIDE</code><br />
| <code>10611</code><br />
| <code>611</code><br />
| DialogPVRGuideOSD.xml<br />
|- <br />
| <code>Custom Skin Windows</code><br />
| <code>- </code><br />
| <code>- </code><br />
| <code>1100–1199 </code><br />
| custom*.xml<br />
|- <br />
| <code>selectdialog</code><br />
| <code>WINDOW_DIALOG_SELECT</code><br />
| <code>12000</code><br />
| <code>2000</code><br />
| DialogSelect.xml<br />
|- <br />
| <code>musicinformation</code><br />
| <code>WINDOW_MUSIC_INFO</code><br />
| <code>12001</code><br />
| <code>2001</code><br />
| DialogAlbumInfo.xml<br />
|- <br />
| <code>okdialog</code><br />
| <code>WINDOW_DIALOG_OK</code><br />
| <code>12002</code><br />
| <code>2002</code><br />
| DialogOK.xml<br />
|- <br />
| <code>movieinformation</code><br />
| <code>WINDOW_VIDEO_INFO</code><br />
| <code>12003</code><br />
| <code>2003</code><br />
| DialogVideoInfo.xml<br />
|- <br />
| <code>fullscreenvideo</code><br />
| <code>WINDOW_FULLSCREEN_VIDEO</code><br />
| <code>12005</code><br />
| <code>2005</code><br />
| VideoFullScreen.xml<br />
|- <br />
| <code>visualisation</code><br />
| <code>WINDOW_VISUALISATION</code><br />
| <code>12006</code><br />
| <code>2006</code><br />
| MusicVisualisation.xml<br />
|- <br />
| <code>slideshow</code><br />
| <code>WINDOW_SLIDESHOW</code><br />
| <code>12007</code><br />
| <code>2007</code><br />
| SlideShow.xml<br />
|- <br />
| <code>filestackingdialog</code><br />
| <code>WINDOW_DIALOG_FILESTACKING</code><br />
| <code>12008</code><br />
| <code>2008</code><br />
| DialogFileStacking.xml<br />
|- <br />
| <code>karaoke</code><br />
| <code>WINDOW_KARAOKELYRICS</code><br />
| <code>12009</code><br />
| <code>2009</code><br />
| MusicKaraokeLyrics.xml<br />
|- <br />
| <code>weather</code><br />
| <code>WINDOW_WEATHER</code><br />
| <code>12600</code><br />
| <code>2600</code><br />
| MyWeather.xml<br />
|- <br />
| <code>screensaver</code><br />
| <code>WINDOW_SCREENSAVER</code><br />
| <code>12900</code><br />
| <code>2900</code><br />
| none<br />
|- <br />
| <code>videoosd</code><br />
| <code>WINDOW_OSD</code><br />
| <code>12901</code><br />
| <code>2901</code><br />
| VideoOSD.xml<br />
|- <br />
| <code>videomenu</code><br />
| <code>WINDOW_MEDIA_MENU</code><br />
| <code>12902</code><br />
| <code>2902</code><br />
| none<br />
|- <br />
| <code>startup</code><br />
| <code>WINDOW_STARTUP_ANIM</code><br />
| <code>12999</code><br />
| <code>2999</code><br />
| Startup.xml<br />
|-<br />
| <code>skinsettings</code><br />
| <code>-</code><br />
| <code>-</code><br />
| <code>-</code><br />
| SkinSettings.xml<br />
|- <br />
| <code>startwindow</code><br />
| <code>-</code><br />
| <code>-</code><br />
| <code>-</code><br />
| shortcut to the current startwindow<br />
|-<br />
| colspan="5" bgcolor="#ffffff" | In addition, there are the following "special" windows whose id is not really a concern (and you'll notice isn't unique)<br />
|- <br />
| <code>pointer</code><br />
| <code>- </code><br />
| <code>- </code><br />
| <code>105 </code><br />
| Pointer.xml<br />
|- <br />
| <code>musicoverlay</code><br />
| <code>WINDOW_MUSIC_OVERLAY</code><br />
| <code>12903</code><br />
| <code>2903</code><br />
| MusicOverlay.xml<br />
|- <br />
| <code>videooverlay</code><br />
| <code>WINDOW_VIDEO_OVERLAY</code><br />
| <code>12904</code><br />
| <code>2904</code><br />
| VideoOverlay.xml<br />
|- <br />
| <code>(Python Windows)</code><br />
| <code>- </code><br />
| <code>- </code><br />
| <code>30<span class="nobr">00–309</span>9 </code><br />
| none <br />
|-<br />
| <code>addon</code><br />
| <code>- </code><br />
| <code>- </code><br />
| <code>40<span class="nobr">00–409</span>9 </code><br />
| none <br />
|}<br />
<section end="main content" /><br />
== Removed window IDs ==<br />
* <code>scripts</code> - Removed in v10 Dharma<br />
* <code>networksettings</code> - Removed in v12 Frodo<br />
* <code>musicscan</code> - Removed in v12 Frodo<br />
* <code>videoscan</code> - Removed in v12 Frodo<br />
* <code>videofiles</code> - Removed in v13 Gotham<br />
* <code>pvr</code> - Replaced in v14 Helix with more specific PVR windows<br />
<br />
== See also ==<br />
* [[Keymaps]]<br />
* [[Action IDs]]<br />
* [[Built-in scripting]]<br />
<br />
<br />
{{helix updated}}<br />
<br />
[[Category:Python]]<br />
[[Category:Add-on development]]<br />
[[Category:Skin development]]</div>Phil65