Official Kodi Wiki - User contributions [en]

EventServer

2018-08-29T07:12:58Z

Xhaggi: /* Kodi for Linux */

{{mininav|[[Development]]}}

{{cleanup}}
EventServer is the part of Kodi that accepts remote device input on all platforms. EventServer API is used to program event clients and simplifies interfacing input devices with Kodi. EventServer accepts commands from event clients such as LIRC, joysticks, PDAs, and iPhones.

== The Purpose of EventServer API in Kodi ==
The EventServer in Kodi was created to satisfy a need to support many input devices across multiple hardware platforms. Adding direct support for a multitude of devices generally decreases performance and stability, and becomes difficult to maintain. The EventServer was created to provide a simple, reliable way to communicate with and control Kodi.

== Event Clients and the EventServer ==
Kodi's EventServer listens for commands from event clients. Anything that can communicate using UDP can be an event client. Many event client software packages are currently available for PCs, Macs, smartphones, PDAs, and more. Some event client software accepts commands from infra-red remotes, gamepad controllers, and others to translate and send to the EventServer. These event client software packages are often run on the same computer as Kodi, essentially as remote control addons.

To change the default Event Server port on Kodi, you must modify guisettings.xml under <services>, find this line "<esport>9777<esport/>", change the port number and save. The file is here: ~/.kodi/userdata/guisettings.xml (this has worked with Openelec for the Raspberry Pi).

== v11 Eden options ==
:In v11 (Eden), the event server is enabled through the "Allow programs on other systems to control Kodi" option. It runs by default on 9777, and can be confirmed by looking in the log at startup for "Starting UDP Event server on 0.0.0.0:9777"
:To change the default port, you must modify advancedsettings.xml , but the exact setting is not known at this time.

== Event Clients ==
The event clients and EventServer are under heavy development, so for up-to-date information please refer to the [https://github.com/xbmc/xbmc/blob/master/tools/EventClients/README.txt readme file]

Most event clients can be configured using [http://en.wikipedia.org/wiki/Command-line_interface CLI]. Common CLI arguments are address and port number. The defaults are localhost and port 9777.

Event clients can currently be recognized as one of the following:

* Mouse
* Keyboard
* LIRC (Only on Linux)
* Joystick

=== Joysticks ===
Joysticks are mappable in keymap.xml using the following convention:
<joystick name="foo">
<button id="1">ACTION1</button>
<button id="2">ACTIOn2</button>
<axis id="1" limit="-1">ACTION3</axis>
<axis id="2" limit="+1">ACTION4</axis>
</joystick>

See [[keyboard.xml]] for more information on how to customize the keymap.

There is initial support for the PS3 controller (sixaxis) and

==== PS3 Blu-Ray Remote ====
There is initial support for the PS3 Blu-Ray remote.
The remote needs to be paired using one of two python scripts. 'ps3_remote.py' can be run as a user, but the controller must be paired every time the script is run. 'ps3d.py' will remember remotes between run-instances if it is executed as root, and it supports the PS3 Sixaxis controller as well.

==== PS3 Sixaxis Controller (TODO) ====
Pairing with the PS3 controller is not yet handled automatically, but it can be done using the program 'sixaxis.c' available from [http://www.pabr.org/sixlinux/sixlinux.en.html]. Or if you want to do it the gui way [http://ubuntuforums.org/showthread.php?t=1190061]

Once paired, disable any existing HID servers that might currently be running and run 'ps3d.py' as root. The program requires root privileges because it listens on Bluetooth L2CAP PSMs 17 and 19. (This is not nessecary using the gui tool)

===== Using the PS3 Sixaxis Controller =====
There is xml configuration file for the ps3 controller under your keymaps folder.
You need to change the name of the joystick in you xml configfile to containg the mac adress of your controller.
"grep PLAYSTATION /proc/bus/input/devices" from a terminal will give you what you need.

==== WiiRemote ====
To use the WiiRemote:
1. Open a terminal window and type/paste xbmc-wiiremote (do not press enter yet)
2. Press 1 and 2 on the WiiRemote
3. press enter
4. leave this terminal open and open Kodi

You should see Kodi recognize the WiiRemote. You can press the power button on the WiiRemote to save battery. To reconnect press the 1 and 2 again. As long as you leave the terminal window with xbmc-wiiremote open you will be able to do this, even if you exit/open Kodi.

The executable depends on libcwiid and libbluetooth and is compiled using
# g++ WiiRemote.cpp -lcwiid -o WiiRemote

The WiiRemote will emulate the mouse by default, this can be disabled by passing --disable-mouseemulation on the command line.

The sensitivity of the mouse emulation can be set using the --deadzone_x or --deadzone_y, followed by the percentage of the space to consider "dead." A higher numberm eans higher sensitivity.

Other commands can be listed with --help

The WiiRemote can be mapped in [[keymap.xml]] with the following button IDs:
;WiiRemote
:1 = Up
:2 = Down
:3 = Left
:4 = Right
:5 = A
:6 = B
:7 = Minus
:8 = Home
:9 = Plus
:10 = 1
:11 = 2

;Nunchuck
:21 = Up (axis)
:22 = Dow (axis)
:23 = Left (axis)
:24 = Right (axis)
:25 = C
:26 = Z

The name is by default WiiRemote, but this can be changed with the --joystick-name argument.

=== J2ME (Java Phone Application) (no longer supported) ===
{{future note|17|Support for J2ME client was removed in Kodi v17 via pull request https://github.com/xbmc/xbmc/pull/10049. If you absolutely must have it, revert the changes and follow the instructions to compile it.}}

The J2ME client requires the following:
* CLDC 1.0 and MIDP 1.0
* bluetooth connectivity
* client must be able to initialize the connection

For compiling the Java application, see Clients/J2ME and Client/README (precompiled versions exists in our forum).

The Client can be mapped in the same manner as the PS3 controller in keymap.xml, but with the name J2ME:
<joystick name="J2ME">

The KeyIDs are generated in terminal using j2me_remote.py.

== Known Working EventClients ==
All clients are able to talk to any server on any OS, but the client software is often OS specific.

=== Kodi for Linux ===
* Sony PlayStation 3 (PS3) Blu-ray Remote
* PS3 Sixaxis GamePad
* Wii Remote
* J2ME (CellPhone)
* [https://github.com/xhaggi/kodi-eventclient-hama-mce Hama MCE Remote Control]

=== Kodi for Mac OS X ===
* Apple Remote
* Sony PlayStation 3 (PS3) Blu-ray Remote
* J2ME (CellPhone)

=== Kodi for Windows ===
* Sony PlayStation 3 (PS3) Blu-ray Remote
* Xbox 360 Controller
* J2ME (CellPhone)
* [http://forum.kodi.tv/showthread.php?t=38160 EventGhost]

== Known Caveats ==
* Most of the clients are using python, so PyBluez and Lightblue must be.
* PyBluez only works with broadcom chipsets on 32-bit Windows.

== Development of EventClients and the EventServer API ==

=== Example demos of EventClients (open source code) ===
You can find several open source EventClient examples written in C++, Python, and Java in the Kodi Github. Look under [https://github.com/xbmc/xbmc/tree/master/tools/EventClients EventClients]. This directory contains seven event client sample programs that demonstrate Kodi's EventServer API. The different programs are in C++, Python, and Java. Kodi must be running to receive events. Please see README.txt for more information.

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

InfoLabels

2018-01-29T16:35:15Z

Xhaggi: /* PVR */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}
<section begin="main content" />
Skins can use infolabels with $INFO[infolabel] or the <info> tag. Scripts can read infolabels with <code>xbmc.getInfoLabel('infolabel')</code>.

An up-to-date list can be found here [https://github.com/xbmc/xbmc/blob/master/xbmc/GUIInfoManager.cpp GUIInfoManager.cpp]

=== ADSP ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ADSP.ActiveStreamType
| User selected stream type, e.g. music or video
|
|-
| ADSP.DetectedStreamType
| Detected stream type by Kodi
|
|-
| ADSP.MasterName
| Name of the curently selected and used master dsp mode
|
|-
| ADSP.MasterInfo
| Continuously updated information label of master mode (if available)
|
|-
| ADSP.MasterOwnIcon
| Icon to use for selected master mode
|
|-
| ADSP.MasterOverrideIcon
| Icon to overrite Kodi's codec icon with one of add-on, e.g. Dolby Digital EX on Dolby Digital
|
|}

=== Container ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Container.Content
| Shows content of the current container
|
|-
| Container.FolderPath
| Shows complete path of currently displayed folder
|
|-
| Container.FolderName
| Shows top most folder in currently displayed folder
|
|-
| Container.Viewmode
| Returns the current viewmode (list, icons etc.)
|
|-
| Container.SortMethod
| Returns the current sort method (name, year, rating, etc.)
|
|-
| Container.SortOrder
| Returns the current sort order (Ascending/Descending)
|
|-
| Container.PluginName
| Returns the current plugins base folder name
|
|-
| Container.PluginCategory
| Returns the current plugins category (set by the scripter)
|
|-
| Container.ShowPlot
| Returns the TV Show plot of the current container and can be used at season and episode level
|
|-
| Container.ShowTitle
| Returns the TV Show title of the current container and can be used at season and episode level
| v17 addition
|-
| Container(id).NumPages
| Number of pages in the container with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).NumItems
| Number of items in the container or grouplist with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).CurrentPage
| Current page in the container with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).CurrentItem
| Current item in the container or grouplist with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).Position
| Returns the current focused position of container / grouplist (id) as a numeric label.
|
|-
| Container(id).Column
| Returns the column number of the focused position in a panel container.
|
|-
| Container(id).Row
| Returns the row number of the focused position in a panel container.
|
|-
| Container(id).Totaltime
| Returns the total time of all items in the current container
|
|-
| Container(id).TotalWatched
| Returns the number of watched items in the current container
|
|-
| Container(id).TotalUnWatched
| Returns the number of unwatched items in the current container
|
|-
| Container(id).ListItem(offset).Label
| Shows ListItem.Label for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(2).Label )''
|
|-
| Container(id).ListItem(offset).Label2
| Shows ListItem.Label2 for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(-2).Label2 )''
|
|-
| Container(id).ListItem(offset).Icon
| Shows ListItem.Icon for a specific List or Panel Container with a offset ''( eg: Container(52).Listitem(1).Icon)''
|
|-
| Container(id).ListItem(offset).ActualIcon
| Shows ListItem.ActualIcon for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).ActualIcon )''
|
|-
| Container(id).ListItem(offset).Thumb
| Shows ListItem.Thumb for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).Thumb )''
|
|-
| Container(id).ListItemNoWrap(offset).Property
| 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 )''
|
|-
| Container(id).ListItemPosition(id).[infolabel]
| 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 )''
|
|-
| Container(id).ListItemAbsolute(id).[infolabel]
| 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 )''
|
|-
| Container.Property(addoncategory)
| Returns the current add-on category
|
|-
| Container.Property(reponame)
| Returns the current add-on repository name
|
|-
| Container.ViewCount
| The number of available skin view modes for the current container listing.
|
|}

=== Control ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Control.GetLabel(id)[.index()]
| 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.
|
|}

=== Fanart ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Fanart.Color1
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.
|
|-
| Fanart.Color2
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.
|
|-
| Fanart.Color3
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.
|
|}

=== ListItem ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ListItem.Label
| Shows the left label of the currently selected item in a container
|
|-
| ListItem.Label2
| Shows the right label of the currently selected item in a container
|
|-
| ListItem.Title
| Shows the title of the currently selected song or movie in a container
|
|-
| ListItem.OriginalTitle
| Shows the original title of the currently selected movie in a container
|
|-
| ListItem.SortLetter
| Shows the first letter of the current file in a container
|
|-
| ListItem.TrackNumber
| Shows the track number of the currently selected song in a container
|
|-
| ListItem.Artist
| Shows the artist of the currently selected song in a container
|
|-
| ListItem.AlbumArtist
| Shows the artist of the currently selected album in a list
|
|-
| ListItem.Property(Artist_Born)
| Date of Birth of the currently selected Artist
|
|-
| ListItem.Property(Artist_Died)
| Date of Death of the currently selected Artist
|
|-
| ListItem.Property(Artist_Formed)
| Formation date of the currently selected Band
|
|-
| ListItem.Property(Artist_Disbanded)
| Disbanding date of the currently selected Band
|
|-
| ListItem.Property(Artist_YearsActive)
| Years the currently selected artist has been active
|
|-
| ListItem.Property(Artist_Instrument)
| Instruments played by the currently selected artist
|
|-
| ListItem.Property(Artist_Description)
| Shows a biography of the currently selected artist
|
|-
| ListItem.Property(Artist_Mood)
| Shows the moods of the currently selected artist
|
|-
| ListItem.Property(Artist_Style)
| Shows the styles of the currently selected artist
|
|-
| ListItem.Property(Artist_Genre)
| Shows the genre of the currently selected artist
|
|-
| ListItem.Album
| Shows the album of the currently selected song in a container
|
|-
| ListItem.Property(Album_Mood)
| Shows the moods of the currently selected Album
|
|-
| ListItem.Property(Album_Style)
| Shows the styles of the currently selected Album
|
|-
| ListItem.Property(Album_Theme)
| Shows the themes of the currently selected Album
|
|-
| ListItem.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
|
|-
| ListItem.Property(Album_Label)
| Shows the record label of the currently selected Album
|
|-
| ListItem.Property(Album_Description)
| Shows a review of the currently selected Album
|
|-
| ListItem.DiscNumber
| Shows the disc number of the currently selected song in a container
|
|-
| ListItem.Year
| Shows the year of the currently selected song, album or movie in a container
|
|-
| ListItem.Premiered
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container
|
|-
| ListItem.Genre
| Shows the genre of the currently selected song, album or movie in a container
|
|-
| ListItem.Director
| Shows the director of the currently selected movie in a container
|
|-
| ListItem.Country
| Shows the production country of the currently selected movie in a container
|
|-
| ListItem.Episode
| 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.
|
|-
| ListItem.Season
| Shows the season value for the currently selected tvshow
|
|-
| ListItem.TVShowTitle
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library
|
|-
| ListItem.Property(TotalSeasons)
| Shows the total number of seasons for the currently selected tvshow
|
|-
| ListItem.Property(TotalEpisodes)
| Shows the total number of episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(WatchedEpisodes)
| Shows the number of watched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(UnWatchedEpisodes)
| Shows the number of unwatched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(NumEpisodes)
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.PictureAperture
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| ListItem.PictureAuthor
| 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).
|
|-
| ListItem.PictureByline
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| ListItem.PictureBylineTitle
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| ListItem.PictureCamMake
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| ListItem.PictureCamModel
| 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).
|
|-
| ListItem.PictureCaption
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| ListItem.PictureCategory
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| ListItem.PictureCCDWidth
| 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).
|
|-
| ListItem.PictureCity
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| ListItem.PictureColour
| Shows whether the selected picture is "Colour" or "Black and White".
|
|-
| ListItem.PictureComment
| 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.
|
|-
| ListItem.PictureCopyrightNotice
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| ListItem.PictureCountry
| 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).
|
|-
| ListItem.PictureCountryCode
| 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).
|
|-
| ListItem.PictureCredit
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| ListItem.PictureDate
| 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.
|
|-
| ListItem.PictureDatetime
| 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.
|
|-
| ListItem.PictureDesc
| 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).
|
|-
| ListItem.PictureDigitalZoom
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| ListItem.PictureExpMode
| 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).
|
|-
| ListItem.PictureExposure
| 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).
|
|-
| ListItem.PictureExposureBias
| 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).
|
|-
| ListItem.PictureExpTime
| 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.
|
|-
| ListItem.PictureFlashUsed
| 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).
|
|-
| ListItem.PictureFocalLen
| Shows the lens focal length of the selected picture
|
|-
| ListItem.PictureFocusDist
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| ListItem.PictureGPSLat
| 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.
|
|-
| ListItem.PictureGPSLon
| 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.
|
|-
| ListItem.PictureGPSAlt
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| ListItem.PictureHeadline
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| ListItem.PictureImageType
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| ListItem.PictureIPTCDate
| 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).
|
|-
| ListItem.PictureIPTCTime
| 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).
|
|-
| ListItem.PictureISO
| 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).
|
|-
| ListItem.PictureKeywords
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| ListItem.PictureLightSource
| 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).
|
|-
| ListItem.PictureLongDate
| 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.
|
|-
| ListItem.PictureLongDatetime
| 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.
|
|-
| ListItem.PictureMeteringMode
| 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).
|
|-
| ListItem.PictureObjectName
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| ListItem.PictureOrientation
| 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).
|
|-
| ListItem.PicturePath
| Shows the filename and path of the selected picture
|
|-
| ListItem.PictureProcess
| Shows the process used to compress the selected picture
|
|-
| ListItem.PictureReferenceService
| 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).
|
|-
| ListItem.PictureResolution
| Shows the dimensions of the selected picture
|
|-
| ListItem.PictureSource
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| ListItem.PictureSpecialInstructions
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| ListItem.PictureState
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| ListItem.PictureSublocation
| 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).
|
|-
| ListItem.PictureSupplementalCategories
| 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).
|
|-
| ListItem.PictureTransmissionReference
| 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).
|
|-
| ListItem.PictureUrgency
| 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).
|
|-
| ListItem.PictureWhiteBalance
| 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).
|
|-
| ListItem.FileName
| Shows the filename of the currently selected song or movie in a container
|
|-
| ListItem.Path
| Shows the complete path of the currently selected song or movie in a container
|
|-
| ListItem.FolderName
| Shows top most folder of the path of the currently selected song or movie in a container
|
|-
| ListItem.FolderPath
| Shows the complete path of the currently selected song or movie in a container (without user details).
|
|-
| ListItem.FileNameAndPath
| Shows the full path with filename of the currently selected song or movie in a container
|
|-
| ListItem.FileExtension
| Shows the file extension (without leading dot) of the currently selected item in a container
|
|-
| ListItem.Date
| 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)
|
|-
| ListItem.DateAdded
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
|
|-
| ListItem.Size
| Shows the file size of the currently selected song or movie in a container
|
|-
| ListItem.Rating[(name)]
| Shows the scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating.
|
|-
| ListItem.Set
| Shows the name of the set the movie is part of
|
|-
| ListItem.SetId
| Shows the id of the set the movie is part of
|
|-
| ListItem.UserRating
| Shows the user rating of the currently selected item in a container
|
|-
| ListItem.Votes[(name)]
| Shows the IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes.
|
|-
| ListItem.RatingAndVotes[(name)]
| Shows the IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes.
|
|-
| ListItem.Mpaa
| Show the MPAA rating of the currently selected movie in a container
|
|-
| ListItem.ProgramCount
| Shows the number of times an xbe has been run from "my programs"
|
|-
| ListItem.Duration
| Shows the song or movie duration of the currently selected movie in a container
|
|-
| ListItem.DBTYPE
| Shows the database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist). 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.
|
|-
| ListItem.DBID
| Shows the database id of the currently selected listitem in a container
|
|-
| ListItem.Cast
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.CastAndRole
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.Studio
| Studio of current selected Music Video in a container
|
|-
| ListItem.Top250
| Shows the IMDb top250 position of the currently selected listitem in a container.
|
|-
| ListItem.Trailer
| Shows the full trailer path with filename of the currently selected movie in a container
|
|-
| ListItem.Writer
| Name of Writer of current Video in a container
|
|-
| ListItem.Tagline
| Small Summary of current Video in a container
|
|-
| ListItem.PlotOutline
| Small Summary of current Video in a container
|
|-
| ListItem.Plot
| Complete Text Summary of Video in a container
|
|-
| ListItem.IMDBNumber
| The IMDB iD of the selected Video in a container
|
|-
| ListItem.EpisodeName
| (PVR only) The name of the episode if the selected EPG item is a TV Show
|
|-
| ListItem.PercentPlayed
| Returns percentage value [0-100] of how far the selected video has been played
|
|-
| ListItem.LastPlayed
| Last play date of Video in a container
|
|-
| ListItem.PlayCount
| Playcount of Video in a container
|
|-
| ListItem.StartTime
| Start time of current selected TV programme in a container
|
|-
| ListItem.EndTime
| End time of current selected TV programme in a container
|
|-
| ListItem.StartDate
| Start date of current selected TV programme in a container
|
|-
| ListItem.ChannelNumber
| Number of current selected TV channel in a container
|
|-
| ListItem.ChannelName
| Name of current selected TV channel in a container
|
|-
| ListItem.VideoCodec
| 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)
|
|-
| ListItem.VideoResolution
| 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.
|
|-
| ListItem.VideoAspect
| 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)
|
|-
| ListItem.AudioCodec
| 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)
|
|-
| ListItem.AudioChannels
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 7, 8, 10)
|
|-
| ListItem.AudioLanguage
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.SubtitleLanguage
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.Property(AudioCodec.[n])
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
|
|-
| ListItem.Property(AudioChannels.[n])
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
|
|-
| ListItem.Property(AudioLanguage.[n])
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
|
|-
| ListItem.Property(SubtitleLanguage.[n])
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
|
|-
| ListItem.AddonName
| Shows the name of the currently selected addon
|
|-
| ListItem.AddonVersion
| Shows the version of the currently selected addon
|
|-
| ListItem.AddonSummary
| Shows a short description of the currently selected addon
|
|-
| ListItem.AddonDescription
| Shows the full description of the currently selected addon
|
|-
| ListItem.AddonType
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon
|
|-
| ListItem.AddonCreator
| Shows the name of the author the currently selected addon
|
|-
| ListItem.AddonDisclaimer
| Shows the disclaimer of the currently selected addon
|
|-
| ListItem.AddonBroken
| Shows a message when the addon is marked as broken in the repo
|
|-
| ListItem.Property(Addon.Changelog)
| Shows the changelog of the currently selected addon
|
|-
| ListItem.Property(Addon.ID)
| Shows the identifier of the currently selected addon
|
|-
| ListItem.Property(Addon.Status)
| Shows the status of the currently selected addon
|
|-
| ListItem.Property(Addon.Path)
| Shows the path of the currently selected addon
|
|-
| ListItem.StartTime
| Start time of the selected item (PVR).
|
|-
| ListItem.EndTime
| End time of the selected item (PVR).
|
|-
| ListItem.StartDate
| Start date of the selected item (PVR).
|
|-
| ListItem.EndDate
| End date of the selected item (PVR).
|
|-
| ListItem.NextTitle
| Title of the next item (PVR).
|
|-
| ListItem.NextGenre
| Genre of the next item (PVR).
|
|-
| ListItem.NextPlot
| Plot of the next item (PVR).
|
|-
| ListItem.NextPlotOutline
| Plot outline of the next item (PVR).
|
|-
| ListItem.NextStartTime
| Start time of the next item (PVR).
|
|-
| ListItem.NextEndTime
| End of the next item (PVR).
|
|-
| ListItem.NextStartDate
| Start date of the next item (PVR).
|
|-
| ListItem.NextEndDate
| End date of the next item (PVR).
|
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (PVR).
|
|-
| ListItem.SubChannelNumber
| Subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.ChannelNumberLabel
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.Progress
| Part of the programme that's been played (PVR).
|
|-
| ListItem.StereoscopicMode
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
|
|-
| ListItem.Comment
| Comment assigned to the item (PVR/MUSIC).
|
|-
| ListItem.AddonInstallDate
| Date the addon was installed
|
|-
| ListItem.AddonLastUpdated
| Date the addon was last updated
|
|-
| ListItem.AddonLastUsed
| Date the addon was used last
|
|-
| ListItem.AddonNews
| Returns a brief changelog, taken from the addons' addon.xml file
|
|-
| ListItem.AddonSize
| Filesize of the addon
|
|-
| ListItem.Contributors
| List of all people who've contributed to the selected song
|
|-
| ListItem.ContributorAndRole
| List of all people and their role who've contributed to the selected song
|
|-
| ListItem.EndTimeResume
| Returns the time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| ListItem.Mood
| Mood of the selected song
|
|-
| ListItem.Status
| For use with tv shows. It can return one of the following: 'returning series','in production','planned','cancelled' or 'ended'
|
|-
| ListItem.Tag
| Will return the name of the 'tag' this movie is part of.
|
|-
| ListItem.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| ListItem.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| ListItem.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| ListItem.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| ListItem.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| ListItem.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| ListItem.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| ListItem.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| ListItem.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| ListItem.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| ListItem.Appearances
| Returns the number of movies featuring the selected actor / directed by the selected director
| v17 addition
|-
| ListItem.PrivacyPolicy
| Returns the official Kodi privacy-policy
| v17 addition
|}

=== Musicpartymode labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| MusicPartyMode.SongsPlayed
| Number of songs played during Party Mode
|
|-
| MusicPartyMode.MatchingSongs
| Number of songs available to Party Mode
|
|-
| MusicPartyMode.MatchingSongsPicked
| Number of songs picked already for Party Mode
|
|-
| MusicPartyMode.MatchingSongsLeft
| Number of songs left to be picked from for Party Mode
|
|-
| MusicPartyMode.RelaxedSongsPicked
| Not currently used
|
|-
| MusicPartyMode.RandomSongsPicked
| Number of unique random songs picked during Party Mode
|
|}

=== Network labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Network.IsDHCP
| Network type is DHCP or FIXED
|
|-
| Network.IPAddress
| The system's IP Address (<ipaddress> is returned as a string)
|
|-
| Network.LinkState
| Network linkstate e.g. 10mbit/100mbit etc.
|
|-
| Network.MacAddress
| The system's mac address
|
|-
| Network.SubnetMask
| Network subnet mask
|
|-
| Network.GatewayAddress
| Network gateway address
|
|-
| Network.DNS1Address
| Network dns server 1 address
|
|-
| Network.DNS2Address
| Network dns server 2 address
|
|-
| Network.DHCPAddress
| DHCP server ip address
|
|}

=== Player labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Player.FinishTime
| Time playing media will end
|
|-
| Player.FinishTime(format)
| 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).
|
|-
| Player.Chapter
| Current chapter of current playing media
|
|-
| Player.ChapterCount
| Total number of chapters of current playing media
|
|-
| Player.Time
| Elapsed time of current playing media
|
|-
| Player.Time(format)
| 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).
|
|-
| Player.TimeRemaining
| Remaining time of current playing media
|
|-
| Player.TimeRemaining(format)
| 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).
|
|-
| Player.Duration
| Total duration of the current playing media
|
|-
| Player.Duration(format)
| 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).
|
|-
| Player.SeekTime
| Time to which the user is seeking
|
|-
| Player.SeekOffset
| Indicates the seek offset after a seek press (eg user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| Player.SeekOffset(format)
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| Player.SeekStepSize
| Displays the seek step size. (v15 addition)
|
|-
| Player.ProgressCache
| Shows how much of the file is cached above current play percentage
|
|-
| Player.Folderpath
| Shows the full path of the currently playing song or movie
|
|-
| Player.Filenameandpath
| Shows the full path with filename of the currently playing song or movie
|
|-
| Player.StartTime
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| Player.StartTime(format)
| 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).
|
|-
| Player.Title
| Returns the musicplayer title for audio and the videoplayer title for videos.
|
|-
| Player.Filename
| Returns the filename of the currently playing media.
|
|-
| Player.Process(AudioBitsPerSample)
| Bits per sample of the currently playing item
|
|-
| Player.Process(AudioChannels)
| Number of audiochannels of the currently playing item
|
|-
| Player.Process(AudioDecoder)
| Audiodecoder name of the currently playing item
|
|-
| Player.Process(AudioSamplerate)
| Samplerate f the currently playing item
|
|-
| Player.Process(DeintMethod)
| Deinterlace method of the currently playing video
|
|-
| Player.Process(PixFormat)
| Pixel format of the currently playing video
|
|-
| Player.Process(VideoDAR)
| Display aspect ratio of the currently playing video
|
|-
| Player.Process(VideoFPS)
| Video framerate of the currently playing video
|
|-
| Player.Process(VideoHeight)
| Height of the currently playing video
|
|-
| Player.Process(VideoDecoder)
| Videodecoder name of the currently playing video
|
|-
| Player.Process(VideoWidth)
| Width of the currently playing video
|
|}

==== Music player ====

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| MusicPlayer.Title
| 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
|
|-
| MusicPlayer.Album
| 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
|
|-
| MusicPlayer.Property(Album_Mood)
| Shows the moods of the currently playing Album
|
|-
| MusicPlayer.Property(Album_Style)
| Shows the styles of the currently playing Album
|
|-
| MusicPlayer.Property(Album_Theme)
| Shows the themes of the currently playing Album
|
|-
| MusicPlayer.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| MusicPlayer.Property(Album_Label)
| Shows the record label of the currently playing Album
|
|-
| MusicPlayer.Property(Album_Description)
| Shows a review of the currently playing Album
|
|-
| MusicPlayer.Artist
| 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
|
|-
| MusicPlayer.Property(Artist_Born)
| Date of Birth of the currently playing Artist
|
|-
| MusicPlayer.Property(Artist_Died)
| Date of Death of the currently playing Artist
|
|-
| MusicPlayer.Property(Artist_Formed)
| Formation date of the currently playing Artist/Band
|
|-
| MusicPlayer.Property(Artist_Disbanded)
| Disbanding date of the currently playing Artist/Band
|
|-
| MusicPlayer.Property(Artist_YearsActive)
| Years the currently Playing artist has been active
|
|-
| MusicPlayer.Property(Artist_Instrument)
| Instruments played by the currently playing artist
|
|-
| MusicPlayer.Property(Artist_Description)
| Shows a biography of the currently playing artist
|
|-
| MusicPlayer.Property(Artist_Mood)
| Shows the moods of the currently playing artist
|
|-
| MusicPlayer.Property(Artist_Style)
| Shows the styles of the currently playing artist
|
|-
| MusicPlayer.Property(Artist_Genre)
| Shows the genre of the currently playing artist
|
|-
| MusicPlayer.Genre
| 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
|
|-
| MusicPlayer.Lyrics
| Lyrics of current song stored in ID tag info
|
|-
| MusicPlayer.Year
| 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
|
|-
| MusicPlayer.Rating
| 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
|
|-
| MusicPlayer.DiscNumber
| 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
|
|-
| MusicPlayer.Comment
| 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
|
|-
| MusicPlayer.Time
| Current time in song
|
|-
| MusicPlayer.TimeRemaining
| Current remaining time in song
|
|-
| MusicPlayer.TimeSpeed
| Both the time and the playspeed formatted up. eg 1:23 (2x)
|
|-
| MusicPlayer.TrackNumber
| 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
|
|-
| MusicPlayer.Duration
| 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
|
|-
| MusicPlayer.BitRate
| Bitrate of current song
|
|-
| MusicPlayer.Channels
| Number of channels of current song
|
|-
| MusicPlayer.BitsPerSample
| Number of bits per sample of current song
|
|-
| MusicPlayer.SampleRate
| Samplerate of current song
|
|-
| MusicPlayer.Codec
| Codec of current song
|
|-
| MusicPlayer.PlaylistPosition
| Position of the current song in the current music playlist
|
|-
| MusicPlayer.PlaylistLength
| Total size of the current music playlist
|
|-
| MusicPlayer.ChannelName
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| MusicPlayer.ChannelNumber
| Channel number of the radio programme that's currently playing (PVR).
|
|-
| MusicPlayer.SubChannelNumber
| Subchannel number of the radio channel that's currently playing (PVR).
|
|-
| MusicPlayer.ChannelNumberLabel
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| MusicPlayer.ChannelGroup
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| MusicPlayer.Contributors
| List of all people who've contributed to the currently playing song
|
|-
| MusicPlayer.ContributorAndRole
| List of all people and their role who've contributed to the currently playing song
|
|-
| MusicPlayer.Mood
| Mood of the currently playing song
|
|-
| MusicPlayer.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| MusicPlayer.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| MusicPlayer.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| MusicPlayer.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| MusicPlayer.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| MusicPlayer.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| MusicPlayer.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| MusicPlayer.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| MusicPlayer.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| MusicPlayer.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| MusicPlayer.UserRating
| The rating the user gave to the currently playing song
|
|-
| MusicPlayer.DBID
| The database id of the currently playing song
| v17 Addition
|}

==== Video player ====

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| VideoPlayer.Time
| Current time in movie
|
|-
| VideoPlayer.TimeRemaining
| Current remaining time in movie
|
|-
| VideoPlayer.TimeSpeed
| Current time + playspeed. eg 1:23:14 (-4x)
|
|-
| VideoPlayer.Duration
| Length of current movie
|
|-
| VideoPlayer.Title
| Title of currently playing video. If it's in the database it will return the database title, else the filename
|
|-
| VideoPlayer.TVShowTitle
| Title of currently playing episode's tvshow name
|
|-
| VideoPlayer.Season
| Season number of the currently playing episode, if it's in the database
|
|-
| VideoPlayer.Episode
| Episode number of the currently playing episode
|
|-
| VideoPlayer.Genre
| Genre(s) of current movie, if it's in the database
|
|-
| VideoPlayer.Director
| Director of current movie, if it's in the database
|
|-
| VideoPlayer.Country
| Production country of current movie, if it's in the database
|
|-
| VideoPlayer.Year
| Year of release of current movie, if it's in the database
|
|-
| VideoPlayer.Rating
| IMDb user rating of current movie, if it's in the database
|
|-
| VideoPlayer.UserRating
| Shows the user rating of the currently playing item
|
|-
| VideoPlayer.Votes
| IMDb votes of current movie, if it's in the database
|
|-
| VideoPlayer.RatingAndVotes
| IMDb user rating and votes of current movie, if it's in the database
|
|-
| VideoPlayer.mpaa
| MPAA rating of current movie, if it's in the database
|
|-
| VideoPlayer.IMDBNumber
| The IMDB iD of the current video, if it's in the database
|
|-
| VideoPlayer.EpisodeName
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| VideoPlayer.PlaylistPosition
| Position of the current song in the current video playlist
|
|-
| VideoPlayer.PlaylistLength
| Total size of the current video playlist
|
|-
| VideoPlayer.Cast
| A concatenated string of cast members of the current movie, if it's in the database
|
|-
| VideoPlayer.CastAndRole
| A concatenated string of cast members and roles of the current movie, if it's in the database
|
|-
| VideoPlayer.Album
| Album from which the current Music Video is from, if it's in the database
|
|-
| VideoPlayer.Artist
| Artist(s) of current Music Video, if it's in the database
|
|-
| VideoPlayer.Studio
| Studio of current Music Video, if it's in the database
|
|-
| VideoPlayer.Writer
| Name of Writer of current playing Video, if it's in the database
|
|-
| VideoPlayer.Tagline
| Small Summary of current playing Video, if it's in the database
|
|-
| VideoPlayer.PlotOutline
| Small Summary of current playing Video, if it's in the database
|
|-
| VideoPlayer.Plot
| Complete Text Summary of current playing Video, if it's in the database
|
|-
| VideoPlayer.LastPlayed
| Last play date of current playing Video, if it's in the database
|
|- class="userrow
| VideoPlayer.PlayCount
| Playcount of current playing Video, if it's in the database
|
|- class="userrow
| VideoPlayer.VideoCodec
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| VideoPlayer.VideoResolution
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| VideoPlayer.VideoAspect
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| VideoPlayer.AudioCodec
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| VideoPlayer.AudioChannels
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| VideoPlayer.AudioLanguage
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
|
|-
| VideoPlayer.SubtitlesLanguage
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| VideoPlayer.StereoscopicMode
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| VideoPlayer.EndTime
| End date of the currently playing programme (PVR).
|
|-
| VideoPlayer.NextTitle
| Title of the programme that will be played next (PVR).
|
|-
| VideoPlayer.NextGenre
| Genre of the programme that will be played next (PVR).
|
|-
| VideoPlayer.NextPlot
| Plot of the programme that will be played next (PVR).
|
|-
| VideoPlayer.NextPlotOutline
| Plot outline of the programme that will be played next (PVR).
|
|-
| VideoPlayer.NextStartTime
| Start time of the programme that will be played next (PVR).
|
|-
| VideoPlayer.NextEndTime
| End time of the programme that will be played next (PVR).
|
|-
| VideoPlayer.NextDuration
| Duration of the programme that will be played next (PVR).
|
|-
| VideoPlayer.ChannelName
| Name of the curently tuned channel (PVR).
|
|-
| VideoPlayer.ChannelNumber
| Number of the curently tuned channel (PVR).
|
|-
| VideoPlayer.SubChannelNumber
| Subchannel number of the tv channel that's currently playing (PVR).
|
|-
| VideoPlayer.ChannelNumberLabel
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| VideoPlayer.ChannelGroup
| Group of the curently tuned channel (PVR).
|
|-
| VideoPlayer.ParentalRating
| Parental rating of the currently playing programme (PVR).
|
|-
| VideoPlayer.DBID
| The database id of the currently playing video
| v17 Addition
|}

=== Playlist ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Playlist.Length(media)
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| Playlist.Position(media)
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| Playlist.Random
| Returns string ID's 590 (Randomize Play Enabled) or 591 (Disabled)
|
|-
| Playlist.Repeat
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| PVR.NowRecordingTitle
| Title of the programme being recorded
|
|-
| PVR.NowRecordingDateTime
| Start date and time of the current recording
|
|-
| PVR.NowRecordingChannel
| Channel number that's being recorded
|
|-
| PVR.NextRecordingTitle
| Title of the next programme that will be recorded
|
|-
| PVR.NextRecordingDateTime
| Start date and time of the next recording
|
|-
| PVR.NextRecordingChannel
| Channel name of the next recording
|
|-
| PVR.BackendName
| Name of the backend being used
|
|-
| PVR.BackendVersion
| Version of the backend that's being used
|
|-
| PVR.BackendHost
| Backend hostname
|
|-
| PVR.BackendDiskSpace
| Available diskspace on the backend
|
|-
| PVR.BackendChannels
| Number of available channels the backend provides
|
|-
| PVR.BackendTimers
| Number of timers set for the backend
|
|-
| PVR.BackendRecordings
| Number of recording available on the backend
|
|-
| PVR.BackendDiskspace
| Free diskspace available for recordings on the backend
|
|-
| PVR.BackendNumber
| Backend number
|
|-
| PVR.TotalDiscSpace
| Total diskspace available for recordings
|
|-
| PVR.NextTimer
| Next timer date
|
|-
| PVR.Duration
| Returns the duration of the currently played title on TV
|
|-
| PVR.Time
| Returns the time position of the currently played title on TV
|
|-
| PVR.Progress
| Returns the position of currently played title on TV as integer
|
|-
| PVR.TimeShiftStart
| Start position of the timeshift
|
|-
| PVR.TimeShiftEnd
| End position of the timeshift
|
|-
| PVR.TimeShiftCur
| Current position of the timeshift
|
|-
| PVR.TimeShiftProgress
| Returns the position of currently timeshifted title on TV as interger
|
|-
| PVR.ActStreamClient
| Stream client name
|
|-
| PVR.ActStreamDevice
| Stream device name
|
|-
| PVR.ActStreamStatus
| Status of the stream
|
|-
| PVR.ActStreamSignal
| Signal quality of the stream
|
|-
| PVR.ActStreamSnr
| Signal to noise ratio of the stream
|
|-
| PVR.ActStreamBer
| Bit error rate of the stream
|
|-
| PVR.ActStreamUnc
| UNC value of the stream
|
|-
| PVR.ActStreamVideoBitRate
| Video bitrate of the stream
|
|-
| PVR.ActStreamAudioBitRate
| Audio bitrate of the stream
|
|-
| PVR.ActStreamDolbyBitRate
| Dolby bitrate of the stream
|
|-
| PVR.ActStreamProgrSignal
| Signal quality of the programme
|
|-
| PVR.ActStreamProgrSnr
| Signal to noise ratio of the programme
|
|-
| PVR.ActStreamEncryptionName
| Encryption used on the stream
|
|-
| PVR.TVNowRecordingTitle
| Title of the tv programme being recorded
| {{nowrap|v17 Addition}}
|-
| PVR.TVNowRecordingDateTime
| Start date and time of the current tv recording
| {{nowrap|v17 Addition}}
|-
| PVR.TVNowRecordingChannel
| Channel name of the current tv recording
| {{nowrap|v17 Addition}}
|-
| PVR.TVNowRecordingChannelIcon
| Icon of the current recording TV channel
| {{nowrap|v17 Addition}}
|-
| PVR.TVNextRecordingTitle
| Title of the next tv programme that will be recorded
| {{nowrap|v17 Addition}}
|-
| PVR.TVNextRecordingDateTime
| Start date and time of the next tv recording
| {{nowrap|v17 Addition}}
|-
| PVR.TVNextRecordingChannel
| Channel name of the next tv recording
| {{nowrap|v17 Addition}}
|-
| PVR.TVNextRecordingChannelIcon
| Icon of the next recording tv channel
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNowRecordingTitle
| Title of the radio programme being recorded
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNowRecordingDateTime
| Start date and time of the current radio recording
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNowRecordingChannel
| Channel name of the current radio recording
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNowRecordingChannelIcon
| Icon of the current recording radio channel
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNextRecordingTitle
| Title of the next radio programme that will be recorded
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNextRecordingDateTime
| Start date and time of the next radio recording
| {{nowrap|v17 Addition}}
|-
| PVR.RadioNextRecordingChannel
| Channel name of the next radio recording
| {{nowrap|v17 Addition}}
|}

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

=== Skin ===

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

=== Slideshow ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Slideshow.Altitude
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| Slideshow.Aperture
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| Slideshow.Author
| 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).
|
|-
| Slideshow.Byline
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| Slideshow.BylineTitle
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| Slideshow.CameraMake
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| Slideshow.CameraModel
| 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).
|
|-
| Slideshow.Caption
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| Slideshow.Category
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| Slideshow.CCDWidth
| 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).
|
|-
| Slideshow.City
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| Slideshow.Colour
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| Slideshow.CopyrightNotice
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| Slideshow.Country
| 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).
|
|-
| Slideshow.CountryCode
| 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).
|
|-
| Slideshow.Credit
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| Slideshow.DigitalZoom
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| Slideshow.EXIFComment
| 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.
|
|-
| Slideshow.EXIFDate
| 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.
|
|-
| Slideshow.EXIFDescription
| 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).
|
|-
| Slideshow.EXIFSoftware
| 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).
|
|-
| Slideshow.EXIFTime
| 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.
|
|-
| Slideshow.Exposure
| 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).
|
|-
| Slideshow.ExposureBias
| 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).
|
|-
| Slideshow.ExposureMode
| 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).
|
|-
| Slideshow.ExposureTime
| 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.
|
|-
| Slideshow.Filedate
| Shows the file date of the current picture
|
|-
| Slideshow.Filename
| Shows the file name of the current picture
|
|-
| Slideshow.Filesize
| Shows the file size of the current picture
|
|-
| Slideshow.FlashUsed
| 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).
|
|-
| Slideshow.FocalLength
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| Slideshow.FocusDistance
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| Slideshow.Headline
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| Slideshow.ImageType
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| Slideshow.IPTCDate
| 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).
|
|-
| Slideshow.ISOEquivalence
| 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).
|
|-
| Slideshow.Keywords
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| Slideshow.Latitude
| 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.
|
|-
| Slideshow.LightSource
| 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).
|
|-
| Slideshow.LongEXIFDate
| 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.
|
|-
| Slideshow.LongEXIFTime
| 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.
|
|-
| Slideshow.Longitude
| 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.
|
|-
| Slideshow.MeteringMode
| 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).
|
|-
| Slideshow.ObjectName
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| Slideshow.Orientation
| 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).
|
|-
| Slideshow.Path
| Shows the file path of the current picture
|
|-
| Slideshow.Process
| Shows the process used to compress the current picture
|
|-
| Slideshow.ReferenceService
| 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).
|
|-
| Slideshow.Resolution
| Shows the dimensions of the current picture (Width x Height)
|
|-
| Slideshow.SlideComment
| 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.
|
|-
| Slideshow.SlideIndex
| Shows the slide index of the current picture
|
|-
| Slideshow.Source
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| Slideshow.SpecialInstructions
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| Slideshow.State
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| Slideshow.Sublocation
| 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).
|
|-
| Slideshow.SupplementalCategories
| 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).
|
|-
| Slideshow.TimeCreated
| 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).
|
|-
| Slideshow.TransmissionReference
| 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).
|
|-
| Slideshow.Urgency
| 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).
|
|-
| Slideshow.WhiteBalance
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| System.Time
| Current time
|
|-
| System.Time(format)
| 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
|
|-
| System.Date
| Current date
|
|-
| System.Date(format)
| 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.
|
|-
| System.AlarmPos
| Shutdown Timer position
|
|-
| System.BatteryLevel
| Returns the remaining battery level in range 0-100
|
|-
| System.FreeSpace
| Total Freespace on the drive
|
|-
| System.UsedSpace
| Total Usedspace on the drive
|
|-
| System.TotalSpace
| Totalspace on the drive
|
|-
| System.UsedSpacePercent
| Total Usedspace Percent on the drive
|
|-
| System.FreeSpacePercent
| Total Freespace Percent on the drive
|
|-
| System.CPUTemperature
| Current CPU temperature
|
|-
| System.CpuUsage
| Displays the cpu usage for each individual cpu core.
|
|-
| System.CoreUsage(id)
| Displays the usage of the cpu core with the given 'id'
|
|-
| System.GPUTemperature
| Current GPU temperature
|
|-
| System.FanSpeed
| Current fan speed
|
|-
| System.BuildVersion
| Version of build
|
|-
| System.BuildDate
| Date of build
|
|-
| System.FriendlyName
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. eg. "Kodi (htpc)"
|
|-
| System.FPS
| Current rendering speed (frames per second)
|
|-
| System.FreeMemory
| Amount of free memory in Mb
|
|-
| System.Memory(format)
| Available formats: used, used.percent, free, free.percent, total
|
|-
| System.ScreenMode
| Screenmode (eg windowed / fullscreen)
|
|-
| System.ScreenWidth
| Width of screen in pixels
|
|-
| System.ScreenHeight
| Height of screen in pixels
|
|-
| System.StartupWindow
| The Window Kodi will load on startup
|
|-
| System.CurrentWindow
| Current Window we are in
|
|-
| System.CurrentControl
| Current focused control
|
|-
| System.CurrentControlID
| ID of the currently focused control.
|
|-
| System.DVDLabel
| Label of the disk in the DVD-ROM drive
|
|-
| System.HddTemperature
| Hdd temperature
|
|-
| System.OSVersionInfo
| System name + kernel version
|
|-
| System.KernelVersion (deprecated)
| System name + kernel version
|
|-
| System.Uptime
| System current uptime
|
|-
| System.TotalUptime
| System total uptime
|
|-
| System.CpuFrequency
| System cpu frequency
|
|-
| System.ScreenResolution
| Screen resolution
|
|-
| System.VideoEncoderInfo
| Video encoder info
|
|-
| System.InternetState
| Will return the internet state, connected or not connected
and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.
|
|-
| System.Language
| Shows the current language
|
|-
| System.GetBool(boolean)
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| System.ProfileName
| Shows the User name of the currently logged in Kodi user
|
|-
| System.ProfileCount
| Shows the number of defined profiles
|
|-
| System.ProfileAutoLogin
| The profile Kodi will auto login to
|
|-
| System.StereoscopicMode
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| System.TemperatureUnits
| Shows Celsius or Fahrenheit symbol
|
|-
| System.AddonTitle(id)
| Returns the title of the addon with the given id
|
|-
| System.AddonVersion(id)
| Returns the version of the addon with the given id
|}

=== Visualisation ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Visualisation.Preset
| Shows the current preset of the visualisation.
|
|-
| Visualisation.Name
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

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

=== Window ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Window([window]).Property(key)
| Window property. (key can be any value, optional window can be id or name)
|
|-
| Window.Property(xmlfile)
| Displays the name of the xml file currently shown
|
|-
| Window(AddonBrowser).Property(Updated)
| Shows the date and time the addon repo was last checked for updates
|
|-
| Window.Property(Addon.ID)
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| Window(Home).Property(key)
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

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

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

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

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

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

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Container.Art(tvshow.fanart)
| Fanart Image of the parent TV show
|
|-
| Container.Art(season.poster)
| Thumbnail Image of the parent season
|
|-
| Container.Art(artist.fanart)
| Fanart Image of the parent album artist
|
|-
| Container.Art(artist.thumb)
| Thumbnail Image of the parent album artist
|
|-
| Fanart.Image
| Fanart image for the parent TV Show
|
|-
| ListItem.Thumb
| 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).
|
|-
| ListItem.Icon
| 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.
|
|-
| ListItem.ActualIcon
| Shows the icon of the currently selected item in a list or thumb control.
|
|-
| ListItem.Art(clearart)
| Returns the clearart (if it exists) of the currently selected movie or tv show.
|
|-
| ListItem.Art(clearlogo)
| Returns the clearlogo (if it exists) of the currently selected movie or tv show.
|
|-
| ListItem.Art(landscape)
| Returns the 16:9 landscape (if it exists) of the currently selected movie or tv show.
|
|-
| ListItem.Art(thumb)
| Returns the thumbnail of the currently selected item.
|
|-
| ListItem.Art(poster)
| Returns the poster of the currently selected movie or tv show.
|
|-
| ListItem.Art(banner)
| Returns the banner of the currently selected tv show.
|
|-
| ListItem.Art(fanart)
| Returns the fanart image of the currently selected item.
|
|-
| ListItem.Art(set.fanart)
| Returns the fanart image of the currently selected movieset.
|
|-
| ListItem.Art(landscape)
| Returns the landscape art of the currently selected item.
|
|-
| ListItem.Art(tvshow.poster)
| Returns the tv show poster of the parent container.
|
|-
| ListItem.Art(tvshow.banner)
| Returns the tv show banner of the parent container.
|
|-
| ListItem.Art(tvshow.clearlogo)
| Returns the tv show clearlogo (if it exists) of the parent container.
|
|-
| ListItem.Art(tvshow.landscape)
| Returns the tv show landscape (if it exists) of the parent container.
|
|-
| ListItem.Art(tvshow.clearart)
| Returns the tv show clearart (if it exists) of the parent container.
|
|-
| ListItem.Art(season.poster)
| Returns the season poster of the currently selected season. (Only available in DialogVideoInfo.xml)
|
|-
| ListItem.Art(season.banner)
| Returns the season banner of the currently selected season. (Only available in DialogVideoInfo.xml)
|
|-
| ListItem.Art(season.fanart)
| Returns the fanart image of the currently selected season. (Only available in DialogVideoInfo.xml)
|
|-
| ListItem.Overlay
| 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.
|
|-
| ListItem.Property(ArtistThumb)
| Thumbnail Image of the parent artist, for use in dialogalbuminfo.xml and dialogsonginfo.xml
|
|-
| ListItem.Property(Fanart_Image)
| Fanart Image currently selected item or of the parent TV show
|
|-
| MusicPlayer.Cover
| Cover of currently playing album
|
|-
| MusicPlayer.Property(Fanart_Image)
| Fanart image of the currently playing artist
|
|-
| Player.Art(fanart)
| Fanart Image of the currently playing episode's parent TV show
|
|-
| Player.Art(thumb)
| Returns the thumbnail image of the currently playing item.
|
|-
| Player.Art(poster)
| Returns the poster of the currently playing movie.
|
|-
| Player.Art(clearlogo)
| Returns the clearlogo of the currently playing movie.
|
|-
| Player.Art(clearart)
| Returns the clearart of the currently playing movie.
|
|-
| Player.Art(landscape)
| Returns the landscape of the currently playing movie.
|
|-
| Player.Art(tvshow.poster)
| Returns the tv show poster of the currently playing episode's parent TV show.
|
|-
| Player.Art(tvshow.banner)
| Returns the tv show banner of the currently playing episode's parent TV show.
|
|-
| Player.Art(tvshow.landscape)
| Returns the tv show landscape of the currently playing episode's parent TV show.
|
|-
| Player.Art(tvshow.clearart)
| Returns the clearart of the currently playing episode's parent TV show.
|
|-
| Player.Art(tvshow.clearlogo)
| Returns the tv show clearlogo of the currently playing episode's parent TV show.
|
|-
| Player.StarRating
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| Pvr.NowRecordingChannelIcon
| Channel icon of the programme currently being recorded.
|
|-
| Pvr.NextRecordingChannelIcon
| Channel icon of the programme that will be recorded next.
|
|-
| Skin.String(name)
| 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 user-customisable images and multiimages.
|
|-
| System.AddonIcon(id)
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (eg. $INFO[Skin.String(Foo)])
|
|-
| System.ProfileThumb
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| VideoPlayer.Cover
| Cover of currently playing movie
|
|-
| Weather.Conditions
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| Window([window]).Property(key)
| Window property. (key can be any value, optional window can be id or name)
|
|-
| Window(Weather).Property(key)
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

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

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

Skinning Manual

2018-01-13T12:32:00Z

Xhaggi: /* Nested */

{{TOC right}}{{mininav|[[Development]]|[[Skin development]]}}

Kodi includes a GUI library that allows you to skin/change everything you see in Kodi, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning Kodi, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the Kodi skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning Kodi]] as well as the "[[Skinning XBMC|Skinning Kodi]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

= Anatomy of a Skin =
Kodi skins, once installed, are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from, or be installed via zip, Kodi will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/720p
: This is a resolution-specific directory. Kodi can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!)
; myskin/backgrounds
: optional folder containing the background images used in the skin
; myskin/colors
: contains a defaults.xml file which is used to define the colours used in the skin
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/language
: contains several subfolders for each language (English/strings.po). you can define strings used in your skin in this file.
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; myskin/resources
: place your icon.png (a 256x256 or 512x512 png image for your skin), fanart.jpg (a 1280x720 or 1920x1080 jpeg fanart image for your skin) and 10 jpeg screenshots (1280x720) of your skin in here. Name them screenshot01.jpg, screenshot02.jpg ect.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that Kodi uses to find the other files that Kodi requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/LICENSE.txt
: we recommend to include a Creative Commons license file in your skin: http://creativecommons.org/licenses/
[[Addon.xml#Skin specific elements|See here for the order in which it looks for skin files.]]

= Skin Themes =
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, Kodi allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, Kodi will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. Kodi will automatically pick them up.

= addon.xml =

{{main|addon.xml}}

= Windows =
== Window Structure ==
{{#lst:Window Structure|main content}}

= Includes =
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
You can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<include condition="Skin.HasSetting(extras) file="includes_extras.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</syntaxhighlight>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<syntaxhighlight lang="XML" enclose="div">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</syntaxhighlight>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<left>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 

== Use params in includes ==
As of Kodi 15.0 Isengard you get is the ability to pass arbitrary parameters to your includes and then use these values anywhere within the include body. Just so you don't have to copy/paste huge chunks of XML anymore in order to change just a value or two. Includes are now roughly equivalent to "procedures" in programming languages. Here's the final syntax that has been included in Kodi.

'''Include definitions''' are still written within ''<includes>'' tag, usually in ''includes.xml''. But they can now accept parameters:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<param name="id"/>
<param name="left" default="120"/>
<param name="top">225</param>
<definition>
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
<definition>
</include>
</syntaxhighlight>

Here, the first part is called ''parameter list'' and is specified using ''<param>'' tags. When it is present, include body that follows it should be enclosed within ''<definition>'' tag. At the moment, parameter list is optional and is mainly used for specifying default values for parameters (such as ''120'' and ''225'' above), but is otherwise not mandatory.

The above include can be called like this:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<param name="id" value="52"/>
<param name="left">300</param>
</include>
</syntaxhighlight>

This has the exact same effect as if you've written this instead:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<control type="image" id="52">
<left>300</left>
<top>225</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

and called it (old-style) like this:

<syntaxhighlight lang="XML" enclose="div">
<include>MyControl</include>
</syntaxhighlight>

only without added benefits.

Any appropriate value can be passed as parameter in the new '''include call''', including ''$INFO'' labels, ''$LOCALIZE'', ''$VAR''s, constants, etc. Empty string (''value=""'') can also be passed, for example to override a non-empty default value set in the include definition.

Default values are used as replacement when their parameters are not passed in the include call.

''$PARAM'' references can be specified within both '''tag values and attributes''' inside include body, and are expanded to either actual value passed (if it was passed), default value (if set) or empty string, in that order.

Parameters without default values (such as ''id'' above) are specified for better readability and documentation purposes only, but are otherwise not necessary and can be omitted. This is really a matter of style, and some skinners might prefer writing explicit parameter lists to specify all parameters referenced in the include body. It's a good practice though, as explicit parameter lists might be better utilized in the future versions of Kodi.

If there are no ''<param>'' tags at all, ''<definition>'' can be omitted too. This leads to even shorter syntax:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

Includes can call other (nested) includes and even pass them ''exact'' parameter values that they've got themselves. This is called '''parameter forwarding'''.

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
...
<include name="MyOtherControl">
<param name="label">$INFO[Player.Title]</param>
<param name="label2" value="x:$PARAM[left]; y:$PARAM[top]"/>
<param name="color" value="$PARAM[color]"/> 
<param name="id" value="$PARAM[scrollbarid]"/> 
</include>
...
</include>
</syntaxhighlight>

Here, ''$PARAM[color]'' and ''$PARAM[scrollbarid]'' will be forwarded to ''MyOtherControl'' '''only''' if parameters ''color'' and ''scrollbarid'' have actually been passed to ''MyControl'', otherwise the default values for ''color'' and ''id'' (if set in ''MyOtherControl'') will be used instead in the body of ''MyOtherControl''. Composite values containing other characters (such as ''label2'') are not considered as "true" forwarding and always override any default value set in the nested include, even when they expand to empty strings.
 

== Nested ==

The <code>nested</code> element can be used as a placeholder for elements (controls) defined between the start-tag and end-tag of an include element. The nested part can contain anything what is valid in our skin language. Using parameters for the nested XML fragment is also supported.

This is really handy if you want to re-use elements (controls) before and after some variable elements (controls) e.g. a box with a header and footer but variable content.

=== Definition of an include using nested ===
<syntaxhighlight lang="XML" enclose="div">
<include name="MyBox">
<control type="">
...
</control>
<control type="group">
<top>$PARAM[top]</top>
<left>$PARAM[left]</left>
...
<nested /> 
...
</control>
</include>
</syntaxhighlight>

=== Use the include with nested elements ===
<syntaxhighlight lang="XML" enclose="div">
<include content="MyBox">
<param name="top" value="100" />
<param name="left" value="200" />


<control type="label">
...
</control>
<control type="group">
<control type="label">
...
</control>
</control>
</include>
</syntaxhighlight>

== Variables ==
Variables make it easier to use conditional infolabels. You can define them in Includes.xml, or to keep them separate, you can place them in another file which is included in Includes.xml.
You can include a file in Includes.xml by adding a line like this:
<syntaxhighlight lang="XML" enclose="div">
<include file="Variables.xml" />
</syntaxhighlight>
Variables can be used in any tag that supports infolabels, like the texture, label and visible tags. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<syntaxhighlight lang="XML" enclose="div">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</syntaxhighlight>
You can use a variable in a label control like this:
<syntaxhighlight lang="XML" enclose="div">
<label>$VAR[Example]</label>
</syntaxhighlight>
or when the viariable value is likely to contain commas (,) and/or quotes ("):
<syntaxhighlight lang="XML" enclose="div">
<label>$ESCVAR[Example]</label>
</syntaxhighlight>
(see $ESCINFO[] for more info on the need to escape strings: http://kodi.wiki/view/Label_Parsing)
 

== Constants ==
In case you want to re-use a certain value multiple times in your skin, you can define a constant for it:
<syntaxhighlight lang="XML" enclose="div">
<constant name="FanartCrossfadeTime">300</constant>
<constant name="IconCrossfadeTime">300</constant>
</syntaxhighlight>

you can now reference this value by it's name elsewhere in your skin:
<syntaxhighlight lang="XML" enclose="div">
<control type="image">
<left>0</left>
<top>0</top>
<width>256</width>
<height>256</height>
<texture background="true">$INFO[ListItem.Icon]</texture>
<fadetime>IconCrossfadeTime</fadetime>
</control>
</syntaxhighlight>
 

== Defaults ==
for every control type, you can define a default template. for instance here's a template for a button control:
<syntaxhighlight lang="XML" enclose="div">
<default type="button">
<left>0</left>
<top>0</top>
<width>700</width>
<height>40</height>
<label>-</label>
<texturefocus border="20">list-focus.png</texturefocus>
<texturenofocus border="20">list-nofocus.png</texturenofocus>
font20
<textcolor>white</textcolor>
<focusedcolor>blue</focusedcolor>
<disabledcolor>darkgrey</disabledcolor>
<invalidcolor>red</invalidcolor>
<textoffsetx>10</textoffsetx>
<aligny>center</aligny>
<pulseonselect>true</pulseonselect>
</default>
</syntaxhighlight>

the benefit of defining defaults is that kodi will use the template everywhere in you skin where a button is used,
so you don't have to code all of the tags for each and every button. you only have to code the tags that you want to differ from the default template.
 

== Expressions ==
expressions are useful if you need to use a certain boolean expression several times throughout your skin.
they can be defined in your includes file like this:
<syntaxhighlight lang="XML" enclose="div">
<expression name="HasInfoDialog">Window.IsActive(musicinformation) | Window.IsActive(movieinformation) | Window.IsActive(addoninformation)</expression>
<expression name="PluginAdvancedLauncher">substring(Container.FolderPath,plugin://plugin.program.advanced.launcher/,left)</expression>
</syntaxhighlight>

to use an expression in your skin, you can reference them using $EXP[]
<syntaxhighlight lang="XML" enclose="div">
<animation condition="$EXP[HasInfoDialog]" effect="fade" start="100" end="0" time="200" tween="sine">Conditional</animation>
</syntaxhighlight>

<syntaxhighlight lang="XML" enclose="div">
<visible>$EXP[PluginAdvancedLauncher] + !Window.IsActive(Home)</visible>
</syntaxhighlight>

expressions can be used in the following tags/attributes:
* visible
* enable
* usealttexture
* selected
* condition

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{#lst:Label Control|main content}}
== Fade Label Control ==
{{#lst:Fade Label Control|main content}}
== Button Control ==
{{#lst:Button control|main content}}
== Image Control ==
{{#lst:Image Control|main content}}
== MultiImage Control ==
{{#lst:MultiImage Control|main content}}
== Radio button Control ==
{{#lst:Radio button control|main content}}
== Toggle button control ==
{{#lst:Toggle button control|main content}}
== Spin Control ==
{{#lst:Spin_Control|main content}}
== Settings Spin Control ==
{{#lst:Settings_Spin_Control|main content}}
== Slider Control ==
{{#lst:Slider Control|main content}}
== Progress Control ==
{{#lst:Progress Control|main content}}
== ScrollBar Control ==
{{#lst:Scroll Bar Control|main content}}
== Text Box ==
{{#lst:Text Box|main content}}
== RSS feed Control ==
{{#lst:RSS feed Control|main content}}
== Visualisation Control ==
{{#lst:Visualisation Control|main content}}
== Video Control ==
{{#lst:Video Control|main content}}
== Mover Control ==
{{#lst:Mover Control|main content}}
== Resize Control ==
{{#lst:Resize Control|main content}}
== Edit Control ==
{{#lst:Edit Control|main content}}
== EPGGrid Control ==
{{#lst:EPGGrid_control|main content}}
== Gamecontroller Control ==
{{#lst:Gamecontroller_Control|main content}}
== Group Control ==
{{#lst:Group Control|main content}}
== GroupList Control ==
{{#lst:Group List Control|main content}}
== List Container ==
{{#lst:List Container|main content}}
== Wraplist Container ==
{{#lst:Wrap List Container|main content}}
== FixedList Container ==
{{#lst:Fixed List Container|main content}}
== Panel Container ==
{{#lst:Panel Container|main content}}

= Filling containers=
== Filling containers with static content ==
{{#lst:Static List Content|main content}}

== Filling containers with dynamic content ==
{{#lst:Dynamic List Content|main content}}

= Conditional_Visibility =
Kodi's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{#lst:Conditional Visibility|main content}}

= Animations =
The Kodi skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
== Animating Your Skin ==
{{#lst:Animating Your Skin|main content}}

= Tweeners =
{{#lst:Tweeners|main content}}

= Fonts =
Kodi allows you to customize which fonts are displayed onscreen in the User Interface.
{{#lst:Fonts|main content}}

= Appendix I: List of Windows =
{{#lst:Window IDs|main content}}

= Appendix II: List of Boolean Conditions =
{{#lst:List of Boolean Conditions|main content}}

= Appendix III: List of Info Labels =
{{#lst:InfoLabels|main content}}

= Appendix IV: List of Built In Functions =
{{#lst:List of Built In Functions|main content}}

= Appendix V: List of Built In Controls =
{{#lst:List of Built In Controls|main content}}

= Appendix VI: List of Default Icons =
{{#lst:Default Icons|main content}}

[[Category:Repositories]]
[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development|*]]
[[Category:Python]]

Skinning Manual

2018-01-13T12:28:33Z

Xhaggi: /* Nested */

{{TOC right}}{{mininav|[[Development]]|[[Skin development]]}}

Kodi includes a GUI library that allows you to skin/change everything you see in Kodi, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning Kodi, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the Kodi skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning Kodi]] as well as the "[[Skinning XBMC|Skinning Kodi]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

= Anatomy of a Skin =
Kodi skins, once installed, are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from, or be installed via zip, Kodi will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/720p
: This is a resolution-specific directory. Kodi can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!)
; myskin/backgrounds
: optional folder containing the background images used in the skin
; myskin/colors
: contains a defaults.xml file which is used to define the colours used in the skin
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/language
: contains several subfolders for each language (English/strings.po). you can define strings used in your skin in this file.
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; myskin/resources
: place your icon.png (a 256x256 or 512x512 png image for your skin), fanart.jpg (a 1280x720 or 1920x1080 jpeg fanart image for your skin) and 10 jpeg screenshots (1280x720) of your skin in here. Name them screenshot01.jpg, screenshot02.jpg ect.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that Kodi uses to find the other files that Kodi requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/LICENSE.txt
: we recommend to include a Creative Commons license file in your skin: http://creativecommons.org/licenses/
[[Addon.xml#Skin specific elements|See here for the order in which it looks for skin files.]]

= Skin Themes =
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, Kodi allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, Kodi will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. Kodi will automatically pick them up.

= addon.xml =

{{main|addon.xml}}

= Windows =
== Window Structure ==
{{#lst:Window Structure|main content}}

= Includes =
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
You can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<include condition="Skin.HasSetting(extras) file="includes_extras.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</syntaxhighlight>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<syntaxhighlight lang="XML" enclose="div">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</syntaxhighlight>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<left>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 

== Use params in includes ==
As of Kodi 15.0 Isengard you get is the ability to pass arbitrary parameters to your includes and then use these values anywhere within the include body. Just so you don't have to copy/paste huge chunks of XML anymore in order to change just a value or two. Includes are now roughly equivalent to "procedures" in programming languages. Here's the final syntax that has been included in Kodi.

'''Include definitions''' are still written within ''<includes>'' tag, usually in ''includes.xml''. But they can now accept parameters:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<param name="id"/>
<param name="left" default="120"/>
<param name="top">225</param>
<definition>
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
<definition>
</include>
</syntaxhighlight>

Here, the first part is called ''parameter list'' and is specified using ''<param>'' tags. When it is present, include body that follows it should be enclosed within ''<definition>'' tag. At the moment, parameter list is optional and is mainly used for specifying default values for parameters (such as ''120'' and ''225'' above), but is otherwise not mandatory.

The above include can be called like this:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<param name="id" value="52"/>
<param name="left">300</param>
</include>
</syntaxhighlight>

This has the exact same effect as if you've written this instead:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<control type="image" id="52">
<left>300</left>
<top>225</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

and called it (old-style) like this:

<syntaxhighlight lang="XML" enclose="div">
<include>MyControl</include>
</syntaxhighlight>

only without added benefits.

Any appropriate value can be passed as parameter in the new '''include call''', including ''$INFO'' labels, ''$LOCALIZE'', ''$VAR''s, constants, etc. Empty string (''value=""'') can also be passed, for example to override a non-empty default value set in the include definition.

Default values are used as replacement when their parameters are not passed in the include call.

''$PARAM'' references can be specified within both '''tag values and attributes''' inside include body, and are expanded to either actual value passed (if it was passed), default value (if set) or empty string, in that order.

Parameters without default values (such as ''id'' above) are specified for better readability and documentation purposes only, but are otherwise not necessary and can be omitted. This is really a matter of style, and some skinners might prefer writing explicit parameter lists to specify all parameters referenced in the include body. It's a good practice though, as explicit parameter lists might be better utilized in the future versions of Kodi.

If there are no ''<param>'' tags at all, ''<definition>'' can be omitted too. This leads to even shorter syntax:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

Includes can call other (nested) includes and even pass them ''exact'' parameter values that they've got themselves. This is called '''parameter forwarding'''.

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
...
<include name="MyOtherControl">
<param name="label">$INFO[Player.Title]</param>
<param name="label2" value="x:$PARAM[left]; y:$PARAM[top]"/>
<param name="color" value="$PARAM[color]"/> 
<param name="id" value="$PARAM[scrollbarid]"/> 
</include>
...
</include>
</syntaxhighlight>

Here, ''$PARAM[color]'' and ''$PARAM[scrollbarid]'' will be forwarded to ''MyOtherControl'' '''only''' if parameters ''color'' and ''scrollbarid'' have actually been passed to ''MyControl'', otherwise the default values for ''color'' and ''id'' (if set in ''MyOtherControl'') will be used instead in the body of ''MyOtherControl''. Composite values containing other characters (such as ''label2'') are not considered as "true" forwarding and always override any default value set in the nested include, even when they expand to empty strings.
 

== Nested ==

The <code>nested</code> element can be used as a placeholder for elements (controls) defined between the start-tag and end-tag of an include element. The nested part can contain anything what is valid in our skin language. Using parameters for the nested XML fragment is also supported.

This is really handy if you want to re-use elements (controls) before and after some variable elements (controls) e.g. a box with a header and footer but variable content.

=== Definition of an include using nested ===
<syntaxhighlight lang="XML" enclose="div">
<include name="MyBox">
<control type="">
...
</control>
<control type="group">
...
<nested /> 
...
</control>
</include>
</syntaxhighlight>

=== Use the include with nested elements ===
<syntaxhighlight lang="XML" enclose="div">
<include content="MyBox">
<param name="x" value="v1" />
<param name="y" value="v2" />


<control type="label">
...
</control>
<control type="group">
<control type="label">
...
</control>
</control>
</include>
</syntaxhighlight>

== Variables ==
Variables make it easier to use conditional infolabels. You can define them in Includes.xml, or to keep them separate, you can place them in another file which is included in Includes.xml.
You can include a file in Includes.xml by adding a line like this:
<syntaxhighlight lang="XML" enclose="div">
<include file="Variables.xml" />
</syntaxhighlight>
Variables can be used in any tag that supports infolabels, like the texture, label and visible tags. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<syntaxhighlight lang="XML" enclose="div">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</syntaxhighlight>
You can use a variable in a label control like this:
<syntaxhighlight lang="XML" enclose="div">
<label>$VAR[Example]</label>
</syntaxhighlight>
or when the viariable value is likely to contain commas (,) and/or quotes ("):
<syntaxhighlight lang="XML" enclose="div">
<label>$ESCVAR[Example]</label>
</syntaxhighlight>
(see $ESCINFO[] for more info on the need to escape strings: http://kodi.wiki/view/Label_Parsing)
 

== Constants ==
In case you want to re-use a certain value multiple times in your skin, you can define a constant for it:
<syntaxhighlight lang="XML" enclose="div">
<constant name="FanartCrossfadeTime">300</constant>
<constant name="IconCrossfadeTime">300</constant>
</syntaxhighlight>

you can now reference this value by it's name elsewhere in your skin:
<syntaxhighlight lang="XML" enclose="div">
<control type="image">
<left>0</left>
<top>0</top>
<width>256</width>
<height>256</height>
<texture background="true">$INFO[ListItem.Icon]</texture>
<fadetime>IconCrossfadeTime</fadetime>
</control>
</syntaxhighlight>
 

== Defaults ==
for every control type, you can define a default template. for instance here's a template for a button control:
<syntaxhighlight lang="XML" enclose="div">
<default type="button">
<left>0</left>
<top>0</top>
<width>700</width>
<height>40</height>
<label>-</label>
<texturefocus border="20">list-focus.png</texturefocus>
<texturenofocus border="20">list-nofocus.png</texturenofocus>
font20
<textcolor>white</textcolor>
<focusedcolor>blue</focusedcolor>
<disabledcolor>darkgrey</disabledcolor>
<invalidcolor>red</invalidcolor>
<textoffsetx>10</textoffsetx>
<aligny>center</aligny>
<pulseonselect>true</pulseonselect>
</default>
</syntaxhighlight>

the benefit of defining defaults is that kodi will use the template everywhere in you skin where a button is used,
so you don't have to code all of the tags for each and every button. you only have to code the tags that you want to differ from the default template.
 

== Expressions ==
expressions are useful if you need to use a certain boolean expression several times throughout your skin.
they can be defined in your includes file like this:
<syntaxhighlight lang="XML" enclose="div">
<expression name="HasInfoDialog">Window.IsActive(musicinformation) | Window.IsActive(movieinformation) | Window.IsActive(addoninformation)</expression>
<expression name="PluginAdvancedLauncher">substring(Container.FolderPath,plugin://plugin.program.advanced.launcher/,left)</expression>
</syntaxhighlight>

to use an expression in your skin, you can reference them using $EXP[]
<syntaxhighlight lang="XML" enclose="div">
<animation condition="$EXP[HasInfoDialog]" effect="fade" start="100" end="0" time="200" tween="sine">Conditional</animation>
</syntaxhighlight>

<syntaxhighlight lang="XML" enclose="div">
<visible>$EXP[PluginAdvancedLauncher] + !Window.IsActive(Home)</visible>
</syntaxhighlight>

expressions can be used in the following tags/attributes:
* visible
* enable
* usealttexture
* selected
* condition

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{#lst:Label Control|main content}}
== Fade Label Control ==
{{#lst:Fade Label Control|main content}}
== Button Control ==
{{#lst:Button control|main content}}
== Image Control ==
{{#lst:Image Control|main content}}
== MultiImage Control ==
{{#lst:MultiImage Control|main content}}
== Radio button Control ==
{{#lst:Radio button control|main content}}
== Toggle button control ==
{{#lst:Toggle button control|main content}}
== Spin Control ==
{{#lst:Spin_Control|main content}}
== Settings Spin Control ==
{{#lst:Settings_Spin_Control|main content}}
== Slider Control ==
{{#lst:Slider Control|main content}}
== Progress Control ==
{{#lst:Progress Control|main content}}
== ScrollBar Control ==
{{#lst:Scroll Bar Control|main content}}
== Text Box ==
{{#lst:Text Box|main content}}
== RSS feed Control ==
{{#lst:RSS feed Control|main content}}
== Visualisation Control ==
{{#lst:Visualisation Control|main content}}
== Video Control ==
{{#lst:Video Control|main content}}
== Mover Control ==
{{#lst:Mover Control|main content}}
== Resize Control ==
{{#lst:Resize Control|main content}}
== Edit Control ==
{{#lst:Edit Control|main content}}
== EPGGrid Control ==
{{#lst:EPGGrid_control|main content}}
== Gamecontroller Control ==
{{#lst:Gamecontroller_Control|main content}}
== Group Control ==
{{#lst:Group Control|main content}}
== GroupList Control ==
{{#lst:Group List Control|main content}}
== List Container ==
{{#lst:List Container|main content}}
== Wraplist Container ==
{{#lst:Wrap List Container|main content}}
== FixedList Container ==
{{#lst:Fixed List Container|main content}}
== Panel Container ==
{{#lst:Panel Container|main content}}

= Filling containers=
== Filling containers with static content ==
{{#lst:Static List Content|main content}}

== Filling containers with dynamic content ==
{{#lst:Dynamic List Content|main content}}

= Conditional_Visibility =
Kodi's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{#lst:Conditional Visibility|main content}}

= Animations =
The Kodi skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
== Animating Your Skin ==
{{#lst:Animating Your Skin|main content}}

= Tweeners =
{{#lst:Tweeners|main content}}

= Fonts =
Kodi allows you to customize which fonts are displayed onscreen in the User Interface.
{{#lst:Fonts|main content}}

= Appendix I: List of Windows =
{{#lst:Window IDs|main content}}

= Appendix II: List of Boolean Conditions =
{{#lst:List of Boolean Conditions|main content}}

= Appendix III: List of Info Labels =
{{#lst:InfoLabels|main content}}

= Appendix IV: List of Built In Functions =
{{#lst:List of Built In Functions|main content}}

= Appendix V: List of Built In Controls =
{{#lst:List of Built In Controls|main content}}

= Appendix VI: List of Default Icons =
{{#lst:Default Icons|main content}}

[[Category:Repositories]]
[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development|*]]
[[Category:Python]]

Skinning Manual

2018-01-13T12:28:17Z

Xhaggi: /* Nested */

{{TOC right}}{{mininav|[[Development]]|[[Skin development]]}}

Kodi includes a GUI library that allows you to skin/change everything you see in Kodi, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning Kodi, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the Kodi skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning Kodi]] as well as the "[[Skinning XBMC|Skinning Kodi]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

= Anatomy of a Skin =
Kodi skins, once installed, are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from, or be installed via zip, Kodi will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/720p
: This is a resolution-specific directory. Kodi can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!)
; myskin/backgrounds
: optional folder containing the background images used in the skin
; myskin/colors
: contains a defaults.xml file which is used to define the colours used in the skin
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/language
: contains several subfolders for each language (English/strings.po). you can define strings used in your skin in this file.
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; myskin/resources
: place your icon.png (a 256x256 or 512x512 png image for your skin), fanart.jpg (a 1280x720 or 1920x1080 jpeg fanart image for your skin) and 10 jpeg screenshots (1280x720) of your skin in here. Name them screenshot01.jpg, screenshot02.jpg ect.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that Kodi uses to find the other files that Kodi requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/LICENSE.txt
: we recommend to include a Creative Commons license file in your skin: http://creativecommons.org/licenses/
[[Addon.xml#Skin specific elements|See here for the order in which it looks for skin files.]]

= Skin Themes =
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, Kodi allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, Kodi will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. Kodi will automatically pick them up.

= addon.xml =

{{main|addon.xml}}

= Windows =
== Window Structure ==
{{#lst:Window Structure|main content}}

= Includes =
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
You can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<include condition="Skin.HasSetting(extras) file="includes_extras.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</syntaxhighlight>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<syntaxhighlight lang="XML" enclose="div">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</syntaxhighlight>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<left>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 

== Use params in includes ==
As of Kodi 15.0 Isengard you get is the ability to pass arbitrary parameters to your includes and then use these values anywhere within the include body. Just so you don't have to copy/paste huge chunks of XML anymore in order to change just a value or two. Includes are now roughly equivalent to "procedures" in programming languages. Here's the final syntax that has been included in Kodi.

'''Include definitions''' are still written within ''<includes>'' tag, usually in ''includes.xml''. But they can now accept parameters:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<param name="id"/>
<param name="left" default="120"/>
<param name="top">225</param>
<definition>
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
<definition>
</include>
</syntaxhighlight>

Here, the first part is called ''parameter list'' and is specified using ''<param>'' tags. When it is present, include body that follows it should be enclosed within ''<definition>'' tag. At the moment, parameter list is optional and is mainly used for specifying default values for parameters (such as ''120'' and ''225'' above), but is otherwise not mandatory.

The above include can be called like this:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<param name="id" value="52"/>
<param name="left">300</param>
</include>
</syntaxhighlight>

This has the exact same effect as if you've written this instead:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<control type="image" id="52">
<left>300</left>
<top>225</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

and called it (old-style) like this:

<syntaxhighlight lang="XML" enclose="div">
<include>MyControl</include>
</syntaxhighlight>

only without added benefits.

Any appropriate value can be passed as parameter in the new '''include call''', including ''$INFO'' labels, ''$LOCALIZE'', ''$VAR''s, constants, etc. Empty string (''value=""'') can also be passed, for example to override a non-empty default value set in the include definition.

Default values are used as replacement when their parameters are not passed in the include call.

''$PARAM'' references can be specified within both '''tag values and attributes''' inside include body, and are expanded to either actual value passed (if it was passed), default value (if set) or empty string, in that order.

Parameters without default values (such as ''id'' above) are specified for better readability and documentation purposes only, but are otherwise not necessary and can be omitted. This is really a matter of style, and some skinners might prefer writing explicit parameter lists to specify all parameters referenced in the include body. It's a good practice though, as explicit parameter lists might be better utilized in the future versions of Kodi.

If there are no ''<param>'' tags at all, ''<definition>'' can be omitted too. This leads to even shorter syntax:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

Includes can call other (nested) includes and even pass them ''exact'' parameter values that they've got themselves. This is called '''parameter forwarding'''.

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
...
<include name="MyOtherControl">
<param name="label">$INFO[Player.Title]</param>
<param name="label2" value="x:$PARAM[left]; y:$PARAM[top]"/>
<param name="color" value="$PARAM[color]"/> 
<param name="id" value="$PARAM[scrollbarid]"/> 
</include>
...
</include>
</syntaxhighlight>

Here, ''$PARAM[color]'' and ''$PARAM[scrollbarid]'' will be forwarded to ''MyOtherControl'' '''only''' if parameters ''color'' and ''scrollbarid'' have actually been passed to ''MyControl'', otherwise the default values for ''color'' and ''id'' (if set in ''MyOtherControl'') will be used instead in the body of ''MyOtherControl''. Composite values containing other characters (such as ''label2'') are not considered as "true" forwarding and always override any default value set in the nested include, even when they expand to empty strings.
 

== Nested ==

The <code>nested</code> element can be used as a placeholder for elements (controls) defined between the start-tag and end-tag of an include element. The nested part can contain anything what is valid in our skin language. Using parameters for the nested XML fragment is also supported.

This is really handy if you want to re-use elements (controls) before and after some variable elements (controls) e.g. a box with a header footer but variable content.

=== Definition of an include using nested ===
<syntaxhighlight lang="XML" enclose="div">
<include name="MyBox">
<control type="">
...
</control>
<control type="group">
...
<nested /> 
...
</control>
</include>
</syntaxhighlight>

=== Use the include with nested elements ===
<syntaxhighlight lang="XML" enclose="div">
<include content="MyBox">
<param name="x" value="v1" />
<param name="y" value="v2" />


<control type="label">
...
</control>
<control type="group">
<control type="label">
...
</control>
</control>
</include>
</syntaxhighlight>

== Variables ==
Variables make it easier to use conditional infolabels. You can define them in Includes.xml, or to keep them separate, you can place them in another file which is included in Includes.xml.
You can include a file in Includes.xml by adding a line like this:
<syntaxhighlight lang="XML" enclose="div">
<include file="Variables.xml" />
</syntaxhighlight>
Variables can be used in any tag that supports infolabels, like the texture, label and visible tags. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<syntaxhighlight lang="XML" enclose="div">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</syntaxhighlight>
You can use a variable in a label control like this:
<syntaxhighlight lang="XML" enclose="div">
<label>$VAR[Example]</label>
</syntaxhighlight>
or when the viariable value is likely to contain commas (,) and/or quotes ("):
<syntaxhighlight lang="XML" enclose="div">
<label>$ESCVAR[Example]</label>
</syntaxhighlight>
(see $ESCINFO[] for more info on the need to escape strings: http://kodi.wiki/view/Label_Parsing)
 

== Constants ==
In case you want to re-use a certain value multiple times in your skin, you can define a constant for it:
<syntaxhighlight lang="XML" enclose="div">
<constant name="FanartCrossfadeTime">300</constant>
<constant name="IconCrossfadeTime">300</constant>
</syntaxhighlight>

you can now reference this value by it's name elsewhere in your skin:
<syntaxhighlight lang="XML" enclose="div">
<control type="image">
<left>0</left>
<top>0</top>
<width>256</width>
<height>256</height>
<texture background="true">$INFO[ListItem.Icon]</texture>
<fadetime>IconCrossfadeTime</fadetime>
</control>
</syntaxhighlight>
 

== Defaults ==
for every control type, you can define a default template. for instance here's a template for a button control:
<syntaxhighlight lang="XML" enclose="div">
<default type="button">
<left>0</left>
<top>0</top>
<width>700</width>
<height>40</height>
<label>-</label>
<texturefocus border="20">list-focus.png</texturefocus>
<texturenofocus border="20">list-nofocus.png</texturenofocus>
font20
<textcolor>white</textcolor>
<focusedcolor>blue</focusedcolor>
<disabledcolor>darkgrey</disabledcolor>
<invalidcolor>red</invalidcolor>
<textoffsetx>10</textoffsetx>
<aligny>center</aligny>
<pulseonselect>true</pulseonselect>
</default>
</syntaxhighlight>

the benefit of defining defaults is that kodi will use the template everywhere in you skin where a button is used,
so you don't have to code all of the tags for each and every button. you only have to code the tags that you want to differ from the default template.
 

== Expressions ==
expressions are useful if you need to use a certain boolean expression several times throughout your skin.
they can be defined in your includes file like this:
<syntaxhighlight lang="XML" enclose="div">
<expression name="HasInfoDialog">Window.IsActive(musicinformation) | Window.IsActive(movieinformation) | Window.IsActive(addoninformation)</expression>
<expression name="PluginAdvancedLauncher">substring(Container.FolderPath,plugin://plugin.program.advanced.launcher/,left)</expression>
</syntaxhighlight>

to use an expression in your skin, you can reference them using $EXP[]
<syntaxhighlight lang="XML" enclose="div">
<animation condition="$EXP[HasInfoDialog]" effect="fade" start="100" end="0" time="200" tween="sine">Conditional</animation>
</syntaxhighlight>

<syntaxhighlight lang="XML" enclose="div">
<visible>$EXP[PluginAdvancedLauncher] + !Window.IsActive(Home)</visible>
</syntaxhighlight>

expressions can be used in the following tags/attributes:
* visible
* enable
* usealttexture
* selected
* condition

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{#lst:Label Control|main content}}
== Fade Label Control ==
{{#lst:Fade Label Control|main content}}
== Button Control ==
{{#lst:Button control|main content}}
== Image Control ==
{{#lst:Image Control|main content}}
== MultiImage Control ==
{{#lst:MultiImage Control|main content}}
== Radio button Control ==
{{#lst:Radio button control|main content}}
== Toggle button control ==
{{#lst:Toggle button control|main content}}
== Spin Control ==
{{#lst:Spin_Control|main content}}
== Settings Spin Control ==
{{#lst:Settings_Spin_Control|main content}}
== Slider Control ==
{{#lst:Slider Control|main content}}
== Progress Control ==
{{#lst:Progress Control|main content}}
== ScrollBar Control ==
{{#lst:Scroll Bar Control|main content}}
== Text Box ==
{{#lst:Text Box|main content}}
== RSS feed Control ==
{{#lst:RSS feed Control|main content}}
== Visualisation Control ==
{{#lst:Visualisation Control|main content}}
== Video Control ==
{{#lst:Video Control|main content}}
== Mover Control ==
{{#lst:Mover Control|main content}}
== Resize Control ==
{{#lst:Resize Control|main content}}
== Edit Control ==
{{#lst:Edit Control|main content}}
== EPGGrid Control ==
{{#lst:EPGGrid_control|main content}}
== Gamecontroller Control ==
{{#lst:Gamecontroller_Control|main content}}
== Group Control ==
{{#lst:Group Control|main content}}
== GroupList Control ==
{{#lst:Group List Control|main content}}
== List Container ==
{{#lst:List Container|main content}}
== Wraplist Container ==
{{#lst:Wrap List Container|main content}}
== FixedList Container ==
{{#lst:Fixed List Container|main content}}
== Panel Container ==
{{#lst:Panel Container|main content}}

= Filling containers=
== Filling containers with static content ==
{{#lst:Static List Content|main content}}

== Filling containers with dynamic content ==
{{#lst:Dynamic List Content|main content}}

= Conditional_Visibility =
Kodi's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{#lst:Conditional Visibility|main content}}

= Animations =
The Kodi skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
== Animating Your Skin ==
{{#lst:Animating Your Skin|main content}}

= Tweeners =
{{#lst:Tweeners|main content}}

= Fonts =
Kodi allows you to customize which fonts are displayed onscreen in the User Interface.
{{#lst:Fonts|main content}}

= Appendix I: List of Windows =
{{#lst:Window IDs|main content}}

= Appendix II: List of Boolean Conditions =
{{#lst:List of Boolean Conditions|main content}}

= Appendix III: List of Info Labels =
{{#lst:InfoLabels|main content}}

= Appendix IV: List of Built In Functions =
{{#lst:List of Built In Functions|main content}}

= Appendix V: List of Built In Controls =
{{#lst:List of Built In Controls|main content}}

= Appendix VI: List of Default Icons =
{{#lst:Default Icons|main content}}

[[Category:Repositories]]
[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development|*]]
[[Category:Python]]

Skinning Manual

2018-01-13T12:26:15Z

Xhaggi: /* Use nested */

{{TOC right}}{{mininav|[[Development]]|[[Skin development]]}}

Kodi includes a GUI library that allows you to skin/change everything you see in Kodi, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning Kodi, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the Kodi skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning Kodi]] as well as the "[[Skinning XBMC|Skinning Kodi]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

= Anatomy of a Skin =
Kodi skins, once installed, are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from, or be installed via zip, Kodi will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/720p
: This is a resolution-specific directory. Kodi can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!)
; myskin/backgrounds
: optional folder containing the background images used in the skin
; myskin/colors
: contains a defaults.xml file which is used to define the colours used in the skin
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/language
: contains several subfolders for each language (English/strings.po). you can define strings used in your skin in this file.
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; myskin/resources
: place your icon.png (a 256x256 or 512x512 png image for your skin), fanart.jpg (a 1280x720 or 1920x1080 jpeg fanart image for your skin) and 10 jpeg screenshots (1280x720) of your skin in here. Name them screenshot01.jpg, screenshot02.jpg ect.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that Kodi uses to find the other files that Kodi requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/LICENSE.txt
: we recommend to include a Creative Commons license file in your skin: http://creativecommons.org/licenses/
[[Addon.xml#Skin specific elements|See here for the order in which it looks for skin files.]]

= Skin Themes =
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, Kodi allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, Kodi will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. Kodi will automatically pick them up.

= addon.xml =

{{main|addon.xml}}

= Windows =
== Window Structure ==
{{#lst:Window Structure|main content}}

= Includes =
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
You can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<include condition="Skin.HasSetting(extras) file="includes_extras.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</syntaxhighlight>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<syntaxhighlight lang="XML" enclose="div">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</syntaxhighlight>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<left>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 

== Use params in includes ==
As of Kodi 15.0 Isengard you get is the ability to pass arbitrary parameters to your includes and then use these values anywhere within the include body. Just so you don't have to copy/paste huge chunks of XML anymore in order to change just a value or two. Includes are now roughly equivalent to "procedures" in programming languages. Here's the final syntax that has been included in Kodi.

'''Include definitions''' are still written within ''<includes>'' tag, usually in ''includes.xml''. But they can now accept parameters:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<param name="id"/>
<param name="left" default="120"/>
<param name="top">225</param>
<definition>
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
<definition>
</include>
</syntaxhighlight>

Here, the first part is called ''parameter list'' and is specified using ''<param>'' tags. When it is present, include body that follows it should be enclosed within ''<definition>'' tag. At the moment, parameter list is optional and is mainly used for specifying default values for parameters (such as ''120'' and ''225'' above), but is otherwise not mandatory.

The above include can be called like this:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<param name="id" value="52"/>
<param name="left">300</param>
</include>
</syntaxhighlight>

This has the exact same effect as if you've written this instead:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<control type="image" id="52">
<left>300</left>
<top>225</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

and called it (old-style) like this:

<syntaxhighlight lang="XML" enclose="div">
<include>MyControl</include>
</syntaxhighlight>

only without added benefits.

Any appropriate value can be passed as parameter in the new '''include call''', including ''$INFO'' labels, ''$LOCALIZE'', ''$VAR''s, constants, etc. Empty string (''value=""'') can also be passed, for example to override a non-empty default value set in the include definition.

Default values are used as replacement when their parameters are not passed in the include call.

''$PARAM'' references can be specified within both '''tag values and attributes''' inside include body, and are expanded to either actual value passed (if it was passed), default value (if set) or empty string, in that order.

Parameters without default values (such as ''id'' above) are specified for better readability and documentation purposes only, but are otherwise not necessary and can be omitted. This is really a matter of style, and some skinners might prefer writing explicit parameter lists to specify all parameters referenced in the include body. It's a good practice though, as explicit parameter lists might be better utilized in the future versions of Kodi.

If there are no ''<param>'' tags at all, ''<definition>'' can be omitted too. This leads to even shorter syntax:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

Includes can call other (nested) includes and even pass them ''exact'' parameter values that they've got themselves. This is called '''parameter forwarding'''.

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
...
<include name="MyOtherControl">
<param name="label">$INFO[Player.Title]</param>
<param name="label2" value="x:$PARAM[left]; y:$PARAM[top]"/>
<param name="color" value="$PARAM[color]"/> 
<param name="id" value="$PARAM[scrollbarid]"/> 
</include>
...
</include>
</syntaxhighlight>

Here, ''$PARAM[color]'' and ''$PARAM[scrollbarid]'' will be forwarded to ''MyOtherControl'' '''only''' if parameters ''color'' and ''scrollbarid'' have actually been passed to ''MyControl'', otherwise the default values for ''color'' and ''id'' (if set in ''MyOtherControl'') will be used instead in the body of ''MyOtherControl''. Composite values containing other characters (such as ''label2'') are not considered as "true" forwarding and always override any default value set in the nested include, even when they expand to empty strings.
 

== Nested ==

The <code>nested</code> element can be used as a placeholder for elements (controls) defined between the start-tag and end-tag of an include element. The nested part can contain anything what is valid in our skin language. Using parameters for the nested XML fragment is also supported.

This is really handy if you want to re-use elements (controls) before and after some variable elements (controls) e.g. a menu with variable items.

=== Definition of an include using nested ===
<syntaxhighlight lang="XML" enclose="div">
<include name="MyMenu">
<control type="">
...
</control>
<control type="group">
<control type="image">
...
</control>
...
<nested /> 
...
</control>
<control type="group>
...
</control>
</include>
</syntaxhighlight>

=== Use the include with nested elements ===
<syntaxhighlight lang="XML" enclose="div">
<include content="MyMenu">
<param name="x" value="v1" />
<param name="y" value="v2" />


<control type="label">..</control>
<control type="group">
<control type="label">..</control>
</control>
</include>
</syntaxhighlight>

== Variables ==
Variables make it easier to use conditional infolabels. You can define them in Includes.xml, or to keep them separate, you can place them in another file which is included in Includes.xml.
You can include a file in Includes.xml by adding a line like this:
<syntaxhighlight lang="XML" enclose="div">
<include file="Variables.xml" />
</syntaxhighlight>
Variables can be used in any tag that supports infolabels, like the texture, label and visible tags. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<syntaxhighlight lang="XML" enclose="div">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</syntaxhighlight>
You can use a variable in a label control like this:
<syntaxhighlight lang="XML" enclose="div">
<label>$VAR[Example]</label>
</syntaxhighlight>
or when the viariable value is likely to contain commas (,) and/or quotes ("):
<syntaxhighlight lang="XML" enclose="div">
<label>$ESCVAR[Example]</label>
</syntaxhighlight>
(see $ESCINFO[] for more info on the need to escape strings: http://kodi.wiki/view/Label_Parsing)
 

== Constants ==
In case you want to re-use a certain value multiple times in your skin, you can define a constant for it:
<syntaxhighlight lang="XML" enclose="div">
<constant name="FanartCrossfadeTime">300</constant>
<constant name="IconCrossfadeTime">300</constant>
</syntaxhighlight>

you can now reference this value by it's name elsewhere in your skin:
<syntaxhighlight lang="XML" enclose="div">
<control type="image">
<left>0</left>
<top>0</top>
<width>256</width>
<height>256</height>
<texture background="true">$INFO[ListItem.Icon]</texture>
<fadetime>IconCrossfadeTime</fadetime>
</control>
</syntaxhighlight>
 

== Defaults ==
for every control type, you can define a default template. for instance here's a template for a button control:
<syntaxhighlight lang="XML" enclose="div">
<default type="button">
<left>0</left>
<top>0</top>
<width>700</width>
<height>40</height>
<label>-</label>
<texturefocus border="20">list-focus.png</texturefocus>
<texturenofocus border="20">list-nofocus.png</texturenofocus>
font20
<textcolor>white</textcolor>
<focusedcolor>blue</focusedcolor>
<disabledcolor>darkgrey</disabledcolor>
<invalidcolor>red</invalidcolor>
<textoffsetx>10</textoffsetx>
<aligny>center</aligny>
<pulseonselect>true</pulseonselect>
</default>
</syntaxhighlight>

the benefit of defining defaults is that kodi will use the template everywhere in you skin where a button is used,
so you don't have to code all of the tags for each and every button. you only have to code the tags that you want to differ from the default template.
 

== Expressions ==
expressions are useful if you need to use a certain boolean expression several times throughout your skin.
they can be defined in your includes file like this:
<syntaxhighlight lang="XML" enclose="div">
<expression name="HasInfoDialog">Window.IsActive(musicinformation) | Window.IsActive(movieinformation) | Window.IsActive(addoninformation)</expression>
<expression name="PluginAdvancedLauncher">substring(Container.FolderPath,plugin://plugin.program.advanced.launcher/,left)</expression>
</syntaxhighlight>

to use an expression in your skin, you can reference them using $EXP[]
<syntaxhighlight lang="XML" enclose="div">
<animation condition="$EXP[HasInfoDialog]" effect="fade" start="100" end="0" time="200" tween="sine">Conditional</animation>
</syntaxhighlight>

<syntaxhighlight lang="XML" enclose="div">
<visible>$EXP[PluginAdvancedLauncher] + !Window.IsActive(Home)</visible>
</syntaxhighlight>

expressions can be used in the following tags/attributes:
* visible
* enable
* usealttexture
* selected
* condition

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{#lst:Label Control|main content}}
== Fade Label Control ==
{{#lst:Fade Label Control|main content}}
== Button Control ==
{{#lst:Button control|main content}}
== Image Control ==
{{#lst:Image Control|main content}}
== MultiImage Control ==
{{#lst:MultiImage Control|main content}}
== Radio button Control ==
{{#lst:Radio button control|main content}}
== Toggle button control ==
{{#lst:Toggle button control|main content}}
== Spin Control ==
{{#lst:Spin_Control|main content}}
== Settings Spin Control ==
{{#lst:Settings_Spin_Control|main content}}
== Slider Control ==
{{#lst:Slider Control|main content}}
== Progress Control ==
{{#lst:Progress Control|main content}}
== ScrollBar Control ==
{{#lst:Scroll Bar Control|main content}}
== Text Box ==
{{#lst:Text Box|main content}}
== RSS feed Control ==
{{#lst:RSS feed Control|main content}}
== Visualisation Control ==
{{#lst:Visualisation Control|main content}}
== Video Control ==
{{#lst:Video Control|main content}}
== Mover Control ==
{{#lst:Mover Control|main content}}
== Resize Control ==
{{#lst:Resize Control|main content}}
== Edit Control ==
{{#lst:Edit Control|main content}}
== EPGGrid Control ==
{{#lst:EPGGrid_control|main content}}
== Gamecontroller Control ==
{{#lst:Gamecontroller_Control|main content}}
== Group Control ==
{{#lst:Group Control|main content}}
== GroupList Control ==
{{#lst:Group List Control|main content}}
== List Container ==
{{#lst:List Container|main content}}
== Wraplist Container ==
{{#lst:Wrap List Container|main content}}
== FixedList Container ==
{{#lst:Fixed List Container|main content}}
== Panel Container ==
{{#lst:Panel Container|main content}}

= Filling containers=
== Filling containers with static content ==
{{#lst:Static List Content|main content}}

== Filling containers with dynamic content ==
{{#lst:Dynamic List Content|main content}}

= Conditional_Visibility =
Kodi's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{#lst:Conditional Visibility|main content}}

= Animations =
The Kodi skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
== Animating Your Skin ==
{{#lst:Animating Your Skin|main content}}

= Tweeners =
{{#lst:Tweeners|main content}}

= Fonts =
Kodi allows you to customize which fonts are displayed onscreen in the User Interface.
{{#lst:Fonts|main content}}

= Appendix I: List of Windows =
{{#lst:Window IDs|main content}}

= Appendix II: List of Boolean Conditions =
{{#lst:List of Boolean Conditions|main content}}

= Appendix III: List of Info Labels =
{{#lst:InfoLabels|main content}}

= Appendix IV: List of Built In Functions =
{{#lst:List of Built In Functions|main content}}

= Appendix V: List of Built In Controls =
{{#lst:List of Built In Controls|main content}}

= Appendix VI: List of Default Icons =
{{#lst:Default Icons|main content}}

[[Category:Repositories]]
[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development|*]]
[[Category:Python]]

Skinning Manual

2018-01-13T12:25:04Z

Xhaggi: /* Use params in includes */

{{TOC right}}{{mininav|[[Development]]|[[Skin development]]}}

Kodi includes a GUI library that allows you to skin/change everything you see in Kodi, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning Kodi, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the Kodi skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning Kodi]] as well as the "[[Skinning XBMC|Skinning Kodi]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

= Anatomy of a Skin =
Kodi skins, once installed, are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from, or be installed via zip, Kodi will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/720p
: This is a resolution-specific directory. Kodi can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!)
; myskin/backgrounds
: optional folder containing the background images used in the skin
; myskin/colors
: contains a defaults.xml file which is used to define the colours used in the skin
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/language
: contains several subfolders for each language (English/strings.po). you can define strings used in your skin in this file.
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; myskin/resources
: place your icon.png (a 256x256 or 512x512 png image for your skin), fanart.jpg (a 1280x720 or 1920x1080 jpeg fanart image for your skin) and 10 jpeg screenshots (1280x720) of your skin in here. Name them screenshot01.jpg, screenshot02.jpg ect.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that Kodi uses to find the other files that Kodi requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/LICENSE.txt
: we recommend to include a Creative Commons license file in your skin: http://creativecommons.org/licenses/
[[Addon.xml#Skin specific elements|See here for the order in which it looks for skin files.]]

= Skin Themes =
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, Kodi allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, Kodi will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. Kodi will automatically pick them up.

= addon.xml =

{{main|addon.xml}}

= Windows =
== Window Structure ==
{{#lst:Window Structure|main content}}

= Includes =
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
You can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<include condition="Skin.HasSetting(extras) file="includes_extras.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</syntaxhighlight>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<syntaxhighlight lang="XML" enclose="div">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</syntaxhighlight>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<left>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 

== Use params in includes ==
As of Kodi 15.0 Isengard you get is the ability to pass arbitrary parameters to your includes and then use these values anywhere within the include body. Just so you don't have to copy/paste huge chunks of XML anymore in order to change just a value or two. Includes are now roughly equivalent to "procedures" in programming languages. Here's the final syntax that has been included in Kodi.

'''Include definitions''' are still written within ''<includes>'' tag, usually in ''includes.xml''. But they can now accept parameters:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<param name="id"/>
<param name="left" default="120"/>
<param name="top">225</param>
<definition>
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
<definition>
</include>
</syntaxhighlight>

Here, the first part is called ''parameter list'' and is specified using ''<param>'' tags. When it is present, include body that follows it should be enclosed within ''<definition>'' tag. At the moment, parameter list is optional and is mainly used for specifying default values for parameters (such as ''120'' and ''225'' above), but is otherwise not mandatory.

The above include can be called like this:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<param name="id" value="52"/>
<param name="left">300</param>
</include>
</syntaxhighlight>

This has the exact same effect as if you've written this instead:

<syntaxhighlight lang="XML" enclose="div">
<include content="MyControl">
<control type="image" id="52">
<left>300</left>
<top>225</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

and called it (old-style) like this:

<syntaxhighlight lang="XML" enclose="div">
<include>MyControl</include>
</syntaxhighlight>

only without added benefits.

Any appropriate value can be passed as parameter in the new '''include call''', including ''$INFO'' labels, ''$LOCALIZE'', ''$VAR''s, constants, etc. Empty string (''value=""'') can also be passed, for example to override a non-empty default value set in the include definition.

Default values are used as replacement when their parameters are not passed in the include call.

''$PARAM'' references can be specified within both '''tag values and attributes''' inside include body, and are expanded to either actual value passed (if it was passed), default value (if set) or empty string, in that order.

Parameters without default values (such as ''id'' above) are specified for better readability and documentation purposes only, but are otherwise not necessary and can be omitted. This is really a matter of style, and some skinners might prefer writing explicit parameter lists to specify all parameters referenced in the include body. It's a good practice though, as explicit parameter lists might be better utilized in the future versions of Kodi.

If there are no ''<param>'' tags at all, ''<definition>'' can be omitted too. This leads to even shorter syntax:

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
<control type="image" id="$PARAM[id]">
<left>$PARAM[left]</left>
<top>$PARAM[top]</top>
<width>370</width>
<height>40</height>
<texture>foo.png</texture>
</control>
</include>
</syntaxhighlight>

Includes can call other (nested) includes and even pass them ''exact'' parameter values that they've got themselves. This is called '''parameter forwarding'''.

<syntaxhighlight lang="XML" enclose="div">
<include name="MyControl">
...
<include name="MyOtherControl">
<param name="label">$INFO[Player.Title]</param>
<param name="label2" value="x:$PARAM[left]; y:$PARAM[top]"/>
<param name="color" value="$PARAM[color]"/> 
<param name="id" value="$PARAM[scrollbarid]"/> 
</include>
...
</include>
</syntaxhighlight>

Here, ''$PARAM[color]'' and ''$PARAM[scrollbarid]'' will be forwarded to ''MyOtherControl'' '''only''' if parameters ''color'' and ''scrollbarid'' have actually been passed to ''MyControl'', otherwise the default values for ''color'' and ''id'' (if set in ''MyOtherControl'') will be used instead in the body of ''MyOtherControl''. Composite values containing other characters (such as ''label2'') are not considered as "true" forwarding and always override any default value set in the nested include, even when they expand to empty strings.
 

== Use nested ==

The <code>nested</code> element can be used as a placeholder for elements (controls) defined between the start-tag and end-tag of an include element. The nested part can contain anything what is valid in our skin language. Using parameters for the nested XML fragment is also supported.

This is really handy if you want to re-use elements (controls) before and after some variable elements (controls) e.g. a menu with variable items.

=== Definition of an include using nested ===
<syntaxhighlight lang="XML" enclose="div">
<include name="MyMenu">
<control type="">
...
</control>
<control type="group">
<control type="image">
...
</control>
...
<nested /> 
...
</control>
<control type="group>
...
</control>
</include>
</syntaxhighlight>

=== Use the include with nested elements ===
<syntaxhighlight lang="XML" enclose="div">
<include content="MyIncludeWithNested">
<param name="x" value="v1" />
<param name="y" value="v2" />


<control type="label">..</control>
<control type="group">
<control type="label">..</control>
</control>
</include>
</syntaxhighlight>

== Variables ==
Variables make it easier to use conditional infolabels. You can define them in Includes.xml, or to keep them separate, you can place them in another file which is included in Includes.xml.
You can include a file in Includes.xml by adding a line like this:
<syntaxhighlight lang="XML" enclose="div">
<include file="Variables.xml" />
</syntaxhighlight>
Variables can be used in any tag that supports infolabels, like the texture, label and visible tags. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<syntaxhighlight lang="XML" enclose="div">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</syntaxhighlight>
You can use a variable in a label control like this:
<syntaxhighlight lang="XML" enclose="div">
<label>$VAR[Example]</label>
</syntaxhighlight>
or when the viariable value is likely to contain commas (,) and/or quotes ("):
<syntaxhighlight lang="XML" enclose="div">
<label>$ESCVAR[Example]</label>
</syntaxhighlight>
(see $ESCINFO[] for more info on the need to escape strings: http://kodi.wiki/view/Label_Parsing)
 

== Constants ==
In case you want to re-use a certain value multiple times in your skin, you can define a constant for it:
<syntaxhighlight lang="XML" enclose="div">
<constant name="FanartCrossfadeTime">300</constant>
<constant name="IconCrossfadeTime">300</constant>
</syntaxhighlight>

you can now reference this value by it's name elsewhere in your skin:
<syntaxhighlight lang="XML" enclose="div">
<control type="image">
<left>0</left>
<top>0</top>
<width>256</width>
<height>256</height>
<texture background="true">$INFO[ListItem.Icon]</texture>
<fadetime>IconCrossfadeTime</fadetime>
</control>
</syntaxhighlight>
 

== Defaults ==
for every control type, you can define a default template. for instance here's a template for a button control:
<syntaxhighlight lang="XML" enclose="div">
<default type="button">
<left>0</left>
<top>0</top>
<width>700</width>
<height>40</height>
<label>-</label>
<texturefocus border="20">list-focus.png</texturefocus>
<texturenofocus border="20">list-nofocus.png</texturenofocus>
font20
<textcolor>white</textcolor>
<focusedcolor>blue</focusedcolor>
<disabledcolor>darkgrey</disabledcolor>
<invalidcolor>red</invalidcolor>
<textoffsetx>10</textoffsetx>
<aligny>center</aligny>
<pulseonselect>true</pulseonselect>
</default>
</syntaxhighlight>

the benefit of defining defaults is that kodi will use the template everywhere in you skin where a button is used,
so you don't have to code all of the tags for each and every button. you only have to code the tags that you want to differ from the default template.
 

== Expressions ==
expressions are useful if you need to use a certain boolean expression several times throughout your skin.
they can be defined in your includes file like this:
<syntaxhighlight lang="XML" enclose="div">
<expression name="HasInfoDialog">Window.IsActive(musicinformation) | Window.IsActive(movieinformation) | Window.IsActive(addoninformation)</expression>
<expression name="PluginAdvancedLauncher">substring(Container.FolderPath,plugin://plugin.program.advanced.launcher/,left)</expression>
</syntaxhighlight>

to use an expression in your skin, you can reference them using $EXP[]
<syntaxhighlight lang="XML" enclose="div">
<animation condition="$EXP[HasInfoDialog]" effect="fade" start="100" end="0" time="200" tween="sine">Conditional</animation>
</syntaxhighlight>

<syntaxhighlight lang="XML" enclose="div">
<visible>$EXP[PluginAdvancedLauncher] + !Window.IsActive(Home)</visible>
</syntaxhighlight>

expressions can be used in the following tags/attributes:
* visible
* enable
* usealttexture
* selected
* condition

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{#lst:Label Control|main content}}
== Fade Label Control ==
{{#lst:Fade Label Control|main content}}
== Button Control ==
{{#lst:Button control|main content}}
== Image Control ==
{{#lst:Image Control|main content}}
== MultiImage Control ==
{{#lst:MultiImage Control|main content}}
== Radio button Control ==
{{#lst:Radio button control|main content}}
== Toggle button control ==
{{#lst:Toggle button control|main content}}
== Spin Control ==
{{#lst:Spin_Control|main content}}
== Settings Spin Control ==
{{#lst:Settings_Spin_Control|main content}}
== Slider Control ==
{{#lst:Slider Control|main content}}
== Progress Control ==
{{#lst:Progress Control|main content}}
== ScrollBar Control ==
{{#lst:Scroll Bar Control|main content}}
== Text Box ==
{{#lst:Text Box|main content}}
== RSS feed Control ==
{{#lst:RSS feed Control|main content}}
== Visualisation Control ==
{{#lst:Visualisation Control|main content}}
== Video Control ==
{{#lst:Video Control|main content}}
== Mover Control ==
{{#lst:Mover Control|main content}}
== Resize Control ==
{{#lst:Resize Control|main content}}
== Edit Control ==
{{#lst:Edit Control|main content}}
== EPGGrid Control ==
{{#lst:EPGGrid_control|main content}}
== Gamecontroller Control ==
{{#lst:Gamecontroller_Control|main content}}
== Group Control ==
{{#lst:Group Control|main content}}
== GroupList Control ==
{{#lst:Group List Control|main content}}
== List Container ==
{{#lst:List Container|main content}}
== Wraplist Container ==
{{#lst:Wrap List Container|main content}}
== FixedList Container ==
{{#lst:Fixed List Container|main content}}
== Panel Container ==
{{#lst:Panel Container|main content}}

= Filling containers=
== Filling containers with static content ==
{{#lst:Static List Content|main content}}

== Filling containers with dynamic content ==
{{#lst:Dynamic List Content|main content}}

= Conditional_Visibility =
Kodi's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{#lst:Conditional Visibility|main content}}

= Animations =
The Kodi skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
== Animating Your Skin ==
{{#lst:Animating Your Skin|main content}}

= Tweeners =
{{#lst:Tweeners|main content}}

= Fonts =
Kodi allows you to customize which fonts are displayed onscreen in the User Interface.
{{#lst:Fonts|main content}}

= Appendix I: List of Windows =
{{#lst:Window IDs|main content}}

= Appendix II: List of Boolean Conditions =
{{#lst:List of Boolean Conditions|main content}}

= Appendix III: List of Info Labels =
{{#lst:InfoLabels|main content}}

= Appendix IV: List of Built In Functions =
{{#lst:List of Built In Functions|main content}}

= Appendix V: List of Built In Controls =
{{#lst:List of Built In Controls|main content}}

= Appendix VI: List of Default Icons =
{{#lst:Default Icons|main content}}

[[Category:Repositories]]
[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development|*]]
[[Category:Python]]

Opening Windows and Dialogs

2016-10-01T19:58:22Z

Xhaggi: /* AddonBrowser */

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section/window of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows allow you to jump directly to a sub-section of that window. To do this, you can use either the sub-section's name or its path.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>
or
<pre>ActivateWindow(Videos,videodb://movies/titles/)</pre>

Below is a list of the available sub-sections in the Videos, Music, and Programs sections/windows.

== Videos ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||library://video/
|-
|   || 
|-
|Movies ||videodb://movies/
|-
|MovieGenres ||videodb://movies/genres/
|-
|MovieTitles ||videodb://movies/titles/
|-
|MovieYears ||videodb://movies/years/
|-
|MovieActors ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://movies/directors/
|-
|MovieStudios ||videodb://movies/studios/
|-
|MovieSets ||videodb://movies/sets/
|-
|MovieCountries ||videodb://movies/countries/
|-
|MovieTags ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://recentlyaddedmovies/
|-
|   || 
|-
|TvShows ||videodb://tvshows/
|-
|TvShowGenres ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://recentlyaddedepisodes/
|-
|InProgressTvShows ||videodb://inprogresstvshows
|-
|   || 
|-
|MusicVideos ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://recentlyaddedmusicvideos/
|-
|   || 
|-
|Playlists ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/
|-
|Files ||sources://video/
|-
|}

== Music ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||musicdb://
|-
|   || 
|-
|Genres ||musicdb://genres/
|-
|Artists ||musicdb://artists/
|-
|Albums ||musicdb://albums/
|-
|Song ||musicdb://songs/
|-
|Top100 ||musicdb://top100/
|-
|Top100Songs ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://compilations/
|-
|Years ||musicdb://years/
|-
|Singles ||musicdb://singles/
|-
|   || 
|-
|Files ||sources://music/
|-
|Playlists ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/
|}

== Programs ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Addons ||addons://sources/executable/
|-
|AndroidApps ||androidapp://sources/apps/
|}

== AddonBrowser ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|My add-ons ||addons://user/<type>/ (see for available types https://github.com/xbmc/xbmc/blob/master/xbmc/addons/Addon.cpp#L73)
|-
|Update available ||addons://outdated/
|-
|Currently downloading add-ons ||addons://downloading/
|-
|Recently updated ||addons://recently_updated/
|-
|Install from repository ||addons://repos/
|-
|Install from zip ||addons://install/
|-
|Search ||addons://search/
|}

== Notes ==
<references />

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

Opening Windows and Dialogs

2016-10-01T19:46:05Z

Xhaggi: /* AddonBrowser */

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section/window of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows allow you to jump directly to a sub-section of that window. To do this, you can use either the sub-section's name or its path.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>
or
<pre>ActivateWindow(Videos,videodb://movies/titles/)</pre>

Below is a list of the available sub-sections in the Videos, Music, and Programs sections/windows.

== Videos ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||library://video/
|-
|   || 
|-
|Movies ||videodb://movies/
|-
|MovieGenres ||videodb://movies/genres/
|-
|MovieTitles ||videodb://movies/titles/
|-
|MovieYears ||videodb://movies/years/
|-
|MovieActors ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://movies/directors/
|-
|MovieStudios ||videodb://movies/studios/
|-
|MovieSets ||videodb://movies/sets/
|-
|MovieCountries ||videodb://movies/countries/
|-
|MovieTags ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://recentlyaddedmovies/
|-
|   || 
|-
|TvShows ||videodb://tvshows/
|-
|TvShowGenres ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://recentlyaddedepisodes/
|-
|InProgressTvShows ||videodb://inprogresstvshows
|-
|   || 
|-
|MusicVideos ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://recentlyaddedmusicvideos/
|-
|   || 
|-
|Playlists ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/
|-
|Files ||sources://video/
|-
|}

== Music ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||musicdb://
|-
|   || 
|-
|Genres ||musicdb://genres/
|-
|Artists ||musicdb://artists/
|-
|Albums ||musicdb://albums/
|-
|Song ||musicdb://songs/
|-
|Top100 ||musicdb://top100/
|-
|Top100Songs ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://compilations/
|-
|Years ||musicdb://years/
|-
|Singles ||musicdb://singles/
|-
|   || 
|-
|Files ||sources://music/
|-
|Playlists ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/
|}

== Programs ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Addons ||addons://sources/executable/
|-
|AndroidApps ||androidapp://sources/apps/
|}

== AddonBrowser ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|My add-ons ||addons://user/<type>/ (see for available types https://github.com/xbmc/xbmc/blob/master/xbmc/addons/Addon.cpp#L73)
|-
|Official Kodi repo ||addons://repository.xmbc.org/<type>/ (see for available types https://github.com/xbmc/xbmc/blob/master/xbmc/addons/Addon.cpp#L73)
|-
|Update available ||addons://outdated/
|-
|Currently downloading add-ons ||addons://downloading/
|-
|Recently updated ||addons://recently_updated/
|-
|Install from repository ||addons://repos/
|-
|Install from zip ||addons://install/
|-
|Search ||addons://search/
|}

== Notes ==
<references />

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

List of boolean conditions

2016-10-01T19:38:02Z

Xhaggi: /* System */

{{see also|Conditional Visibility}}
<section begin="main content" />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.

=== ADSP ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>ADSP.IsActive</code>
| Returns true if dsp system is enabled
|
|-
| <code>ADSP.HasModes</code>
| Returns true if one or more modes are present on any of the types
|
|-
| <code>ADSP.HasInputResample</code>
| Returns true if on stream is a input resample is active
|
|-
| <code>ADSP.HasPreProcess</code>
| Returns true if on stream is a pre process mode active
|
|-
| <code>ADSP.HasMasterProcess</code>
| Returns true if on stream is a master process mode available
|
|-
| <code>ADSP.HasPostProcess</code>
| Returns true if on stream is a post process
|
|-
| <code>ADSP.HasOutputResample</code>
| Returns true if on stream is a output resample
|
|-
| <code>ADSP.MasterActive</code>
| Returns true if on stream is a master mode selected and active
|
|}

=== Container ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>Container.HasThumb</code>
| Returns true if the current container you are in has a thumb assigned to it
|
|-
| <code>Container.Content(parameter)</code>
| 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
|
|-
| <code>Container(id).OnNext</code>
| 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.)
|
|-
| <code>Container(id).OnScrollNext</code>
| 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.
|
|-
| <code>Container(id).OnPrevious</code>
| 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.)
|
|-
| <code>Container(id).OnScrollPrevious</code>
| 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.
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| 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.
|
|-
| <code>Container(id).HasFiles</code>
| Returns true if the container contains files (or current container if id is omitted).
|
|-
| <code>Container(id).HasFolders</code>
| Returns true if the container contains folders (or current container if id is omitted).
|
|-
| <code>Container(id).HasNext</code>
| Returns true if the container or textbox with id (id) has a next page.
|
|-
| <code>Container(id).HasPrevious</code>
| Returns true if the container or textbox with id (id) has a previous page.
|
|-
| <code>Container(id).IsUpdating</code>
| Returns true if the container with [[Dynamic List Content|dynamic list content]] is currently updating.
|
|-
| <code>Container(id).IsStacked</code>
| Returns true if the container is currently in stacked mode (or current container if id is omitted).
|
|-
| <code>Container.CanFilter</code>
| Returns true when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| Returns true when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Filtered</code>
| Returns true when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasParent</code>
| Return true when the container contains a parent ('..') item.
|
|-
| <code>Container.SortDirection(ascending)</code>
| Returns true the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| Returns true the sort direction of a container is descending.
|
|-
| <code>Container(id).Row(row)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.
|
|-
| <code>Container(id).Column(col)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.
|
|-
| <code>Container(id).Position(pos)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.
|
|-
| <code>Container(id).Scrolling</code>
| 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.
|
|}

=== Control ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>Control.IsEnabled(id)</code>
| Returns true if the control with id "id" is enabled.
|
|-
| <code>Control.IsVisible(id)</code>
| Returns true if the control with id "id" is visible.
|
|-
| <code>Control.HasFocus(id)</code>
| Returns true if the currently focused control has id "id".
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| 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”.
|
|}

=== Integer ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number. Example: Integer.IsEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number. Example: Integer.IsGreater(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number. Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number. Example: Integer.IsLess(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number. Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|}

=== Library ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|-
| <code>Library.HasContent(Role, Composer)</code>
| Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library
| v17 addition
|}

=== ListItem ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(Addon.IsEnabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.IsInstalled)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.HasUpdate)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| ListItem.HasTimerSchedule
| Whether the item is part of a repeating timer schedule (PVR).
| v16 addition
|-
| ListItem.TimerHasError
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17 addition
|-
| ListItem.TimerHasConflict
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17 addition
|-
| ListItem.TimerIsActive
| Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
| v17 addition
|-
| <code>ListItem.Property(Addon.Orphaned)</code>
| Returns true if the slected addon is orphaned (not needed anymore by any other addon)
| v17 addition
|-
| <code>ListItem.IsParentFolder</code>
| Returns true is the slected item is the 'up' item
| v17 addition
|}

=== Player ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.CanRecord</code>
| Returns true if the player can record the current internet stream.
|
|-
| <code>Player.Recording</code>
| Returns true if the player is recording the current internet stream.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current re-caching data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17 addition
|-
| <code>Player.TempoEnabled</code>
| Returns true if the current player supports changing the playback speed
| v17 addition
|-
| <code>Player.IsTempo</code>
| Returns true if the current playbackspeed is not equal to 1
| v17 addition
|}

==== MusicPlayer ====
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|}

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

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

=== PVR ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasEpg</code>
| Returns true when an epg is available.
|
|-
| <code>Pvr.HasTxt</code>
| Returns true when teletext is available.
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| Pvr.RadioNextRecordingChannelIcon
| Icon of the next recording radio channel
| {{nowrap|v17 Addition}}
|-
| Pvr.IsRecordingTV
| Returns true when the system is recording a tv programme.
| {{nowrap|v17 Addition}}
|-
| Pvr.HasTVTimer
| Returns true if at least one tv timer is active.
| {{nowrap|v17 Addition}}
|-
| Pvr.HasNonRecordingTVTimer
| Returns true if there are tv timers present who currently not do recording
| {{nowrap|v17 Addition}}
|-
| Pvr.IsRecordingRadio
| Returns true when the system is recording a radio programme.
| {{nowrap|v17 Addition}}
|-
| Pvr.HasRadioTimer
| Returns true if at least one radio timer is active.
| {{nowrap|v17 Addition}}
|-
| Pvr.HasNonRecordingRadioTimer
| Returns true if there are radio timers present who currently not do recording
| {{nowrap|v17 Addition}}
|}

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

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

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

=== String ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring. 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.
| {{nowrap|v17 Addition}}
|}

=== System ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasPVRAddon</code>
| Returns true if at least one PVR addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the DVD-ROM drive.
|
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.KaiConnected</code>
| Returns true if XBMC's Kai client is connected to the PC engine.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|
|-
| <code>System.HasADSP</code>
| Returns true if ADSP is enabled
|
|-
| <code>System.HasModalDialog</code>
| Returns true true if a modal dialog is visible
|
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.Linux.RaspberryPi</code>
| Returns true if Kodi is running on a Raspberry Pi.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.ATV2</code>
| Returns true if Kodi is running on an atv2.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>System.HasCMS</code>
| Returns true if colour management is supported in Kodi.
| {{nowrap|v17 Addition}}
|}

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

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

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

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

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

Opening Windows and Dialogs

2016-09-16T15:05:51Z

Xhaggi:

Opening Windows and Dialogs

2016-09-16T15:03:57Z

Xhaggi:

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section/window of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows allow you to jump directly to a sub-section of that window. To do this, you can use either the sub-section's name or its path.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>
or
<pre>ActivateWindow(Videos,videodb://movies/titles/)</pre>

Below is a list of the available sub-sections in the Videos, Music, and Programs sections/windows.

== Videos ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||library://video/
|-
|   || 
|-
|Movies ||videodb://movies/
|-
|MovieGenres ||videodb://movies/genres/
|-
|MovieTitles ||videodb://movies/titles/
|-
|MovieYears ||videodb://movies/years/
|-
|MovieActors ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://movies/directors/
|-
|MovieStudios ||videodb://movies/studios/
|-
|MovieSets ||videodb://movies/sets/
|-
|MovieCountries ||videodb://movies/countries/
|-
|MovieTags ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://recentlyaddedmovies/
|-
|   || 
|-
|TvShows ||videodb://tvshows/
|-
|TvShowGenres ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://recentlyaddedepisodes/
|-
|InProgressTvShows ||videodb://inprogresstvshows
|-
|   || 
|-
|MusicVideos ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://recentlyaddedmusicvideos/
|-
|   || 
|-
|Playlists ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/
|-
|Files ||sources://video/
|-
|}

== Music ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Root ||musicdb://
|-
|   || 
|-
|Genres ||musicdb://genres/
|-
|Artists ||musicdb://artists/
|-
|Albums ||musicdb://albums/
|-
|Song ||musicdb://songs/
|-
|Top100 ||musicdb://top100/
|-
|Top100Songs ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://compilations/
|-
|Years ||musicdb://years/
|-
|Singles ||musicdb://singles/
|-
|   || 
|-
|Files ||sources://music/
|-
|Playlists ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/
|}

== Programs ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|Addons ||addons://sources/executable/
|-
|AndroidApps ||androidapp://sources/apps/
|}

== PVR ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|TVChannels ||N/A
|-
|TVGuide ||N/A
|-
|TVRecordings ||N/A
|}

== AddonBrowser ==
{| class="prettytable"
! Sub-section Name !! Path
|-
|My add-ons ||addons://user/<type>/ (see for available types https://github.com/xbmc/xbmc/blob/master/xbmc/addons/Addon.cpp#L73)
|-
|Update available ||addons://outdated/
|-
|Currently downloading add-ons ||addons://downloading/
|-
|Recently updated ||addons://recently_updated/
|-
|Install from repository ||addons://repos/
|-
|Install from zip ||addons://install/
|-
|Search ||addons://search/
|}

== Notes ==
<references />

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

List of boolean conditions

2016-03-14T20:21:52Z

Xhaggi:

{{see also|Conditional Visibility}}
<section begin="main content" />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.

{| class="prettytable"
! Condition !! Description !! Version
|-
| <code>ADSP.IsActive</code>
|
|
|-
| <code>ADSP.HasInputResample</code>
|
|
|-
| <code>ADSP.HasPreProcess</code>
|
|
|-
| <code>ADSP.HasMasterProcess</code>
|
|
|-
| <code>ADSP.HasPostProcess</code>
|
|
|-
| <code>ADSP.HasOutputResample</code>
|
|
|-
| <code>ADSP.MasterActive</code>
|
|
|-
| <code>Container.HasThumb</code>
| Returns true if the current container you are in has a thumb assigned to it
|
|-
| <code>Container.Content(parameter)</code>
| 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
|
|-
| <code>Container(id).OnNext</code>
| 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.)
|
|-
| <code>Container(id).OnScrollNext</code>
| 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.
|
|-
| <code>Container(id).OnPrevious</code>
| 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.)
|
|-
| <code>Container(id).OnScrollPrevious</code>
| 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.
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| 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.
|
|-
| <code>Container(id).HasFiles</code>
| Returns true if the container contains files (or current container if id is omitted).
|
|-
| <code>Container(id).HasFolders</code>
| Returns true if the container contains folders (or current container if id is omitted).
|
|-
| <code>Container(id).HasNext</code>
| Returns true if the container or textbox with id (id) has a next page.
|
|-
| <code>Container(id).HasPrevious</code>
| Returns true if the container or textbox with id (id) has a previous page.
|
|-
| <code>Container(id).IsUpdating</code>
| Returns true if the container with [[Dynamic List Content|dynamic list content]] is currently updating.
|
|-
| <code>Container(id).IsStacked</code>
| Returns true if the container is currently in stacked mode (or current container if id is omitted).
|
|-
| <code>Container.CanFilter</code>
| Returns true when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| Returns true when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Filtered</code>
| Returns true when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasParent</code>
| Return true when the container contains a parent ('..') item.
|
|-
| <code>Container.SortDirection(ascending)</code>
| Returns true the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| Returns true the sort direction of a container is descending.
|
|-
| <code>Container(id).Row(row)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.
|
|-
| <code>Container(id).Column(col)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.
|
|-
| <code>Container(id).Position(pos)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.
|
|-
| <code>Container(id).Scrolling</code>
| 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.
|
|-
| <code>Control.IsEnabled(id)</code>
| Returns true if the control with id "id" is enabled.
|
|-
| <code>Control.IsVisible(id)</code>
| Returns true if the control with id "id" is visible.
|
|-
| <code>Control.HasFocus(id)</code>
| Returns true if the currently focused control has id "id".
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| 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”.
|
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number. Example: Integer.IsEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number. Example: Integer.IsGreater(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number. Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number. Example: Integer.IsLess(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number. Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>IntegerGreaterThan([[InfoLabels|info]],number)</code> deprecated: use Integer.IsGreater() instead
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than the supplied number. Example: IntegerGreaterThan(ListItem.Year,2000)
| until v18
|-
| <code>IsEmpty([[InfoLabels|info]])</code> deprecated: use String.IsEmpty() instead
| Returns true if the value of the [[InfoLabels|infolabel]] is empty. Example: IsEmpty(ListItem.Plot)
| until v18
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(Addon.Enabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.Installed)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.UpdateAvail)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.CanRecord</code>
| Returns true if the player can record the current internet stream.
|
|-
| <code>Player.Recording</code>
| Returns true if the player is recording the current internet stream.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current re-caching data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.ShowCodec</code>
| Returns true if the user has requested the codec to show (occurs in visualisation and video fullscreen)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasEpg</code>
| Returns true when an epg is available.
|
|-
| <code>Pvr.HasTxt</code>
| Returns true when teletext is available.
|
|-
| <code>Pvr.HasDirector</code>
| ?
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>RDS.HasRds</code>
|
|
|-
| <code>RDS.HasRadioText</code>
|
|
|-
| <code>RDS.HasRadioTextPlus</code>
|
|
|-
| <code>RDS.HasHotline</code>
|
|
|-
| <code>RDS.HasStudio</code>
|
|
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the skin-specified setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is non-empty.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>StringCompare([[InfoLabels|info]],string)</code> deprecated: use String.IsEqual() instead
| 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.
| until v18
|-
| <code>SubString([[InfoLabels|info]],string)</code> deprecated: use String.Contains() instead
| Returns true if the string is found anywhere in the [[InfoLabels|info]]
| until v18
|-
| <code>SubString([[InfoLabels|info]],string,[Left or Right])</code> deprecated: use String.StartsWith() / String.EndsWith() instead
| Returns true if the string is found from the start or the end. Example: 
(foobars,foob,Left) -> true 
(foobars,foob,Right) -> False 
(foobars,bars,Right) -> true
| until v18
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the DVD-ROM drive.
|
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.KaiConnected</code>
| Returns true if XBMC's Kai client is connected to the PC engine.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|
|-
| <code>System.HasADSP</code>
| Returns true if ADSP is enabled
|
|-
| <code>System.HasModalDialog</code>
| Returns true true if a modal dialog is visible
|
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.Linux.RaspberryPi</code>
| Returns true if Kodi is running on a Raspberry Pi.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.ATV2</code>
| Returns true if Kodi is running on an atv2.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)
|
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns true if the window is a radio window (for use in the PVR windows)
|}
<section end="main content" />

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

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

List of boolean conditions

2016-03-14T20:16:34Z

Xhaggi:

{{see also|Conditional Visibility}}
<section begin="main content" />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.

{| class="prettytable"
! Condition !! Description !! Version
|-
| <code>ADSP.IsActive</code>
|
|
|-
| <code>ADSP.HasInputResample</code>
|
|
|-
| <code>ADSP.HasPreProcess</code>
|
|
|-
| <code>ADSP.HasMasterProcess</code>
|
|
|-
| <code>ADSP.HasPostProcess</code>
|
|
|-
| <code>ADSP.HasOutputResample</code>
|
|
|-
| <code>ADSP.MasterActive</code>
|
|
|-
| <code>Container.HasThumb</code>
| Returns true if the current container you are in has a thumb assigned to it
|
|-
| <code>Container.Content(parameter)</code>
| 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
|
|-
| <code>Container(id).OnNext</code>
| 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.)
|
|-
| <code>Container(id).OnScrollNext</code>
| 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.
|
|-
| <code>Container(id).OnPrevious</code>
| 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.)
|
|-
| <code>Container(id).OnScrollPrevious</code>
| 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.
|
|-
| <code>Container(id).HasFocus(item_number)</code>
| 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.
|
|-
| <code>Container(id).HasFiles</code>
| Returns true if the container contains files (or current container if id is omitted).
|
|-
| <code>Container(id).HasFolders</code>
| Returns true if the container contains folders (or current container if id is omitted).
|
|-
| <code>Container(id).HasNext</code>
| Returns true if the container or textbox with id (id) has a next page.
|
|-
| <code>Container(id).HasPrevious</code>
| Returns true if the container or textbox with id (id) has a previous page.
|
|-
| <code>Container(id).IsUpdating</code>
| Returns true if the container with [[Dynamic List Content|dynamic list content]] is currently updating.
|
|-
| <code>Container(id).IsStacked</code>
| Returns true if the container is currently in stacked mode (or current container if id is omitted).
|
|-
| <code>Container.CanFilter</code>
| Returns true when the current container can be filtered.
|
|-
| <code>Container.CanFilterAdvanced</code>
| Returns true when advanced filtering can be applied to the current container.
|
|-
| <code>Container.Filtered</code>
| Returns true when a mediafilter is applied to the current container.
|
|-
| <code>Container.HasParent</code>
| Return true when the container contains a parent ('..') item.
|
|-
| <code>Container.SortDirection(ascending)</code>
| Returns true the sort direction of a container is ascending.
|
|-
| <code>Container.SortDirection(descending)</code>
| Returns true the sort direction of a container is descending.
|
|-
| <code>Container(id).Row(row)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.
|
|-
| <code>Container(id).Column(col)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.
|
|-
| <code>Container(id).Position(pos)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.
|
|-
| <code>Container(id).Scrolling</code>
| 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.
|
|-
| <code>Control.IsEnabled(id)</code>
| Returns true if the control with id "id" is enabled.
|
|-
| <code>Control.IsVisible(id)</code>
| Returns true if the control with id "id" is visible.
|
|-
| <code>Control.HasFocus(id)</code>
| Returns true if the currently focused control has id "id".
|
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| 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”.
|
|-
| <code>Integer.IsEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is equal to the supplied number. Example: Integer.IsEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number. Example: Integer.IsGreater(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsGreaterOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater or equal to the supplied number. Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsLess([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less than the supplied number. Example: Integer.IsLess(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsLessOrEqual([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is less or equal to the supplied number. Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>IntegerGreaterThan([[InfoLabels|info]],number)</code> **deprecated**
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than the supplied number. Example: IntegerGreaterThan(ListItem.Year,2000)
| until v18
|-
| <code>IsEmpty([[InfoLabels|info]])</code> **deprecated**
| Returns true if the value of the [[InfoLabels|infolabel]] is empty. Example: IsEmpty(ListItem.Plot)
| until v18
|-
| <code>Library.HasContent(string)</code>
| Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)
|
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR)
|
|-
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR)
|
|-
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR)
|
|-
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video
|
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|
|-
| <code>ListItem.Property(DateLabel)</code>
| Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
|
|-
| <code>ListItem.Property(Addon.Enabled)</code>
| Returns true when the selected addon is enabled (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.Installed)</code>
| Returns true when the selected addon is installed (for use in the addon info dialog only).
|
|-
| <code>ListItem.Property(Addon.UpdateAvail)</code>
| Returns true when there's an update available for the selected addon.
|
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|
|-
| <code>Player.Passthrough</code>
| Returns true if the player is using audio passthrough.
|
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|
|-
| <code>Player.CanRecord</code>
| Returns true if the player can record the current internet stream.
|
|-
| <code>Player.Recording</code>
| Returns true if the player is recording the current internet stream.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current re-caching data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.ShowCodec</code>
| Returns true if the user has requested the codec to show (occurs in visualisation and video fullscreen)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|
|-
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active.
|
|-
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active.
|
|-
| <code>Pvr.HasEpg</code>
| Returns true when an epg is available.
|
|-
| <code>Pvr.HasTxt</code>
| Returns true when teletext is available.
|
|-
| <code>Pvr.HasDirector</code>
| ?
|
|-
| <code>Pvr.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>RDS.HasRds</code>
|
|
|-
| <code>RDS.HasRadioText</code>
|
|
|-
| <code>RDS.HasRadioTextPlus</code>
|
|
|-
| <code>RDS.HasHotline</code>
|
|
|-
| <code>RDS.HasStudio</code>
|
|
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the skin-specified setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is non-empty.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|
|-
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video
|
|-
| <code>String.IsEmpty([[InfoLabels|info]])</code>
| Returns true if the [[InfoLabels|info]] is empty. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.EndsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] ends with the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring. 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.
| {{nowrap|v17 Addition}}
|-
| <code>StringCompare([[InfoLabels|info]],string)</code> **deprecated**
| 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.
| until v18
|-
| <code>SubString([[InfoLabels|info]],string)</code> **deprecated**
| Returns true if the string is found anywhere in the [[InfoLabels|info]]
| until v18
|-
| <code>SubString([[InfoLabels|info]],string,[Left or Right])</code> **deprecated**
| Returns true if the string is found from the start or the end. Example: 
(foobars,foob,Left) -> true 
(foobars,foob,Right) -> False 
(foobars,bars,Right) -> true
| until v18
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| Returns true if the alarm with ?alarmname? has less or equal to ?seconds? left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
|
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the DVD-ROM drive.
|
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.KaiConnected</code>
| Returns true if XBMC's Kai client is connected to the PC engine.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|
|-
| <code>System.HasADSP</code>
| Returns true if ADSP is enabled
|
|-
| <code>System.HasModalDialog</code>
| Returns true true if a modal dialog is visible
|
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.Linux.RaspberryPi</code>
| Returns true if Kodi is running on a Raspberry Pi.
|
|-
| <code>System.Platform.Windows</code>
| Returns true if Kodi is running on a windows based computer.
|
|-
| <code>System.Platform.OSX</code>
| Returns true if Kodi is running on an OSX based computer.
|
|-
| <code>System.Platform.IOS</code>
| Returns true if Kodi is running on an IOS device.
|
|-
| <code>System.Platform.Darwin</code>
| Returns true if Kodi is running on an OSX or IOS system.
|
|-
| <code>System.Platform.ATV2</code>
| Returns true if Kodi is running on an atv2.
|
|-
| <code>System.Platform.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.CanPowerDown</code>
| Returns true if Kodi can powerdown the system.
|
|-
| <code>System.CanSuspend</code>
| Returns true if Kodi can suspend the system.
|
|-
| <code>System.CanHibernate</code>
| Returns true if Kodi can hibernate the system.
|
|-
| <code>System.HasHiddenInput</code>
| Return true when to osd keyboard/numeric dialog requests a password/pincode.
|
|-
| <code>System.CanReboot</code>
| Returns true if Kodi can reboot the system.
|
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|
|-
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled.
|
|-
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled.
|
|-
| <code>VideoPlayer.UsingOverlays</code>
| Returns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows etc. need redoing, or disabling.
|
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)
|
|-
| <code>VideoPlayer.Content(parameter)</code>
| Returns true if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted : files, movies, episodes, musicvideos, livetv
|
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video
|
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|
|-
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR).
|
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|
|-
| <code>Visualisation.HasPresets</code>
| Returns true if the visualisation has built in presets.
|
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)
|
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns true if the window is a radio window (for use in the PVR windows)
|}
<section end="main content" />

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

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

Action IDs

2015-08-13T08:29:25Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|- {{Isengard row}}
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>SubtitleShiftDown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>SubtitleAlign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|- {{gotham row}}
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Jarvis updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2015-08-12T14:40:12Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|- {{Isengard row}}
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>OSDLeft</code> || '''Unused''' (ACTION_OSD_SHOW_LEFT)
|-
| <code>OSDRight</code> || '''Unused''' (ACTION_OSD_SHOW_RIGHT)
|-
| <code>OSDUp</code> || '''Unused''' (ACTION_OSD_SHOW_UP)
|-
| <code>OSDDown</code> || '''Unused''' (ACTION_OSD_SHOW_DOWN)
|-
| <code>OSDSelect</code> || '''Unused''' (ACTION_OSD_SHOW_SELECT)
|-
| <code>OSDValuePlus</code> || '''Unused''' (ACTION_OSD_SHOW_VALUE_PLUS)
|-
| <code>OSDValueMinus</code> || '''Unused''' (ACTION_OSD_SHOW_VALUE_MIN)
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>SubtitleShiftDown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>SubtitleAlign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|- {{gotham row}}
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Jarvis updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2015-08-12T14:38:39Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|- {{Isengard row}}
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>OSDLeft</code> || '''Unused''' (ACTION_OSD_SHOW_LEFT)
|-
| <code>OSDRight</code> || '''Unused''' (ACTION_OSD_SHOW_RIGHT)
|-
| <code>OSDUp</code> || '''Unused''' (ACTION_OSD_SHOW_UP)
|-
| <code>OSDDown</code> || '''Unused''' (ACTION_OSD_SHOW_DOWN)
|-
| <code>OSDSelect</code> || '''Unused''' (ACTION_OSD_SHOW_SELECT)
|-
| <code>OSDValuePlus</code> || '''Unused''' (ACTION_OSD_SHOW_VALUE_PLUS)
|-
| <code>OSDValueMinus</code> || '''Unused''' (ACTION_OSD_SHOW_VALUE_MIN)
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>subtitleshiftup</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>subtitleshiftdown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>subtitlealign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|- {{gotham row}}
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Jarvis updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2015-08-12T14:33:19Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|- {{Isengard row}}
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>osdleft</code> || '''?''' (ACTION_OSD_SHOW_LEFT)
|-
| <code>osdright</code> || '''?''' (ACTION_OSD_SHOW_RIGHT)
|-
| <code>osdup</code> || '''?''' (ACTION_OSD_SHOW_UP)
|-
| <code>osddown</code> || '''?''' (ACTION_OSD_SHOW_DOWN)
|-
| <code>osdselect</code> || '''?''' (ACTION_OSD_SHOW_SELECT)
|-
| <code>osdvalueplus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_PLUS)
|-
| <code>osdvalueminus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_MIN)
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>subtitleshiftup</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>subtitleshiftdown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>subtitlealign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|- {{gotham row}}
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Jarvis updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2015-08-12T14:22:10Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|- {{Isengard row}}
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>osdleft</code> || '''?''' (ACTION_OSD_SHOW_LEFT)
|-
| <code>osdright</code> || '''?''' (ACTION_OSD_SHOW_RIGHT)
|-
| <code>osdup</code> || '''?''' (ACTION_OSD_SHOW_UP)
|-
| <code>osddown</code> || '''?''' (ACTION_OSD_SHOW_DOWN)
|-
| <code>osdselect</code> || '''?''' (ACTION_OSD_SHOW_SELECT)
|-
| <code>osdvalueplus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_PLUS)
|-
| <code>osdvalueminus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_MIN)
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>subtitleshiftup</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>subtitleshiftdown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>subtitlealign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>toggledebug</code> || toggle debugging mode for the [[log file]]
|-
| <code>ActivateWindow(MyVideos)</code> || Go to My Videos.
|-
| <code>ActivateWindow(MyMusic)</code> || Go to My Music.
|-
| <code>ActivateWindow(MyPictures)</code> || Go to My Pictures.
|-
| <code>ActivateWindow(Home)</code> || Go to Home window. Go back from within a context in the UI.
|-
| <code>ActivateWindow(type,path to playlist)</code> || Opens the window for the desired playlist.
|-
| <code>ActivateWindow('''''[[Window IDs|windowid]]''''')</code> || Go a window specified by ''''windowid''. See the [[Window IDs|list of window IDs]] for the list of valid values. Not all ids will work on all themes.
|- {{gotham row}}
| <code>createbookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>createepisodebookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || Goes to the next channel group when using [[PVR]]/live TV. Works only within the "PVROSDChannels" window. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || Goes to the previous channel group when using [[PVR]]/live TV. Works only within the "PVROSDChannels" window. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Jarvis updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Template:Jarvis row

2015-08-12T14:21:31Z

Xhaggi:

style="background:#7eaa53;"

Action IDs

2015-08-12T14:20:15Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|- {{Helix row}}
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>osdleft</code> || '''?''' (ACTION_OSD_SHOW_LEFT)
|-
| <code>osdright</code> || '''?''' (ACTION_OSD_SHOW_RIGHT)
|-
| <code>osdup</code> || '''?''' (ACTION_OSD_SHOW_UP)
|-
| <code>osddown</code> || '''?''' (ACTION_OSD_SHOW_DOWN)
|-
| <code>osdselect</code> || '''?''' (ACTION_OSD_SHOW_SELECT)
|-
| <code>osdvalueplus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_PLUS)
|-
| <code>osdvalueminus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_MIN)
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>subtitleshiftup</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>subtitleshiftdown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>subtitlealign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>toggledebug</code> || toggle debugging mode for the [[log file]]
|-
| <code>ActivateWindow(MyVideos)</code> || Go to My Videos.
|-
| <code>ActivateWindow(MyMusic)</code> || Go to My Music.
|-
| <code>ActivateWindow(MyPictures)</code> || Go to My Pictures.
|-
| <code>ActivateWindow(Home)</code> || Go to Home window. Go back from within a context in the UI.
|-
| <code>ActivateWindow(type,path to playlist)</code> || Opens the window for the desired playlist.
|-
| <code>ActivateWindow('''''[[Window IDs|windowid]]''''')</code> || Go a window specified by ''''windowid''. See the [[Window IDs|list of window IDs]] for the list of valid values. Not all ids will work on all themes.
|- {{gotham row}}
| <code>createbookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>createepisodebookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || Goes to the next channel group when using [[PVR]]/live TV. Works only within the "PVROSDChannels" window. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || Goes to the previous channel group when using [[PVR]]/live TV. Works only within the "PVROSDChannels" window. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Jarvis updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Action IDs

2015-08-12T14:19:09Z

Xhaggi:

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|- {{Gotham row}}
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>osdleft</code> || '''?''' (ACTION_OSD_SHOW_LEFT)
|-
| <code>osdright</code> || '''?''' (ACTION_OSD_SHOW_RIGHT)
|-
| <code>osdup</code> || '''?''' (ACTION_OSD_SHOW_UP)
|-
| <code>osddown</code> || '''?''' (ACTION_OSD_SHOW_DOWN)
|-
| <code>osdselect</code> || '''?''' (ACTION_OSD_SHOW_SELECT)
|-
| <code>osdvalueplus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_PLUS)
|-
| <code>osdvalueminus</code> || '''?''' (ACTION_OSD_SHOW_VALUE_MIN)
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>subtitleshiftup</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>subtitleshiftdown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>subtitlealign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''(0-9)''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|- {{jarvis row}}
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''(2-9)''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''(2-9)''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>toggledebug</code> || toggle debugging mode for the [[log file]]
|-
| <code>ActivateWindow(MyVideos)</code> || Go to My Videos.
|-
| <code>ActivateWindow(MyMusic)</code> || Go to My Music.
|-
| <code>ActivateWindow(MyPictures)</code> || Go to My Pictures.
|-
| <code>ActivateWindow(Home)</code> || Go to Home window. Go back from within a context in the UI.
|-
| <code>ActivateWindow(type,path to playlist)</code> || Opens the window for the desired playlist.
|-
| <code>ActivateWindow('''''[[Window IDs|windowid]]''''')</code> || Go a window specified by ''''windowid''. See the [[Window IDs|list of window IDs]] for the list of valid values. Not all ids will work on all themes.
|- {{gotham row}}
| <code>createbookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>createepisodebookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>NextChannelGroup</code> || Goes to the next channel group when using [[PVR]]/live TV. Works only within the "PVROSDChannels" window. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PreviousChannelGroup</code> || Goes to the previous channel group when using [[PVR]]/live TV. Works only within the "PVROSDChannels" window. '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvr</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrTV</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>PlayPvrRadio</code> || [[PVR]] something ? '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|- {{gotham row}}
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Helix updated}}

[[Category:Remotes]]
[[Category:Skin development]]

Template:Jarvis row

2015-08-12T14:16:50Z

Xhaggi: Created page with "style="background:#8cd5f0;""

style="background:#8cd5f0;"

List of built-in functions

2015-06-08T14:54:09Z

Xhaggi: /* List of functions */

{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}
<section begin="main content" />
Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.

The latest up-to-date list of built-in functions can be found in the function '''CBuiltins::Execute()''' in the source code file [https://github.com/xbmc/xbmc/blob/master/xbmc/interfaces/Builtins.cpp /xbmc/interfaces/Builtins.cpp].

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

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

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

== List of functions ==
<section begin="functions" />
{| class="prettytable sort sortable"
! Function
! Description
! Version
|-
| <code>Help</code>
| This help message (??? probably broken)
|
|-
| <code>Reboot</code>
| Cold reboots the system (power cycle)
|
|-
| <code>ShutDown</code>
| Trigger default Shutdown action defined in System Settings
|
|-
| <code>Powerdown</code>
| Powerdown system
|
|-
| <code>Quit</code>
| Quits Kodi
|
|-
| <code>Hibernate</code>
| Hibernate (S4) the System
|
|-
| <code>Suspend</code>
| Suspends (S3 / S1 depending on bios setting) the System
|
|- {{frodo row}}
| <code>InhibitIdleShutdown(true/false)</code>
| Prevent the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>AllowIdleShutdown</code>
| Allow the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>ActivateScreensaver</code>
| Starts the screensaver
| {{nowrap|v13 Addition}}
|-
| <code>RestartApp</code>
| Restarts Kodi (only implemented under Windows and Linux)
|
|-
| <code>Minimize</code>
| Minimizes Kodi
|
|-
| <code>Reset</code>
| Reset the system (same as reboot)
|
|-
| <code>Mastermode</code>
| Runs Kodi in master mode
|
|- {{gotham row}}
| <code>SetGUILanguage</code>
| Set GUI Language
| {{nowrap|v13 Addition}}
|-
| <code>ActivateWindow(window[,dir,return])</code>
| Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. [[Window IDs|See here for a list of window names, and their respective ids.]] If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder Kodi should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that Kodi should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating.
|
|- {{frodo row}}
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v12 Addition}}
|-
| <code>ReplaceWindow(window,dir)</code>
| Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.
|
|- {{gotham row}}
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v13 Addition}}
|-
| <code>TakeScreenshot</code>
| Takes a Screenshot
|
|-
| <code>RunScript(script[,args]*)</code>
| Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
|
|- {{frodo row}}
| <code>StopScript(id)</code>
| Stop the script by ID or path, if running
| {{nowrap|v12 Addition}}
|-
| <code>RunAppleScript(script[,args]*)</code>
| Run the specified AppleScript command
|
|-
| <code>RunPlugin(plugin)</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
|-
| <code>RunAddon(id)</code>
| Runs the specified plugin/script
|
|- {{gotham row}}
| <code>NotifyAll</code>
| Notify all connected clients
| {{nowrap|v13 Addition}}
|-
| <code>Extract</code>
| Extracts a specified archive to an optionally specified 'absolute' path.
|
|-
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
|
|- {{isengard row}}
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|- {{gotham row}}
| <code>ShowPicture(picture)</code>
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
| <code>SlideShow(dir [,recursive, [not]random])</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window.
|
|-
| <code>RecursiveSlideShow(dir)</code>
| Run a slideshow from the specified directory, including all subdirs
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|-
| <code>RefreshRSS</code>
| Reload RSS feeds from RSSFeeds.xml
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, 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.
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>EjectTray()</code>
| Either opens or closes the DVD tray, depending on its current state
|
|-
| <code>AlarmClock(name,command,time[,silent,loop])</code>
| Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires.
|
|-
| <code>CancelAlarm(name[,silent])</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|
|-
| <code>Action(action[,window])</code>
| Executes an action (same as in keymap) for the given window or the active window if the parameter window is omitted. The parameter window can either be the window's id, or in the case of a standard window, the window's name. [[Window IDs|See here for a list of window names, and their respective ids.]]
|
|-
| <code>Notification(header,message[,time,image])</code>
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.
|
|-
| <code>PlayDVD</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>RipCD</code>
| Will rip the inserted CD from the DVD-ROM drive.
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,value])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.
|
|-
| <code>Skin.Theme</code>
| Cycles the skin theme. Skin.theme(-1) will go backwards.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetLargeImage(string[,value])</code>
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "|" minus quotes. If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are ''xbmc.addon.video'', ''xbmc.addon.audio'', ''xbmc.addon.image'' and ''xbmc.addon.executable''.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Mute</code>
| Mutes (or unmutes) the volume.
|
|-
| <code>SetVolume(percent[,showvolumebar])</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume.
|
|-
| <code>Dialog.Close(dialog[,force])</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
| <code>System.LogOff</code>
| Log off current user.
|
|-
| <code>System.Exec</code>
| Execute shell commands.
|
|-
| <code>System.ExecWait</code>
| Execute shell commands and freezes Kodi until shell is closed.
|
|-
| <code>Resolution</code>
| Change Kodi's Resolution.
|
|-
| <code>SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>PageDown</code>
| Send a page down event to the pagecontrol with given id.
|
|-
| <code>PageUp</code>
| Send a page up event to the pagecontrol with given id.
|
|-
| <code>Container.Refresh</code>
| Refresh current listing.
|
|-
| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
| <code>Container.NextViewMode</code>
| Select the next view mode.
|
|-
| <code>Container.PreviousViewMode</code>
| Select the previous view mode.
|
|-
| <code>Container.SetViewMode(id)</code>
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
| <code>Container.NextSortMethod</code>
| Change to the next sort method.
|
|-
| <code>Container.PreviousSortMethod</code>
| Change to the previous sort method.
|
|-
| <code>Container.SetSortMethod(id)</code>
| Change to the specified sort method. (For list of ID's see '''List of sort methods''' below)
|
|-
| <code>Container.SortDirection</code>
| Toggle the sort direction.
|
|-
| <code>Control.Move(id,offset)</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
|
|-
| <code>Control.SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>Control.Message(id,message,[windowid])</code>
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
| <code>SendClick(windowid,id)</code>
| Sends a click to a control in a given window (or active window if omitted).
|
|-
| <code>LoadProfile(profilename,[prompt])</code>
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.
|
|-
| <code>SetProperty(key,value[,id])</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
|
|-
| <code>ClearProperty(key[,id])</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>WakeOnLan(''mac'')</code>
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).
|
|-
| <code>Addon.Default.OpenSettings</code>
| Open a settings dialog for the default addon of the given type
|
|-
| <code>Addon.Default.Set</code>
| Open a select dialog to allow choosing the default addon of the given type
|
|-
| <code>Addon.OpenSettings(id)</code>
| Open a settings dialog for the addon of the given id
|
|-
| <code>UpdateAddonRepos</code>
| Triggers a forced update of enabled add-on repositories.
|
|-
| <code>UpdateLocalAddons</code>
| Triggers a scan of local add-on directories.
|
|-
| <code>ToggleDPMS</code>
| Toggle DPMS mode manually
|
|- {{gotham row}}
| <code>CECToggleState</code>
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECActivateSource</code>
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECStandby</code>
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>Weather.Refresh</code>
| Force weather data refresh
|
|-
| <code>Weather.LocationNext</code>
| Switch to next weather location
|
|-
| <code>Weather.LocationPrevious</code>
| Switch to previous weather location
|
|-
| <code>Weather.LocationSet</code>
| Switch to given weather location (parameter can be 1-3)
|
|-
| <code>LIRC.Stop</code>
| Removes Kodi as a LIRC client.
|
|-
| <code>LIRC.Start</code>
| Adds Kodi as a LIRC client.
|
|-
| <code>LIRC.Send(command)</code>
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|- {{frodo row}}
| <code>ToggleDebug</code>
| Enables/disables debug mode
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StartPVRManager</code>
| (Re)Starts the PVR manager
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StopPVRManager</code>
| Stops the PVR manager
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>{{nowrap|StartAndroidActivity(package,[intent,dataType,dataURI])}}</code>
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousChannelGroup</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextChannelGroup</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>settingslevelchange</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>SetStereoMode</code>
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextStereoMode</code>
| Changes the stereo mode of the GUI to the next available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousStereoMode</code>
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>ToggleStereoMode</code>
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>StereoModeToMono</code>
| Toggle the stereoscopic mode to 2D.
| {{nowrap|v13 Addition}}
|}
<section end="functions" />
<section end="main content" />

== Removed functions ==
* <code>LastFM.Love</code> - Removed in v13 Gotham
* <code>LastFM.Ban</code> - Removed in v13 Gotham
* <code>LCD.Suspend</code> - Removed in v13 Gotham
* <code>LCD.Resume</code> - Removed in v13 Gotham

== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function:
{| class="prettytable"
! ID
! Description
|-
| <code>1</code>
| Name
|-
| <code>2</code>
| Date
|-
| <code>3</code>
| Size
|-
| <code>4</code>
| File
|-
| <code>5</code>
| Path
|-
| <code>6</code>
| DriveType
|-
| <code>7</code>
| Title
|-
| <code>8</code>
| TrackNumber
|-
| <code>9</code>
| Time
|-
| <code>10</code>
| Artist
|-
| <code>11</code>
| Album
|-
| <code>12</code>
| AlbumType
|-
| <code>13</code>
| Genre
|-
| <code>14</code>
| Country
|-
| <code>15</code>
| Year
|-
| <code>16</code>
| Rating
|-
| <code>17</code>
| Votes
|-
| <code>18</code>
| Top250
|-
| <code>19</code>
| ProgramCount
|-
| <code>20</code>
| PlaylistOrder
|-
| <code>21</code>
| EpisodeNumber
|-
| <code>22</code>
| Season
|-
| <code>23</code>
| NumberOfEpisodes
|-
| <code>24</code>
| NumberOfWatchedEpisodes
|-
| <code>25</code>
| TvShowStatus
|-
| <code>26</code>
| TvShowTitle
|-
| <code>27</code>
| SortTitle
|-
| <code>28</code>
| ProductionCode
|-
| <code>29</code>
| MPAA
|-
| <code>30</code>
| VideoResolution
|-
| <code>31</code>
| VideoCodec
|-
| <code>32</code>
| VideoAspectRatio
|-
| <code>33</code>
| AudioChannels
|-
| <code>34</code>
| AudioCodec
|-
| <code>35</code>
| AudioLanguage
|-
| <code>36</code>
| SubtitleLanguage
|-
| <code>37</code>
| Studio
|-
| <code>38</code>
| DateAdded
|-
| <code>39</code>
| LastPlayed
|-
| <code>40</code>
| Playcount
|-
| <code>41</code>
| Listeners
|-
| <code>42</code>
| Bitrate
|-
| <code>43</code>
| Random
|-
| <code>44</code>
| Channel
|-
| <code>45</code>
| ChannelNumber
|-
| <code>46</code>
| DateTaken
|}

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

Skip steps

2015-04-30T07:22:24Z

Xhaggi:

{{isengard|nocat=}}
{{notice|Kodi v15 (Isengard) final has not been released yet. As such, these changes is for the current Kodi mainline which is a work in progress and are still subject to change.}}

{{mininav| [[Video library]] | [[Video playback]] }}
<section begin="intro" />Skip steps is a new seeking function that has been implemented into Kodi v15 and is a method of additive skipping (also known as additive seeking) that applies to both videos and music, it allows you to skip backwards and forwards with the left and right cursor keys (this is the default '''[[Keymap|keyboard and remote]]''' mapping), and by pressing these keys multiple times you can skip with increasingly larger steps.<section end="intro"/>
 
The following '''[[Action IDs|Action ID's]]''' are for now forwarded to the new seeking function:
 
* StepForward
* StepBack
* SmallStepBack - note this action is going to be removed as it is now redundant with the new seeking behaviour.
 

== Configuration ==
The settings can be found in the '''''Videos -> Playback''''' section and '''''Music -> Playback'''''
 
 

[[File:skip steps.jpg|800px]]

 
 
'''Skip steps -''' This allows you to set the number of skip steps and the value for each step, the default values available here are '''-30 min, -15 min, -10 min, -5 min, -60 sec, -30 sec, -15 sec, -7 sec, 7 sec, 15 sec, 30 sec, 60 sec, 5 min, 10 min, 15 min, 30 min.'''
 
 
'''Skip delay:''' This is the amount of time Kodi waits for you to press the left or right key again (if using the default '''[[Keymap|keyboard and remote]]''' mapping) , before actually performing the forward or backwards skip, can be set to '''None''' and from there in '''250ms''' steps until '''3000ms'''.
 

=== Custom skip steps ===

The available '''skip step''' values can be further customised via the '''[[advancedsettings.xml]]''' file with the '''<seeksteps>''' entry. This is an optional step for users who want more granular control over what options are available.

{{greenv|'''IMPORTANT:'''|This advanced setting only overrides the values to be listed in the GUI '''Skip steps''' setting , in order to activate them for use you need to select them in the GUI using the '''Skip step''' setting, otherwise Kodi will carry on using the previously selected values. The values you enter are integers, so they apply for both the negative and positive directions e.g. a value of 10 will result in '''-10 sec''' and '''10 sec''' appearing in the '''Skip step''' list.}}

<big>'''Example:'''</big>

<syntaxhighlight lang="xml" enclose="div">
<seeksteps>10, 20, 30, 40, 50, 60</seeksteps>
</syntaxhighlight>

This will result in the '''Skip step''' list in the GUI of '''-60 sec, -50 sec, -40 sec, -30 sec, -20 sec, -10 sec, 10 sec, 20 sec, 30 sec, 40 sec, 50 sec, 60 sec'''

== Additive skipping ==

Additive skipping (additive seeking) is a method of having increasingly larger skip steps the more times you press either the left or right key, you need at least one skip step configured for either the positive or negative direction together with having a skip delay set. '''Note -''' If you press either the left or right key more times than there are configured steps for that direction, then the last configured skip size value will be summed up for each subsequent key press.
 
 
<big>'''Example 1'''</big>
 
 
'''Skip Steps:''' -30 sec, -15sec, -7 sec, 15 sec, 30 sec, 60 sec 
'''Skip Delay:''' 750ms
 
 
This table shows what happens with multiple presses of either the left key or the right key:

{| class="wikitable"
|- style="text-align: center"
| '''Key Presses''' || Left x 5 || Left x 4 || Left x 3 || Left x 2 || Left || Right || Right x 2 || Right x 3 || Right x 4 || Right x 5
|- style="text-align: center"
| '''Time to be skipped''' || 90 seconds backwards || 60 seconds backwards || 30 seconds backwards || 15 seconds backwards || 7 seconds backwards || 15 seconds forwards || 30 seconds forwards || 60 seconds forwards || 120 seconds forwards || 180 seconds forwards
|}

{{greenv|'''IMPORTANT:'''|As there are 3 skip values in the positive direction with 60 sec being the last value, therefore a 4th right key press will take 60 sec (value for 3 key presses) and add a further 60 sec thus the skip size will be 120 sec forwards, a 5th right key press will be 180 sec, and so on. The same behaviour also applies for the negative direction.}}

 
<big>'''Example 2'''</big>
 
 
'''Skip Steps:''' -7 sec, 30 sec 
'''Skip Delay:''' 750ms
 
 
This table shows what happens with multiple presses of either the left key or the right key:

{| class="wikitable"
|- style="text-align: center"
| '''Key Presses''' || Left x 3 || Left x 2 || Left || Right || Right x 2 || Right x 3
|- style="text-align: center"
| '''Time to be skipped''' || 21 seconds backwards || 14 seconds backwards || 7 seconds backwards || 30 seconds forwards || 60 seconds forwards || 90 seconds forwards
|}

{{greenv|'''IMPORTANT:'''|As there is only 1 skip value of 30 sec in the positive direction therefore a 2nd right key press will take 30 sec (value for 1 key press) and add a further 30 sec thus the skip size will be 60 sec forwards, a 3rd right key press will be 90 sec, and so on. The same behaviour also applies for the negative direction.}}

 
It is worth experimenting with Skip Delay to find the optimal setting for your hardware and the type of response you wish, for 250ms allows use of the additive function while retaining an almost instant response however this needs very quick presses for multiple presses to be registered.
 

== Instant skipping ==

With no more than a single negative or positive step configured, together with Skip Delay set to none, then Kodi will instantly skip without a delay.
 
 
<big>'''Example'''</big>
 
 
'''Skip Steps:''' -7 sec, 30 sec 
'''Skip Delay:''' None
 

{| class="wikitable"
|- style="text-align: center"
| '''Key Presses''' || Left || Right
|-
| '''Time to be skipped''' || 7 seconds backwards || 30 seconds forwards
|}

== Built-in function ==

With the built-in function <code>Seek(seconds)</code> you are able to specify a relative amount of seconds to seek within the current playing media. A negative value will seek backward and a positive value forward. 
For example, to make a seek that goes forward 25 seconds use Seek(25), and to make a seek that goes back 36 seconds use Seek(-36).
 
 
See also: [[Keymap|How to customize my keymap]].
 
 
<big>'''Example'''</big>
 
<pre>
<keymap>
<FullscreenVideo>
<keyboard>
Seek(-7)
</keyboard>
</FullscreenVideo>
</keymap>
</pre>
 

==See also==
* [[Video playback]]
* [[HOW-TO:Modify time seeking]]
* [[Keyboard controls]]
* [[Keymap]]
* [[Action IDs]]

{{Isengard updated}}

[[Category:Manual]]
[[Category:Video library]]
[[Category:Isengard feature]]

List of built-in functions

2015-04-01T07:33:24Z

Xhaggi: /* List of functions */

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Built-in scripting|Python development|Skinning}}
<section begin="main content" />
Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.

The latest up-to-date list of built-in functions can be found in the function '''CBuiltins::Execute()''' in the source code file [https://github.com/xbmc/xbmc/blob/master/xbmc/interfaces/Builtins.cpp /xbmc/interfaces/Builtins.cpp].

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

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

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

== List of functions ==
{| class="prettytable"
! Function
! Description
! Version
|-
| <code>Help</code>
| This help message (??? probably broken)
|
|-
| <code>Reboot</code>
| Cold reboots the system (power cycle)
|
|-
| <code>ShutDown</code>
| Trigger default Shutdown action defined in System Settings
|
|-
| <code>Powerdown</code>
| Powerdown system
|
|-
| <code>Quit</code>
| Quits XBMC
|
|-
| <code>Hibernate</code>
| Hibernate (S4) the System
|
|-
| <code>Suspend</code>
| Suspends (S3 / S1 depending on bios setting) the System
|
|- {{frodo row}}
| <code>InhibitIdleShutdown(true/false)</code>
| Prevent the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>AllowIdleShutdown</code>
| Allow the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>ActivateScreensaver</code>
| Starts the screensaver
| {{nowrap|v13 Addition}}
|-
| <code>RestartApp</code>
| Restarts XBMC (only implemented under Windows and Linux)
|
|-
| <code>Minimize</code>
| Minimizes XBMC
|
|-
| <code>Reset</code>
| Reset the system (same as reboot)
|
|-
| <code>Mastermode</code>
| Runs XBMC in master mode
|
|- {{gotham row}}
| <code>SetGUILanguage</code>
| Set GUI Language
| {{nowrap|v13 Addition}}
|-
| <code>ActivateWindow(window[,dir,return])</code>
| Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. [[Window IDs|See here for a list of window names, and their respective ids.]] If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder XBMC should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that XBMC should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating.
|
|- {{frodo row}}
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v12 Addition}}
|-
| <code>ReplaceWindow(window,dir)</code>
| Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.
|
|- {{gotham row}}
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v13 Addition}}
|-
| <code>TakeScreenshot</code>
| Takes a Screenshot
|
|-
| <code>RunScript(script[,args]*)</code>
| Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
|
|- {{frodo row}}
| <code>StopScript(id)</code>
| Stop the script by ID or path, if running
| {{nowrap|v12 Addition}}
|-
| <code>RunAppleScript(script[,args]*)</code>
| Run the specified AppleScript command
|
|-
| <code>RunPlugin(plugin)</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
|-
| <code>RunAddon(id)</code>
| Runs the specified plugin/script
|
|- {{gotham row}}
| <code>NotifyAll</code>
| Notify all connected clients
| {{nowrap|v13 Addition}}
|-
| <code>Extract</code>
| Extracts a specified archive to an optionally specified 'absolute' path.
|
|-
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
|
|- {{isengard row}}
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|- {{gotham row}}
| <code>ShowPicture(picture)</code>
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
| <code>SlideShow(dir [,recursive, [not]random])</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window.
|
|-
| <code>RecursiveSlideShow(dir)</code>
| Run a slideshow from the specified directory, including all subdirs
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|-
| <code>RefreshRSS</code>
| Reload RSS feeds from RSSFeeds.xml
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, 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.
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>EjectTray()</code>
| Either opens or closes the DVD tray, depending on its current state
|
|-
| <code>AlarmClock(name,command,time[,silent,loop])</code>
| Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires.
|
|-
| <code>CancelAlarm(name[,silent])</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|
|-
| <code>Action(action)</code>
| Executes an action for the active window (same as in keymap)
|
|-
| <code>Notification(header,message[,time,image])</code>
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.
|
|-
| <code>PlayDVD</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>RipCD</code>
| Will rip the inserted CD from the DVD-ROM drive.
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,value])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.
|
|-
| <code>Skin.Theme</code>
| Cycles the skin theme. Skin.theme(-1) will go backwards.
|
|-
| <code>Skin.SetImage(string[,value])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetLargeImage(string[,value])</code>
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "|" minus quotes. If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are ''xbmc.addon.video'', ''xbmc.addon.audio'', ''xbmc.addon.image'' and ''xbmc.addon.executable''.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other XBMC settings.
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Mute</code>
| Mutes (or unmutes) the volume.
|
|-
| <code>SetVolume(percent[,showvolumebar])</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in XBMC when setting the volume.
|
|-
| <code>Dialog.Close(dialog[,force])</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
| <code>System.LogOff</code>
| Log off current user.
|
|-
| <code>System.Exec</code>
| Execute shell commands.
|
|-
| <code>System.ExecWait</code>
| Execute shell commands and freezes XBMC until shell is closed.
|
|-
| <code>Resolution</code>
| Change XBMC's Resolution.
|
|-
| <code>SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>PageDown</code>
| Send a page down event to the pagecontrol with given id.
|
|-
| <code>PageUp</code>
| Send a page up event to the pagecontrol with given id.
|
|-
| <code>Container.Refresh</code>
| Refresh current listing.
|
|-
| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
| <code>Container.NextViewMode</code>
| Select the next view mode.
|
|-
| <code>Container.PreviousViewMode</code>
| Select the previous view mode.
|
|-
| <code>Container.SetViewMode(id)</code>
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
| <code>Container.NextSortMethod</code>
| Change to the next sort method.
|
|-
| <code>Container.PreviousSortMethod</code>
| Change to the previous sort method.
|
|-
| <code>Container.SetSortMethod(id)</code>
| Change to the specified sort method. (For list of ID's see '''List of sort methods''' below)
|
|-
| <code>Container.SortDirection</code>
| Toggle the sort direction.
|
|-
| <code>Control.Move(id,offset)</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
|
|-
| <code>Control.SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>Control.Message(id,message,[windowid])</code>
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
| <code>SendClick(windowid,id)</code>
| Sends a click to a control in a given window (or active window if omitted).
|
|-
| <code>LoadProfile(profilename,[prompt])</code>
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.
|
|-
| <code>SetProperty(key,value[,id])</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
|
|-
| <code>ClearProperty(key[,id])</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>WakeOnLan(''mac'')</code>
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).
|
|-
| <code>Addon.Default.OpenSettings</code>
| Open a settings dialog for the default addon of the given type
|
|-
| <code>Addon.Default.Set</code>
| Open a select dialog to allow choosing the default addon of the given type
|
|-
| <code>Addon.OpenSettings(id)</code>
| Open a settings dialog for the addon of the given id
|
|-
| <code>UpdateAddonRepos</code>
| Triggers a forced update of enabled add-on repositories.
|
|-
| <code>UpdateLocalAddons</code>
| Triggers a scan of local add-on directories.
|
|-
| <code>ToggleDPMS</code>
| Toggle DPMS mode manually
|
|- {{gotham row}}
| <code>CECToggleState</code>
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECActivateSource</code>
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECStandby</code>
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>Weather.Refresh</code>
| Force weather data refresh
|
|-
| <code>Weather.LocationNext</code>
| Switch to next weather location
|
|-
| <code>Weather.LocationPrevious</code>
| Switch to previous weather location
|
|-
| <code>Weather.LocationSet</code>
| Switch to given weather location (parameter can be 1-3)
|
|-
| <code>LIRC.Stop</code>
| Removes XBMC as a LIRC client.
|
|-
| <code>LIRC.Start</code>
| Adds XBMC as a LIRC client.
|
|-
| <code>LIRC.Send(command)</code>
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|- {{frodo row}}
| <code>ToggleDebug</code>
| Enables/disables debug mode
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StartPVRManager</code>
| (Re)Starts the PVR manager
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StopPVRManager</code>
| Stops the PVR manager
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>{{nowrap|StartAndroidActivity(package,[intent,dataType,dataURI])}}</code>
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousChannelGroup</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextChannelGroup</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>settingslevelchange</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>SetStereoMode</code>
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextStereoMode</code>
| Changes the stereo mode of the GUI to the next available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousStereoMode</code>
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>ToggleStereoMode</code>
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>StereoModeToMono</code>
| Toggle the stereoscopic mode to 2D.
| {{nowrap|v13 Addition}}
|}

<section end="main content" />

== Removed functions ==
* <code>LastFM.Love</code> - Removed in v13 Gotham
* <code>LastFM.Ban</code> - Removed in v13 Gotham
* <code>LCD.Suspend</code> - Removed in v13 Gotham
* <code>LCD.Resume</code> - Removed in v13 Gotham

== List of sort methods ==

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

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

Template:Isengard row

2015-04-01T07:31:13Z

Xhaggi:

style="background:#bc925c;"

Template:Isengard row

2015-04-01T07:25:09Z

Xhaggi: Created page with "style="background:#b57d34;""

style="background:#b57d34;"

HOW-TO:Modify time seeking

2015-04-01T07:15:54Z

Xhaggi:

{{mininav| [[advancedsettings.xml]] {{l2| [[Video library]] }} }}
<section begin="intro" />This page describes various '''[[advancedsettings.xml]] settings''' that can be used to modify the default seek "steps" in {{kodi}}, commonly mapped to the directional keys during playback (left, right, up, down). By default, up/down is "BigStepForward/Back" +/- 10 minutes, and left/right is "StepForward/Back" +/- 30 seconds. There is also "SmallStepBack", which is -7 seconds. All of these options can be modified.<section end="intro" />

{{Future note|In the upcoming version 15 release, smallstepbackseconds, timeseekback, and timeseekforward will be removed and replaced with [[Skip steps|skip steps support]], which has settings the user can change from the GUI.}}

{{TOC limit|2}}

== Steps ==
If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. Kodi uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features.

{{how-to
| Step1 = Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is ".xml" and {{color|red|'''not'''}} ".txt" or ".xml.txt".

| Step2 = Cut and paste this into your new plain text file:
:<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<video>
<usetimeseeking>true</usetimeseeking>
<smallstepbackseconds>7</smallstepbackseconds>
<timeseekforward>30</timeseekforward>
<timeseekbackward>-30</timeseekbackward>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</video>
</advancedsettings>
</syntaxhighlight>

| Step3 = Change the values between the tags to fit your situation. See '''[[#Settings explained]]''' for details.

| Step4 = Save this file in your [[userdata folder]]:
:{{#lst:userdata|location all}}
{{note|If you have an existing advancedsettings.xml file, make sure the <video></video> tags, and settings we'll add between them, are between the main <advancedsettings></advancedsettings> tags.}}

}}

== Settings explained ==
{| class="prettytable"
! advancedsettings.xml tag !! what it does
|-
| <code><usetimeseeking>'''true'''</usetimeseeking></code>

| {{big|'''Use time or percentages'''}}

By default, Kodi uses the time tags for videos above 20 minutes, and videos below 20 minutes will use the percentage tags. Set this to '''false''' to only use the percent tags regardless of video length (except for smallstepbackseconds, which has no percent counterpart).

|-
| <code><smallstepbackseconds>'''7'''</smallstepbackseconds></code>

| {{big|'''Small step back'''}}

SmallStepBack is the only "step" in Kodi that doesn't have a forward option. This is because the idea behind SmallStepBack is to quickly jump back and hear a line of dialogue or some quick action that was missed.
|-
| <code><timeseekforward>'''30'''</timeseekforward> <timeseekbackward>'''-30'''</timeseekbackward></code>

| {{big|'''Normal time jumps'''}} {{small|''Videos longer than 20 minutes''}}

This is set in seconds. For minutes simply multiply by 60. A - (minus) sign is used when you want to go backward in the video. The default setting is 30 seconds.

|-
| <code><timeseekforwardbig>'''600'''</timeseekforwardbig> <timeseekbackwardbig>'''-600'''</timeseekbackwardbig></code>

| {{big|'''Big time jumps'''}} {{small|''Videos longer than 20 minutes''}}

This is set in seconds. For minutes simply multiply by 60. A - (minus) sign is used when you want to go backward in the video. The default setting is 10 minutes.

|-
| <code><percentseekforward>'''2'''</percentseekforward> <percentseekbackward>'''-2'''</percentseekbackward></code>

| {{big|'''Normal percentage jumps'''}} {{small|''Videos shoter than 20 minutes''}}

This is set in percentage of the video length. A - (minus) sign is used when you want to go backward in the video. The default setting is 2 percent.

For example, a 1 minute video will seek slightly more than 1 second (1.2, to be exact) if seeking back/forward by 2 percent.

|-
| <code><percentseekforwardbig>'''10'''</percentseekforwardbig> <percentseekbackwardbig>'''-10'''</percentseekbackwardbig></code>

| {{big|'''Big percentage jumps'''}} {{small|''Videos shorter than 20 minutes''}}

This is set in percentage of the video length. A - (minus) sign is used when you want to go backward in the video. The default setting is 10 percent.

For example, a 10 minute video will seek 1 minute if seeking back/forward by 10 percent.

|}

== Examples ==

=== Example 1 ===
In this example we have set Kodi to always use percent seeks, so there is no need to include the time seek tags. The percentages used are smaller for more fine-grained control, but anyone who wants truly fine-grain control will most likely want to use time-based seeking rather than percentage-based seeking.

;advancedsettings.xml
<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<video>
<usetimeseeking>false</usetimeseeking>
<percentseekforward>1</percentseekforward>
<percentseekbackward>-1</percentseekbackward>
<percentseekforwardbig>5</percentseekforwardbig>
<percentseekbackwardbig>-5</percentseekbackwardbig>
</video>
</advancedsettings>
</syntaxhighlight>

=== Example 2 ===
This example shows a simple adjustment of the seeks, which a person might use depending on their own personal preferences. <code><usetimeseeking></code> is excluded here since this person is okay with using time-based tags for videos longer than 20 minutes, and percentage-based tags for videos shorter than 20 minutes (the default).

;advancedsettings.xml
<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<video>
<smallstepbackseconds>5</smallstepbackseconds>
<timeseekforward>15</timeseekforward>
<timeseekbackward>-15</timeseekbackward>
<timeseekforwardbig>60</timeseekforwardbig>
<timeseekbackwardbig>-60</timeseekbackwardbig>
<percentseekforward>3</percentseekforward>
<percentseekbackward>-3</percentseekbackward>
<percentseekforwardbig>20</percentseekforwardbig>
<percentseekbackwardbig>-20</percentseekbackwardbig>
</video>
</advancedsettings>
</syntaxhighlight>

=== Example 3 ===
This example is the same as '''[[#Example 2|Example 2]]''', but without the percent-based tags. When any tag is not included it will simply use the default value. If this were a situation were we only wanted to change the time-based seeking, then we would only need to include those tags.

;advancedsettings.xml
<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<video>
<smallstepbackseconds>5</smallstepbackseconds>
<timeseekforward>15</timeseekforward>
<timeseekbackward>-15</timeseekbackward>
<timeseekforwardbig>60</timeseekforwardbig>
<timeseekbackwardbig>-60</timeseekbackwardbig>
</video>
</advancedsettings>
</syntaxhighlight>

=== Example 4 ===
In this example things get ''weird''. Despite the name of the tags, we can actually use either "forward" or "back" for both forward and backwards seeking, depending on if we use the - (minus) sign or not. While not actually practical, this is one example of how these settings could be used. When using default [[keymaps]] we get the following behavior:

* '''Left:''' forward 10 seconds
* '''Right:''' forward 20 seconds
* '''Up:''' forward 30 seconds
* '''Down:''' forward 40 seconds

;advancedsettings.xml
<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<video>
<timeseekforward>10</timeseekforward>
<timeseekbackward>20</timeseekbackward>
<timeseekforwardbig>30</timeseekforwardbig>
<timeseekbackwardbig>40</timeseekbackwardbig>
</video>
</advancedsettings>
</syntaxhighlight>

== Other ways to seek ==
This page simply covers the [[advancedsettings.xml]] values, which typically relate to how the directional keys jump in a video. However, there are many other ways that one can seek back or forward in time when playing a video. See the topics below for some of those methods:

* [[Remote controls]]
* [[Keymaps]]

{{Helix updated}}

[[Category:Advanced topics]]
[[Category:How-to]]
[[Category:Video library]]
[[Category:Remotes]]

Official:Code guidelines and formatting conventions

2015-03-24T11:20:10Z

Xhaggi: /* Variables */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should look like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace.
<pre>
a = (b + c) * d;
</pre>

Reserved words should be separated from opening parentheses by a whitespace.
<pre>
while (true)
for (int i = 0; i < x; ++i)
</pre>

Commas should be followed by a whitespace.
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace if there is more than one expression per line.
<pre>
for (int i = 0; i < x; ++i)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Control statements ==
Insert new line before
* ''else'' in an ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

=== if else ===
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;

if (true)
{
[...]
}
else if (false)
{
return;
}
else
return;
</pre>

=== switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables. Type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T11:19:11Z

Xhaggi: /* if else */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should look like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace.
<pre>
a = (b + c) * d;
</pre>

Reserved words should be separated from opening parentheses by a whitespace.
<pre>
while (true)
for (int i = 0; i < x; ++i)
</pre>

Commas should be followed by a whitespace.
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace if there is more than one expression per line.
<pre>
for (int i = 0; i < x; ++i)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Control statements ==
Insert new line before
* ''else'' in an ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

=== if else ===
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;

if (true)
{
[...]
}
else if (false)
{
return;
}
else
return;
</pre>

=== switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T11:18:57Z

Xhaggi: /* if else */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should look like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace.
<pre>
a = (b + c) * d;
</pre>

Reserved words should be separated from opening parentheses by a whitespace.
<pre>
while (true)
for (int i = 0; i < x; ++i)
</pre>

Commas should be followed by a whitespace.
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace if there is more than one expression per line.
<pre>
for (int i = 0; i < x; ++i)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Control statements ==
Insert new line before
* ''else'' in an ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

=== if else ===
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;
if (true)
{
[...]
}
else if (false)
{
return;
}
else
return;
</pre>

=== switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T07:24:52Z

Xhaggi: /* Whitespaces */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace.
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace.
<pre>
while (true)
for (int i = 0; i < x; ++i)
</pre>

Commas should be followed by a whitespace.
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace if there is more than one expression per line.
<pre>
for (int i = 0; i < x; ++i)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Control statements ==
Insert new line before
* ''else'' in and ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

=== if else ===
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;
if (true)
{
return;
}
else if (false)
{
return;
}
else
{
return;
}
</pre>

=== switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T07:23:27Z

Xhaggi: /* Switch / case */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace
<pre>
while (true)
</pre>

Commas should be followed by a whitespace
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace, if there is more than one expression per line
<pre>
for (int a = 0; b++; c < d)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Control statements ==
Insert new line before
* ''else'' in and ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

=== if else ===
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;
if (true)
{
return;
}
else if (false)
{
return;
}
else
{
return;
}
</pre>

=== switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T07:20:46Z

Xhaggi: /* Whitespaces */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace
<pre>
while (true)
</pre>

Commas should be followed by a whitespace
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace, if there is more than one expression per line
<pre>
for (int a = 0; b++; c < d)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Control statements ==
Insert new line before
* ''else'' in and ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

=== if else ===
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;
if (true)
{
return;
}
else if (false)
{
return;
}
else
{
return;
}
</pre>

=== Switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T07:20:13Z

Xhaggi: /* Switch / case */

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace
<pre>
while (true)
</pre>

Commas should be followed by a whitespace
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace, if there is more than one expression per line
<pre>
for (int a = 0; b++; c < d)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

=== Control statements ===
Insert new line before
* ''else'' in and ''if'' statement
* ''catch'' in a ''try'' statement
* ''while'' in a ''do'' statement

==== if else ====
* put ''then'' statement, ''return'' or ''throw'' to new line
* keep ''else if'' on one line
<pre>
if (true)
return;
if (true)
{
return;
}
else if (false)
{
return;
}
else
{
return;
}
</pre>

=== Switch / case ===
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Official:Code guidelines and formatting conventions

2015-03-24T07:04:16Z

Xhaggi:

{{mininav|[[Development]]}}
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace
<pre>
while (true)
</pre>

Commas should be followed by a whitespace
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace, if there is more than one expression per line
<pre>
for (int a = 0; b++; c < d)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Switch / case ==
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

[[Category:Development]]

Development

2015-03-24T07:00:19Z

Xhaggi: /* General guidelines */

{{XBMC development nav}}
{{mininav}}

__TOC__
{{-}}
== Topics ==
{{see also|Category:Development}}
{{development links}}

== Source code ==
* See: https://github.com/xbmc/xbmc

== Development Tools ==
* [http://www.stack.nl/~dimitri/doxygen/ Doxygen] - Source code documentation generator tool.

== Other tools and resources ==
Though any other tools or resources are not required they can possibly help in development.
* [[Eclipse CDT Setup For XBMC Development]]
* [http://www.stack.nl/~dimitri/doxygen/ Doxygen] - Source code documentation generator tool.
* [http://valgrind.org Valgrind] (for Linux) - a free Linux programming tool for memory debugging, memory leak detection, and profiling.
* [http://www.daimi.au.dk/~sandmann/sysprof/ Sysprof] (for Linux) - a free System-wide Linux Profiler for tracking CPU usage. Sysprof is a sampling CPU profiler for Linux that uses a kernel module to profile the entire system, not just a single application. Sysprof handles shared libraries, and applications do not need to be recompiled. In fact they don't even have to be restarted. Just insert the kernel module and start sysprof.

=== XBMC Artwork ===
The official logo package and source files can be downloaded at sourceforge directly from the link below.

* [http://mirrors.xbmc.org/docs/artwork/XBMC_official_logo_package_v1.0.zip XBMC official logo package v1.0]

== General guidelines ==
* Code documentation (DocBook, rst, or [http://www.doxygen.org doxygen] for the code documentation steps, preferably the latter, [http://www.doxygen.org doxygen])
* Self-containment - XBMC should be as little dependent as possible on operating-system and third-party services/deamons/libraries
** XBMC should for example contain all file-system and network-client (like samba) support built-into the XBMC package
* Modular design - independent modules made up by localized/isolated code libraries without dependencies
** XBMC should still compile and run if a non-essential module/library is disabled or removed
* Aim for the GUI/interface to run smoothly on a low spec computer (single core with less than 1Ghz)
** 3D graphic controller (GPU) will always be required hardware for XBMC so try to utilize the GPU as much as possible
* Avoid hard-disk trashing (excess read/write/erase cycles), so no hard-drive paging, (utilize RAM memory instead).
** End-users will be running XBMC and the operating-system on solid-State memory as a [http://en.wikipedia.org/wiki/LiveDistro Live CD (LiveDistro)] of a USB-key
* Fast load and boot times for end-user perception (other things can still run/start in the background without the user knowledge)
** 15-seconds or less from when the end user press the power-button on the computer till he/she can browse the GUI

== Code guidelines and formatting conventions ==
[[Code_guidelines_and_formatting_conventions|Code guidelines and formatting conventions]]

== User-friendliness is next to godliness ==
{{#lst:XBMC manifesto|User-friendliness}}

== Contact methods ==
* IRC: [irc://irc.freenode.net/xbmc-dev #xbmc-dev on freenode] official [http://freenode.net IRC network channel] focused on XBMC development
* [http://forum.xbmc.org/forumdisplay.php?fid=93 XBMC Development Community Forum]
* [[HOW-TO submit a patch]] (where and how to submit source code)

[[Category:Development|*]]
[[Category:Skin development]]
[[Category:Manual]]

Official:Code guidelines and formatting conventions

2015-03-23T14:41:27Z

Xhaggi:

These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace
<pre>
while (true)
</pre>

Commas should be followed by a whitespace
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace, if there is more than one expression per line
<pre>
for (int a = 0; b++; c < d)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Switch / case ==
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

Official:Code guidelines and formatting conventions

2015-03-23T14:41:03Z

Xhaggi: Created page with "== Use common sense == These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common se..."

== Use common sense ==
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.

As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.
== Indentation ==
Use spaces as tab policy with an indentation size of 2

== Braces ==
Braces should go to newline and your code should looks like the following example:
<pre>
if (int i = 0; i < t; i++)
{
[...]
}
else
{
[...]
}

class Dummy()
{
[...]
}
</pre>

== Whitespaces ==
Conventional operators should be surrounded by a whitespace
<pre>
a = (b + c) * d;
</pre>

Reserved words should separated from opening parentheses by a whitespace
<pre>
while (true)
</pre>

Commas should be followed by a whitespace
<pre>
void Dummy::Method(int a, int b, int c);
int d, e;
</pre>

Semicolons should be followed by a whitespace, if there is more than one expression per line
<pre>
for (int a = 0; b++; c < d)
doSomething(e); doSomething(f); // this is probably bad style anyway
</pre>

== Switch / case ==
<pre>
switch (cmd)
{
case x:
{
doSomething();
break;
}
case x:
case z:
return true;
default:
doSomething();
}
</pre>

== Naming ==
=== Constants ===
Use upper case with underscore spacing where necessary.
<pre>
const int MY_CONSTANT = 1;
</pre>

=== Enums ===
Use CamelCase for the enum name and upper case for the values.
<pre>
enum Dummy
{
VALUE_X,
VALUE_Y
};
</pre>

=== Classes/Methods ===
We use CamelCase for class names and methods both with first letter in upper case.
<pre>
class MyDummyClass();
void MyDummyClass::DoSomething();
</pre>

=== Variables ===
We use CamelCase for variables and type prefixing is optional.

==== Global Variables ====
Prefix global variables with ''g_''
<pre>
int g_globalVariableA;
</pre>

==== Member Variables ====
Prefix member variables with ''m_''
<pre>
int m_variableA;
</pre>

List of built-in functions

2014-12-16T13:40:16Z

Xhaggi:

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Built-in scripting|Python development|Skinning}}
<section begin="main content" />
Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.

The latest up-to-date list of built-in functions can be found in the function '''CBuiltins::Execute()''' in the source code file [https://github.com/xbmc/xbmc/blob/master/src/interfaces/Builtins.cpp /src/interfaces/Builtins.cpp].

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

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

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

== List of functions ==
{| class="prettytable"
! Function
! Description
! Version
|-
| <code>Help</code>
| This help message
|
|-
| <code>Reboot</code>
| Cold reboots the system (power cycle)
|
|-
| <code>ShutDown</code>
| Trigger default Shutdown action defined in System Settings
|
|-
| <code>Powerdown</code>
| Powerdown system
|
|-
| <code>Quit</code>
| Quits XBMC
|
|-
| <code>Hibernate</code>
| Hibernate (S4) the System
|
|-
| <code>Suspend</code>
| Suspends (S3 / S1 depending on bios setting) the System
|
|- {{frodo row}}
| <code>InhibitIdleShutdown(true/false)</code>
| Prevent the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>AllowIdleShutdown</code>
| Allow the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>ActivateScreensaver</code>
| Starts the screensaver
| {{nowrap|v13 Addition}}
|-
| <code>RestartApp</code>
| Restarts XBMC (not implemented under Win32)
|
|-
| <code>Minimize</code>
| Minimizes XBMC
|
|-
| <code>Reset</code>
| Reset the system (same as reboot)
|
|-
| <code>Mastermode</code>
| Runs XBMC in master mode
|
|- {{gotham row}}
| <code>SetGUILanguage</code>
| Set GUI Language
| {{nowrap|v13 Addition}}
|-
| <code>ActivateWindow(window[,dir,return])</code>
| Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. [[Window IDs|See here for a list of window names, and their respective ids.]] If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder XBMC should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that XBMC should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating.
|
|- {{frodo row}}
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v12 Addition}}
|-
| <code>ReplaceWindow(window,dir)</code>
| Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.
|
|- {{gotham row}}
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v13 Addition}}
|-
| <code>TakeScreenshot</code>
| Takes a Screenshot
|
|-
| <code>RunScript(script[,args]*)</code>
| Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
|
|- {{frodo row}}
| <code>StopScript(id)</code>
| Stop the script by ID or path, if running
| {{nowrap|v12 Addition}}
|-
| <code>RunAppleScript(script[,args]*)</code>
| Run the specified AppleScript command
|
|-
| <code>RunPlugin(plugin)</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
|-
| <code>RunAddon(id)</code>
| Runs the specified plugin/script
|
|- {{gotham row}}
| <code>NotifyAll</code>
| Notify all connected clients
| {{nowrap|v13 Addition}}
|-
| <code>Extract</code>
| Extracts a specified archive to an optionally specified 'absolute' path.
|
|-
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
|
|- {{gotham row}}
| <code>ShowPicture(picture)</code>
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
| <code>SlideShow(dir [,recursive, [not]random])</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window.
|
|-
| <code>RecursiveSlideShow(dir)</code>
| Run a slideshow from the specified directory, including all subdirs
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|-
| <code>RefreshRSS</code>
| Reload RSS feeds from RSSFeeds.xml
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, 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.
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>EjectTray()</code>
| Either opens or closes the DVD tray, depending on its current state
|
|-
| <code>AlarmClock(name,command,time[,silent,loop])</code>
| Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires.
|
|-
| <code>CancelAlarm(name[,silent])</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|
|-
| <code>Action(action)</code>
| Executes an action for the active window (same as in keymap)
|
|-
| <code>Notification(header,message[,time,image])</code>
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.
|
|-
| <code>PlayDVD</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>RipCD</code>
| Will rip the inserted CD from the DVD-ROM drive.
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,value])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.
|
|-
| <code>Skin.Theme</code>
| Cycles the skin theme. Skin.theme(-1) will go backwards.
|
|-
| <code>Skin.SetImage(string[,value])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetLargeImage(string[,value])</code>
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "|" minus quotes. If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are ''xbmc.addon.video'', ''xbmc.addon.audio'', ''xbmc.addon.image'' and ''xbmc.addon.executable''.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other XBMC settings.
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Mute</code>
| Mutes (or unmutes) the volume.
|
|-
| <code>SetVolume(percent[,showvolumebar])</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in XBMC when setting the volume.
|
|-
| <code>Dialog.Close(dialog[,force])</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
| <code>System.LogOff</code>
| Log off current user.
|
|-
| <code>System.Exec</code>
| Execute shell commands.
|
|-
| <code>System.ExecWait</code>
| Execute shell commands and freezes XBMC until shell is closed.
|
|-
| <code>Resolution</code>
| Change XBMC's Resolution.
|
|-
| <code>SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>PageDown</code>
| Send a page down event to the pagecontrol with given id.
|
|-
| <code>PageUp</code>
| Send a page up event to the pagecontrol with given id.
|
|-
| <code>Container.Refresh</code>
| Refresh current listing.
|
|-
| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
| <code>Container.NextViewMode</code>
| Select the next view mode.
|
|-
| <code>Container.PreviousViewMode</code>
| Select the previous view mode.
|
|-
| <code>Container.SetViewMode(id)</code>
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
| <code>Container.NextSortMethod</code>
| Change to the next sort method.
|
|-
| <code>Container.PreviousSortMethod</code>
| Change to the previous sort method.
|
|-
| <code>Container.SetSortMethod</code>
| Change to the specified sort method.
|
|-
| <code>Container.SortDirection</code>
| Toggle the sort direction.
|
|-
| <code>Control.Move(id,offset)</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
|
|-
| <code>Control.SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>Control.Message(id,message,[windowid])</code>
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
| <code>SendClick(windowid,id)</code>
| Sends a click to a control in a given window (or active window if omitted).
|
|-
| <code>LoadProfile(profilename,[prompt])</code>
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.
|
|-
| <code>SetProperty(key,value[,id])</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
|
|-
| <code>ClearProperty(key[,id])</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>WakeOnLan(''mac'')</code>
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).
|
|-
| <code>Addon.Default.OpenSettings</code>
| Open a settings dialog for the default addon of the given type
|
|-
| <code>Addon.Default.Set</code>
| Open a select dialog to allow choosing the default addon of the given type
|
|-
| <code>Addon.OpenSettings(id)</code>
| Open a settings dialog for the addon of the given id
|
|-
| <code>UpdateAddonRepos</code>
| Triggers a forced update of enabled add-on repositories.
|
|-
| <code>UpdateLocalAddons</code>
| Triggers a scan of local add-on directories.
|
|-
| <code>ToggleDPMS</code>
| Toggle DPMS mode manually
|
|- {{gotham row}}
| <code>CECToggleState</code>
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECActivateSource</code>
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECStandby</code>
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>Weather.Refresh</code>
| Force weather data refresh
|
|-
| <code>Weather.LocationNext</code>
| Switch to next weather location
|
|-
| <code>Weather.LocationPrevious</code>
| Switch to previous weather location
|
|-
| <code>Weather.LocationSet</code>
| Switch to given weather location (parameter can be 1-3)
|
|-
| <code>LIRC.Stop</code>
| Removes XBMC as a LIRC client.
|
|-
| <code>LIRC.Start</code>
| Adds XBMC as a LIRC client.
|
|-
| <code>LIRC.Send(command)</code>
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|- {{frodo row}}
| <code>ToggleDebug</code>
| Enables/disables debug mode
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StartPVRManager</code>
| (Re)Starts the PVR manager
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StopPVRManager</code>
| Stops the PVR manager
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>{{nowrap|StartAndroidActivity(package,[intent,dataType,dataURI])}}</code>
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousChannelGroup</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextChannelGroup</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>settingslevelchange</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>SetStereoMode</code>
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextStereoMode</code>
| Changes the stereo mode of the GUI to the next available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousStereoMode</code>
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>ToggleStereoMode</code>
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>StereoModeToMono</code>
| Toggle the stereoscopic mode to 2D.
| {{nowrap|v13 Addition}}
|}

<section end="main content" />

== Removed functions ==
* <code>LastFM.Love</code> - Removed in v13 Gotham
* <code>LastFM.Ban</code> - Removed in v13 Gotham
* <code>LCD.Suspend</code> - Removed in v13 Gotham
* <code>LCD.Resume</code> - Removed in v13 Gotham

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

List of built-in functions

2014-12-16T13:39:29Z

Xhaggi:

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Built-in scripting|Python development|Skinning}}
<section begin="main content" />
Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.

The latest up-to-date list of built-in functions can be found in the function '''CBuiltins::Execute()''' in the source code file [https://github.com/xbmc/xbmc/blob/master/src/interfaces/Builtins.cpp xbmc/interfaces/Builtins.cpp].

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

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

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

== List of functions ==
{| class="prettytable"
! Function
! Description
! Version
|-
| <code>Help</code>
| This help message
|
|-
| <code>Reboot</code>
| Cold reboots the system (power cycle)
|
|-
| <code>ShutDown</code>
| Trigger default Shutdown action defined in System Settings
|
|-
| <code>Powerdown</code>
| Powerdown system
|
|-
| <code>Quit</code>
| Quits XBMC
|
|-
| <code>Hibernate</code>
| Hibernate (S4) the System
|
|-
| <code>Suspend</code>
| Suspends (S3 / S1 depending on bios setting) the System
|
|- {{frodo row}}
| <code>InhibitIdleShutdown(true/false)</code>
| Prevent the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>AllowIdleShutdown</code>
| Allow the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>ActivateScreensaver</code>
| Starts the screensaver
| {{nowrap|v13 Addition}}
|-
| <code>RestartApp</code>
| Restarts XBMC (not implemented under Win32)
|
|-
| <code>Minimize</code>
| Minimizes XBMC
|
|-
| <code>Reset</code>
| Reset the system (same as reboot)
|
|-
| <code>Mastermode</code>
| Runs XBMC in master mode
|
|- {{gotham row}}
| <code>SetGUILanguage</code>
| Set GUI Language
| {{nowrap|v13 Addition}}
|-
| <code>ActivateWindow(window[,dir,return])</code>
| Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. [[Window IDs|See here for a list of window names, and their respective ids.]] If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder XBMC should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that XBMC should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating.
|
|- {{frodo row}}
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v12 Addition}}
|-
| <code>ReplaceWindow(window,dir)</code>
| Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.
|
|- {{gotham row}}
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v13 Addition}}
|-
| <code>TakeScreenshot</code>
| Takes a Screenshot
|
|-
| <code>RunScript(script[,args]*)</code>
| Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
|
|- {{frodo row}}
| <code>StopScript(id)</code>
| Stop the script by ID or path, if running
| {{nowrap|v12 Addition}}
|-
| <code>RunAppleScript(script[,args]*)</code>
| Run the specified AppleScript command
|
|-
| <code>RunPlugin(plugin)</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
|-
| <code>RunAddon(id)</code>
| Runs the specified plugin/script
|
|- {{gotham row}}
| <code>NotifyAll</code>
| Notify all connected clients
| {{nowrap|v13 Addition}}
|-
| <code>Extract</code>
| Extracts a specified archive to an optionally specified 'absolute' path.
|
|-
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.
|
|- {{gotham row}}
| <code>ShowPicture(picture)</code>
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
| <code>SlideShow(dir [,recursive, [not]random])</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are "recursive", and "random" or "notrandom" parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window.
|
|-
| <code>RecursiveSlideShow(dir)</code>
| Run a slideshow from the specified directory, including all subdirs
|
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|-
| <code>RefreshRSS</code>
| Reload RSS feeds from RSSFeeds.xml
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, 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.
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>EjectTray()</code>
| Either opens or closes the DVD tray, depending on its current state
|
|-
| <code>AlarmClock(name,command,time[,silent,loop])</code>
| Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires.
|
|-
| <code>CancelAlarm(name[,silent])</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|
|-
| <code>Action(action)</code>
| Executes an action for the active window (same as in keymap)
|
|-
| <code>Notification(header,message[,time,image])</code>
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.
|
|-
| <code>PlayDVD</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>RipCD</code>
| Will rip the inserted CD from the DVD-ROM drive.
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,value])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.
|
|-
| <code>Skin.Theme</code>
| Cycles the skin theme. Skin.theme(-1) will go backwards.
|
|-
| <code>Skin.SetImage(string[,value])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetLargeImage(string[,value])</code>
| Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "|" minus quotes. If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are ''xbmc.addon.video'', ''xbmc.addon.audio'', ''xbmc.addon.image'' and ''xbmc.addon.executable''.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other XBMC settings.
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.
|
|-
| <code>Skin.ResetSettings</code>
| Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)
|
|-
| <code>Mute</code>
| Mutes (or unmutes) the volume.
|
|-
| <code>SetVolume(percent[,showvolumebar])</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in XBMC when setting the volume.
|
|-
| <code>Dialog.Close(dialog[,force])</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
| <code>System.LogOff</code>
| Log off current user.
|
|-
| <code>System.Exec</code>
| Execute shell commands.
|
|-
| <code>System.ExecWait</code>
| Execute shell commands and freezes XBMC until shell is closed.
|
|-
| <code>Resolution</code>
| Change XBMC's Resolution.
|
|-
| <code>SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>PageDown</code>
| Send a page down event to the pagecontrol with given id.
|
|-
| <code>PageUp</code>
| Send a page up event to the pagecontrol with given id.
|
|-
| <code>Container.Refresh</code>
| Refresh current listing.
|
|-
| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
| <code>Container.NextViewMode</code>
| Select the next view mode.
|
|-
| <code>Container.PreviousViewMode</code>
| Select the previous view mode.
|
|-
| <code>Container.SetViewMode(id)</code>
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
| <code>Container.NextSortMethod</code>
| Change to the next sort method.
|
|-
| <code>Container.PreviousSortMethod</code>
| Change to the previous sort method.
|
|-
| <code>Container.SetSortMethod</code>
| Change to the specified sort method.
|
|-
| <code>Container.SortDirection</code>
| Toggle the sort direction.
|
|-
| <code>Control.Move(id,offset)</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
|
|-
| <code>Control.SetFocus(id,position)</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Alias SetFocus(id,position)
|
|-
| <code>Control.Message(id,message,[windowid])</code>
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
| <code>SendClick(windowid,id)</code>
| Sends a click to a control in a given window (or active window if omitted).
|
|-
| <code>LoadProfile(profilename,[prompt])</code>
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.
|
|-
| <code>SetProperty(key,value[,id])</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
|
|-
| <code>ClearProperty(key[,id])</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>WakeOnLan(''mac'')</code>
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).
|
|-
| <code>Addon.Default.OpenSettings</code>
| Open a settings dialog for the default addon of the given type
|
|-
| <code>Addon.Default.Set</code>
| Open a select dialog to allow choosing the default addon of the given type
|
|-
| <code>Addon.OpenSettings(id)</code>
| Open a settings dialog for the addon of the given id
|
|-
| <code>UpdateAddonRepos</code>
| Triggers a forced update of enabled add-on repositories.
|
|-
| <code>UpdateLocalAddons</code>
| Triggers a scan of local add-on directories.
|
|-
| <code>ToggleDPMS</code>
| Toggle DPMS mode manually
|
|- {{gotham row}}
| <code>CECToggleState</code>
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECActivateSource</code>
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>CECStandby</code>
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>Weather.Refresh</code>
| Force weather data refresh
|
|-
| <code>Weather.LocationNext</code>
| Switch to next weather location
|
|-
| <code>Weather.LocationPrevious</code>
| Switch to previous weather location
|
|-
| <code>Weather.LocationSet</code>
| Switch to given weather location (parameter can be 1-3)
|
|-
| <code>LIRC.Stop</code>
| Removes XBMC as a LIRC client.
|
|-
| <code>LIRC.Start</code>
| Adds XBMC as a LIRC client.
|
|-
| <code>LIRC.Send(command)</code>
| Sends a command to LIRC, syntax is the lirc protocol without the newline. Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|- {{frodo row}}
| <code>ToggleDebug</code>
| Enables/disables debug mode
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StartPVRManager</code>
| (Re)Starts the PVR manager
| {{nowrap|v12 Addition}}
|- {{frodo row}}
| <code>StopPVRManager</code>
| Stops the PVR manager
| {{nowrap|v12 Addition}}
|- {{gotham row}}
| <code>{{nowrap|StartAndroidActivity(package,[intent,dataType,dataURI])}}</code>
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousChannelGroup</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextChannelGroup</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>settingslevelchange</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>SetStereoMode</code>
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>NextStereoMode</code>
| Changes the stereo mode of the GUI to the next available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>PreviousStereoMode</code>
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>ToggleStereoMode</code>
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|- {{gotham row}}
| <code>StereoModeToMono</code>
| Toggle the stereoscopic mode to 2D.
| {{nowrap|v13 Addition}}
|}

<section end="main content" />

== Removed functions ==
* <code>LastFM.Love</code> - Removed in v13 Gotham
* <code>LastFM.Ban</code> - Removed in v13 Gotham
* <code>LCD.Suspend</code> - Removed in v13 Gotham
* <code>LCD.Resume</code> - Removed in v13 Gotham

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

HOW-TO:Modify keymaps

2014-12-16T08:22:24Z

Xhaggi: /* Reference */

{{mininav|[[Remote controls]]|page={{FULLPAGENAME}} }}

{{bigger| {{note| You can also edit keymaps from within {{kodi}} by using '''[[Add-on:Keymap Editor]]'''. }} }}

{{cleanup}}

The keyboard.xml file controls how XBMC reacts to keypresses, that is
it determines what action is mapped to what keypress. There are two
main reasons for modifying keyboard.xml:

# You want to change the standard key mappings because of a personal preference
# You are configuring a Media Center remote control that sends keypresses

You can edit keyboard.xml using any text editor such as Notepad++ in Windows or gedit/nano in Linux. The location where the file should be located after creation is in [[userdata]]

There is a more detailed discussion of the keyboard.xml file at [[Keyboard.xml]], while the remainder of this article is focussed on the gory details of editing it. 

== Introduction ==

All the keypresses that XBMC responds to, for example "{{keypress|P}}" for "play" and "{{keypress|X}}" for "stop" are configured in a file called keyboard.xml.
Actually there are two keyboard.xml files. There is the system keyboard.xml that contains all the standard key mappings, and each user optionally has their own userdata keyboard.xml that contains just their customised key mappings.

The userdata keyboard.xml only needs to contain additional key mappings, or key mappings that override the defaults in the system keyboard.xml. When XBMC is trying to decide how to respond to a keypress it first looks in the userdata keyboard.xml.
If it doesn't find a mapping for the keypress XBMC then looks in the system keyboard.xml. This means that the userdata keyboard.xml is typically quite short because it only needs to define mappings for a few keys.

You can change key mappings by editing the system keyboard.xml, but we strongly recommend you don't do this.
The system keyboard.xml is a big complicated file, and if you introduce an error into it you can break all the key mappings.
Also any changes you make risk being overwritten if you upgrade XBMC. In general you should only ever '''edit your userdata keyboard.xml'''. Even if you make a horrendous hash of this you just need to delete or rename your userdata keyboard.xml to restore the default key mappings.

User keymaps are only processed when XBMC starts up, therfore you must restart XBMC to see any changes.

== Where to find keyboard.xml ==
Keymap configuration files are stored in the "'''keymaps'''" folder in the [[userdata]] folder:
{{#lsth:userdata|Location of the UserData folder}}

== How to edit keyboard.xml ==
'''
keyboard.xml''' is just a text file so you can edit it it using any text editor e.g. in Windows use Notepad++. In Windows there is a third party keymap editor available from http://xbmcmce.sourceforge.net/, or this editor is also available through the [[Add-on:MCERemote]] add-on.

<big>'''Windows'''</big>

To use Notepad++ to edit your userdata keyboard.xml click Start then Run, or in Win7 click {{keypress|Start}} then All Programs then Accessories then Run, or press the keyboard shortcut {{keypress|Win|R}}, then when the Run dialog opens type in:

<pre>notepad++ %APPDATA%\XBMC\userdata\keymaps\keyboard.xml</pre>

* If you haven't edited your keyboard.xml before Notepad will ask "Do you want to create a new file?" and you should click '''Yes'''.

* If you have downloaded the KeyMapEdit applet from http://xbmcmce.sourceforge.net/ run it then select File/Open and double click "keyboard.xml".

* If you use the MCERemote add-on just select the "Edit keyboard.xml" option.
{{Note|that KeyMapEdit.exe isn't included in the MCERemote add-on by default (because the rules for add-ons prohibit including executable files). You need to go into the add-on settings Misc section and enable the setting "Update/install keymap editor" then select "Edit keyboard.xml".}}

<big>'''Linux'''</big>

Use your favourite text editor e.g. gedit. Remember that the .xbmc directory is hidden so you need to show hidden files to see it.

== What to put in keyboard.xml ==

This is an outline rather than a definitive guide.
For the full details see
[[Keyboard.xml]].

A keyboard.xml file will look something like:

<pre><keymap>
<global>
<keyboard>
... key mappings here
</keyboard>
</global>
<Home>
<keyboard>
... key mappings here
</keyboard>
</Home>
... and so on
</keymap></pre>

The keyboard.xml must start with <keymap> and end with </keymap>. In between are a number of sections; in the example above the first section is <global>, the second section is <Home>, and there can be lots of other sections as well.

The <global> section defines key mappings that apply everywhere in XBMC unless they are overridden by a mapping in another section. The <Home> section defines key mappings that apply only when you're at the XBMC home screen. Other sections define mappings that apply to other screens, for example the <FullScreenVideo> section defines mappings that apply when you're watching a video full screen. The easiest way to get a list of all the section names is to open the system keyboard.xml in Notepad and look through it.

The key mappings have the form:

<pre><keyname mod="modifiers">SomeAction</keyname></pre>

As with the section names, to see possible key names look at the system keyboard.xml. In fact copying and pasting from the system keyboard.xml is probably the easiest way to construct your custom keyboard.xml.

You need only only include the mod="modifiers" if you want to combine the key with a keyboard modifer like control, {{keypress|shift}} or {{keypress|alt}}.
For example:
<pre><d>Notification(Keypress, You pressed D!, 3)</d></pre>

configures the {{keypress|D}} key to execute the action Notification(Keypress, You pressed D!, 3)
while:

<pre><d mod="ctrl,alt">Notification(Keypress, You pressed ctrl-alt-D!, 3)</d></pre>

configures a {{keypress|control|alt|D}} keypress to execute the action. Incidentally the Notification action displays a little message at the bottom right of the screen. This can be useful for testing your key mappings.

== An example ==

This example is going to be a bit contrived, but after all it's only intended as an example of how you might make some more useful key mapping.

Media Center remote controls usually have a button labelled {{button|Guide}}, and when you press it this button usually sends a {{keypress|control|G}} keystroke.
In this example we'll configure the Guide button to display the Info screen except when playing a video, when we'll configure it to show the OSD ('''O'''n '''S'''creen '''D'''isplay).
So lets start by defining a global mapping for {{keypress|control|G}} to display Info:

<pre><keymap>
<global>
<keyboard>
<g mod="ctrl">Info</g>
</keyboard>
</global>
</keymap></pre>

From the previous section it should be obvious what this key mapping does so I won't dwell on it further. If you create a userdata keyboard.xml with this mapping and run XBMC you should find that whenever you press {{keypress|control|G}} it displays the Info screen.

However this will make {{keypress|control|G}} display Info when playing a video, and we want it to display the OSD instead. To achieve this modify the keyboard.xml to:

<pre><keymap>
<global>
<keyboard>
<g mod="ctrl">Info</g>
</keyboard>
</global>
<FullScreenVideo>
<keyboard>
<g mod="ctrl">OSD</g>
</keyboard>
</FullScreenVideo>
</keymap></pre>

The global action for {{keypress|control|G}} is still Info, but the <FullScreenVideo> section overrides the global mapping when playing a video and configures {{keypress|control|G}} to display the OSD instead.

== Debugging ==

It's easy to make mistakes when writing a keyboard.xml file, and if XBMC finds an error in your keyboard.xml it will simply stop processing it, leaving you wondering why your key mappings aren't
working. To check for errors in your keyboard.xml turn debug logging on (in the Settings screen go into System then Debugging and enable the '''Enable debug logging option'''), then close XBMC then start it and close it again. Now look in %APPDATA%\XBMC and you'll find a file called xbmc.log. Open this file in Notepad and you should be able to find the error.

For example, take the keymapping above but suppose I mistype:

<pre><g mod="ctrl">Info</g></pre>

as

<pre><g mod="ctrl">Info</></pre>

that is I missed the "{{keypress|g}}" in </g>. If I run XBMC and then look at xbmc.log I find:

<pre> INFO: Loading special://masterprofile/keymaps/keyboard.xml
ERROR: Error loading keymap: special://masterprofile/keymaps/keyboard.xml, Line 4
Error reading end tag.</pre>

Finally, the Notification action can useful when you're testing your key mappings as it displays a little message at the bottom right of the screen to confirm XBMC has processed the keystroke. A typical example
would be:

<pre><g mod="ctrl">Notification(This is the title, This is the message, 3)</g></pre>

and the last argument, 3, is the number of seconds to display the message.

== Reference ==

The ultimate reference for the possible keynames and actions is the XBMC source code and in particular the source file ButtonTranslator.cpp, which you can find at https://github.com/xbmc/xbmc/blob/master/src/input/ButtonTranslator.cpp

For the key names look for the function CButtonTranslator::TranslateKeyboardString.

For the actions look for "static const ActionMapping actions[]".

For the sections look for "static const ActionMapping windows[]".

Finally, there are four key modifiers you can use in key mappings:

<ul>
<li>{{keypress|ctrl}} or {{keypress|control}}</li>
<li>{{keypress|shift}}</li>
<li>{{keypress|alt}}</li>
<li>{{keypress|win}} or {{keypress|super}} (the Windows key)</li>
</ul>

{{note|The {{keypress|shift}} modifier can't be used alone. This is because XBMC isn't case sensitive when processing keystrokes, i.e. a {{keypress|'''g'''}}is the same as a {{keypress|'''G'''}}.}}

[[Category:Remotes]]
[[Category:How-to]]
[[Category:Manual]]

Window IDs

2014-10-12T07:08:47Z

Xhaggi:

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Python development|Skinning}}
{{helix}}
<section begin="main content" />
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].

* [[keymap.xml]] uses the Window name.
* XBMC's C++ code uses the Window definitions and Window ID's.
* skin .xml files use the Delta Window ID's
* XBMC.ActivateWindow() can use either the Window name, the Window ID, or the delta Window ID.
* sounds.xml can use the window name or window ID 

'''You can use secondary parameters with all media windows, as can be seen here:'''
* [[Opening Windows and Dialogs]] 
'''Example:'''
* You want a button in your skin or on your remote taking you directly to the movie listing you let that button do

ActivateWindow(Videos,MovieTitles) (v11 Eden and up)

{| class="prettytable"
|-
! Name !! Definition !! Window ID !! Delta window ID !! source XML file
|-
| <code>home</code>
| <code>WINDOW_HOME</code>
| <code>10000</code>
| <code>0</code>
| Home.xml
|-
| <code>programs</code>
| <code>WINDOW_PROGRAMS</code>
| <code>10001</code>
| <code>1</code>
| MyPrograms.xml
|-
| <code>pictures</code>
| <code>WINDOW_PICTURES</code>
| <code>10002</code>
| <code>2</code>
| MyPics.xml
|-
| <code>filemanager</code>
| <code>WINDOW_FILES</code>
| <code>10003</code>
| <code>3</code>
| FileManager.xml
|-
| <code>settings</code>
| <code>WINDOW_SETTINGS_MENU</code>
| <code>10004</code>
| <code>4</code>
| Settings.xml
|-
| <code>music</code>
| <code>WINDOW_MUSIC</code>
| <code>10005</code>
| <code>5</code>
| None – this is just a wrapper for the current My Music view (who's IDs are 501 and 502)
|-
| <code>video</code>
| <code>WINDOW_VIDEOS</code>
| <code>10006</code>
| <code>6</code>
| None – this is just a wrapper for the current My Video view (who's IDs are 21-25)
|-
| <code>systeminfo</code>
| <code>WINDOW_SYSTEM_INFORMATION</code>
| <code>10007</code>
| <code>7</code>
| SettingsSystemInfo.xml
|-
| <code>screencalibration</code>
| <code>WINDOW_MOVIE_CALIBRATION</code>
| <code>10011</code>
| <code>11</code>
| SettingsScreenCalibration.xml
|-
| <code>picturessettings</code>
| <code>WINDOW_SETTINGS_MYPICTURES</code>
| <code>10012</code>
| <code>12</code>
| SettingsCategory.xml
|-
| <code>programssettings</code>
| <code>WINDOW_SETTINGS_MYPROGRAMS</code>
| <code>10013</code>
| <code>13</code>
| SettingsCategory.xml
|-
| <code>weathersettings</code>
| <code>WINDOW_SETTINGS_MYWEATHER</code>
| <code>10014</code>
| <code>14</code>
| SettingsCategory.xml
|-
| <code>musicsettings</code>
| <code>WINDOW_SETTINGS_MYMUSIC</code>
| <code>10015</code>
| <code>15</code>
| SettingsCategory.xml
|-
| <code>systemsettings</code>
| <code>WINDOW_SETTINGS_SYSTEM</code>
| <code>10016</code>
| <code>16</code>
| SettingsCategory.xml
|-
| <code>videossettings</code>
| <code>WINDOW_SETTINGS_MYVIDEOS</code>
| <code>10017</code>
| <code>17</code>
| SettingsCategory.xml
|- {{frodo row}}
| <code>servicesettings</code>
| <code>WINDOW_SETTINGS_SERVICE</code>
| <code>10018</code>
| <code>18</code>
| SettingsCategory.xml '''(Frodo addition)'''
|-
| <code>appearancesettings</code>
| <code>WINDOW_SETTINGS_APPEARANCE</code>
| <code>10019</code>
| <code>19</code>
| SettingsCategory.xml
|-
| <code>scripts</code>
| <code>WINDOW_SCRIPTS</code>
| <code>10020</code>
| <code>20</code>
| MyScripts.xml
|-
| <code>videolibrary</code>
| <code>WINDOW_VIDEO_NAV</code>
| <code>10025</code>
| <code>25</code>
| MyVideoNav.xml - Replaces the following .XML files: MyVideoGenre (WINDOW_VIDEO_GENRE), MyVideoActors (WINDOW_VIDEO_ACTOR), MyVideoYear (WINDOW_VIDEO_YEAR), MyVideoTitle (WINDOW_VIDEO_TITLE)
|-
| <code>videoplaylist</code>
| <code>WINDOW_VIDEO_PLAYLIST</code>
| <code>10028</code>
| <code>28</code>
| MyVideoPlaylist.xml
|-
| <code>loginscreen</code>
| <code>WINDOW_LOGINSCREEN</code>
| <code>10029</code>
| <code>29</code>
| LoginScreen.xml
|-
| <code>profiles</code>
| <code>WINDOW_SETTINGS_PROFILES</code>
| <code>10034</code>
| <code>34</code>
| SettingsProfile.xml
|-
| <code>addonbrowser</code>
| <code>WINDOW_ADDON_BROWSER</code>
| <code>10040</code>
| <code>40</code>
| AddonBrowser.xml
|-
| <code>yesnodialog</code>
| <code>WINDOW_DIALOG_YES_NO</code>
| <code>10100</code>
| <code>100</code>
| DialogYesNo.xml
|-
| <code>progressdialog</code>
| <code>WINDOW_DIALOG_PROGRESS</code>
| <code>10101</code>
| <code>101</code>
| DialogProgress.xml
|-
| <code>virtualkeyboard</code>
| <code>WINDOW_DIALOG_KEYBOARD</code>
| <code>10103</code>
| <code>103</code>
| DialogKeyboard.xml
|-
| <code>volumebar</code>
| <code>WINDOW_DIALOG_VOLUME_BAR</code>
| <code>10104</code>
| <code>104</code>
| DialogVolumeBar.xml
|-
| <code>contextmenu</code>
| <code>WINDOW_DIALOG_CONTEXT_MENU</code>
| <code>10106</code>
| <code>106</code>
| DialogContextMenu.xml
|-
| <code>infodialog</code>
| <code>WINDOW_DIALOG_KAI_TOAST</code>
| <code>10107</code>
| <code>107</code>
| DialogKaiToast.xml
|-
| <code>numericinput</code>
| <code>WINDOW_DIALOG_NUMERIC</code>
| <code>10109</code>
| <code>109</code>
| DialogNumeric.xml
|-
| <code>shutdownmenu</code>
| <code>WINDOW_DIALOG_BUTTON_MENU</code>
| <code>10111</code>
| <code>111</code>
| DialogButtonMenu.xml
|-
| <code>mutebug</code>
| <code>WINDOW_DIALOG_MUTE_BUG</code>
| <code>10113</code>
| <code>113</code>
| DialogMuteBug.xml
|-
| <code>playercontrols</code>
| <code>WINDOW_DIALOG_PLAYER_CONTROLS</code>
| <code>10114</code>
| <code>114</code>
| PlayerControls.xml
|-
| <code>seekbar</code>
| <code>WINDOW_DIALOG_SEEK_BAR</code>
| <code>10115</code>
| <code>115</code>
| DialogSeekBar.xml
|-
| <code>musicosd</code>
| <code>WINDOW_DIALOG_MUSIC_OSD</code>
| <code>10120</code>
| <code>120</code>
| MusicOSD.xml
|-
| <code>visualisationpresetlist</code>
| <code>WINDOW_DIALOG_VIS_PRESET_LIST</code>
| <code>10122</code>
| <code>122</code>
| VisualizationPresetList.xml
|-
| <code>osdvideosettings</code>
| <code>WINDOW_DIALOG_VIDEO_OSD_SETTINGS</code>
| <code>10123</code>
| <code>123</code>
| VideoOSDSettings.xml
|-
| <code>osdaudiosettings</code>
| <code>WINDOW_DIALOG_AUDIO_OSD_SETTINGS</code>
| <code>10124</code>
| <code>124</code>
| VideoOSDSettings.xml
|-
| <code>videobookmarks</code>
| <code>WINDOW_DIALOG_VIDEO_BOOKMARKS</code>
| <code>10125</code>
| <code>125</code>
| VideoOSDBookmarks.xml
|-
| <code>filebrowser</code>
| <code>WINDOW_DIALOG_FILE_BROWSER</code>
| <code>10126</code>
| <code>126</code>
| FileBrowser.xml
|-
| <code>networksetup</code>
| <code>WINDOW_DIALOG_NETWORK_SETUP</code>
| <code>10128</code>
| <code>128</code>
| DialogNetworkSetup.xml
|-
| <code>mediasource</code>
| <code>WINDOW_DIALOG_MEDIA_SOURCE</code>
| <code>10129</code>
| <code>129</code>
| DialogMediaSource.xml
|-
| <code>profilesettings</code>
| <code>WINDOW_PROFILE_SETTINGS</code>
| <code>10130</code>
| <code>130</code>
| ProfileSettings.xml
|-
| <code>locksettings</code>
| <code>WINDOW_LOCK_SETTINGS</code>
| <code>10131</code>
| <code>131</code>
| LockSettings.xml
|-
| <code>contentsettings</code>
| <code>WINDOW_DIALOG_CONTENT_SETTINGS</code>
| <code>10132</code>
| <code>132</code>
| DialogContentSettings.xml
|-
| <code>favourites</code>
| <code>WINDOW_DIALOG_FAVOURITES</code>
| <code>10134</code>
| <code>134</code>
| DialogFavourites.xml
|-
| <code>songinformation</code>
| <code>WINDOW_DIALOG_SONG_INFO</code>
| <code>10135</code>
| <code>135</code>
| DialogSongInfo.xml
|-
| <code>smartplaylisteditor</code>
| <code>WINDOW_DIALOG_SMART_PLAYLIST_EDITOR</code>
| <code>10136</code>
| <code>136</code>
| SmartPlaylistEditor.xml
|-
| <code>smartplaylistrule</code>
| <code>WINDOW_DIALOG_SMART_PLAYLIST_RULE</code>
| <code>10137</code>
| <code>137</code>
| SmartPlaylistRule.xml
|-
| <code>busydialog</code>
| <code>WINDOW_DIALOG_BUSY</code>
| <code>10138</code>
| <code>138</code>
| DialogBusy.xml
|-
| <code>pictureinfo</code>
| <code>WINDOW_DIALOG_PICTURE_INFO</code>
| <code>10139</code>
| <code>139</code>
| DialogPictureInfo.xml
|-
| <code>addonsettings</code>
| <code>WINDOW_DIALOG_ADDON_SETTINGS</code>
| <code>10140</code>
| <code>140</code>
| DialogAddonSettings.xml
|-
| <code>accesspoints</code>
| <code>WINDOW_DIALOG_ACCESS_POINTS</code>
| <code>10141</code>
| <code>141</code>
| DialogAccessPoints.xml
|-
| <code>fullscreeninfo</code>
| <code>WINDOW_DIALOG_FULLSCREEN_INFO</code>
| <code>10142</code>
| <code>142</code>
| DialogFullScreenInfo.xml
|-
| <code>karaokeselector</code>
| <code>WINDOW_DIALOG_KARAOKE_SONGSELECT</code>
| <code>10143</code>
| <code>143</code>
| DialogKaraokeSongSelector.xml
|-
| <code>karaokelargeselector</code>
| <code>WINDOW_DIALOG_KARAOKE_SELECTOR</code>
| <code>10144</code>
| <code>144</code>
| DialogKaraokeSongSelectorLarge.xml
|-
| <code>sliderdialog</code>
| <code>WINDOW_DIALOG_SLIDER</code>
| <code>10145</code>
| <code>145</code>
| DialogSlider.xml
|-
| <code>addoninformation</code>
| <code>WINDOW_DIALOG_ADDON_INFO</code>
| <code>10146</code>
| <code>146</code>
| DialogAddonInfo.xml
|-
| <code>textviewer</code>
| <code>WINDOW_DIALOG_TEXT_VIEWER</code>
| <code>10147</code>
| <code>147</code>
| DialogTextViewer.xml
|-
| <code>peripherals</code>
| <code>WINDOW_DIALOG_PERIPHERAL_MANAGER</code>
| <code>10149</code>
| <code>149</code>
| DialogPeripheralManager.xml
|-
| <code>peripheralsettings</code>
| <code>WINDOW_DIALOG_PERIPHERAL_SETTINGS</code>
| <code>10150</code>
| <code>150</code>
| DialogPeripheralSettings.xml
|-
| <code>extendedprogressdialog</code>
| <code>WINDOW_DIALOG_EXT_PROGRESS</code>
| <code>10151</code>
| <code>151</code>
| DialogExtendedProgressBar.xml
|- {{frodo row}}
| <code>mediafilter</code>
| <code>WINDOW_DIALOG_MEDIA_FILTER</code>
| <code>10152</code>
| <code>152</code>
| DialogMediaFilter.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{Gotham row}}
| <code>subtitlesearch</code>
| <code>WINDOW_DIALOG_SUBTITLES</code>
| <code>10153</code>
| <code>153</code>
| DialogSubtitles.xml '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>musicplaylist</code>
| <code>WINDOW_MUSIC_PLAYLIST</code>
| <code>10500</code>
| <code>500</code>
| MyMusicPlaylist.xml
|-
| <code>musicfiles</code>
| <code>WINDOW_MUSIC_FILES</code>
| <code>10501</code>
| <code>501</code>
| MyMusicSongs.xml
|-
| <code>musiclibrary</code>
| <code>WINDOW_MUSIC_NAV</code>
| <code>10502</code>
| <code>502</code>
| MyMusicNav.xml
|-
| <code>musicplaylisteditor</code>
| <code>WINDOW_MUSIC_PLAYLIST_EDITOR</code>
| <code>10503</code>
| <code>503</code>
| MyMusicPlaylistEditor.xml
|- {{frodo row}}
| <code>pvr</code>
| <code>WINDOW_PVR</code>
| <code>10601</code>
| <code>601</code>
| MyPVR.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{helix row}}
| <code>tvchannels</code>
| <code>WINDOW_TV_CHANNELS</code>
| <code>10615</code>
| <code>615</code>
| MyPVRChannels.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvrecordings</code>
| <code>WINDOW_TV_RECORDINGS</code>
| <code>10616</code>
| <code>616</code>
| MyPVRRecordings.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvguide</code>
| <code>WINDOW_TV_GUIDE</code>
| <code>10617</code>
| <code>617</code>
| MyPVRGuide.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvtimers</code>
| <code>WINDOW_TV_TIMERS</code>
| <code>10618</code>
| <code>618</code>
| MyPVRTimers.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvsearch</code>
| <code>WINDOW_TV_SEARCH</code>
| <code>10619</code>
| <code>619</code>
| MyPVRSearch.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiochannels</code>
| <code>WINDOW_RADIO_CHANNELS</code>
| <code>10620</code>
| <code>620</code>
| MyPVRChannels.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiorecordings</code>
| <code>WINDOW_RADIO_RECORDINGS</code>
| <code>10621</code>
| <code>621</code>
| MyPVRRecordings.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radioguide</code>
| <code>WINDOW_RADIO_GUIDE</code>
| <code>10622</code>
| <code>622</code>
| MyPVRGuide.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiotimers</code>
| <code>WINDOW_RADIO_TIMERS</code>
| <code>10623</code>
| <code>623</code>
| MyPVRTimers.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiosearch</code>
| <code>WINDOW_RADIO_SEARCH</code>
| <code>10624</code>
| <code>624</code>
| MyPVRSearch.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{frodo row}}
| <code>pvrguideinfo</code>
| <code>WINDOW_DIALOG_PVR_GUIDE_INFO</code>
| <code>10602</code>
| <code>602</code>
| DialogPVRGuideInfo.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrrecordinginfo</code>
| <code>WINDOW_DIALOG_PVR_RECORDING_INFO</code>
| <code>10603</code>
| <code>603</code>
| DialogPVRRecordingInfo.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrtimersetting</code>
| <code>WINDOW_DIALOG_PVR_TIMER_SETTING</code>
| <code>10604</code>
| <code>604</code>
| DialogPVRTimerSettings.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrgroupmanager</code>
| <code>WINDOW_DIALOG_PVR_GROUP_MANAGER</code>
| <code>10605</code>
| <code>605</code>
| DialogPVRGroupManager.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrchannelmanager</code>
| <code>WINDOW_DIALOG_PVR_CHANNEL_MANAGER</code>
| <code>10606</code>
| <code>606</code>
| DialogPVRChannelManager.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrguidesearch</code>
| <code>WINDOW_DIALOG_PVR_GUIDE_SEARCH</code>
| <code>10607</code>
| <code>607</code>
| DialogPVRGuideSearch.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrosdchannels</code>
| <code>WINDOW_DIALOG_PVR_OSD_CHANNELS</code>
| <code>10610</code>
| <code>610</code>
| DialogPVRChannelsOSD.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrosdguide</code>
| <code>WINDOW_DIALOG_PVR_OSD_GUIDE</code>
| <code>10611</code>
| <code>611</code>
| DialogPVRGuideOSD.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>virtualkeyboard</code>
| <code>WINDOW_VIRTUAL_KEYBOARD</code>
| <code>11000</code>
| <code>1000</code>
| none
|-
| <code>selectdialog</code>
| <code>WINDOW_DIALOG_SELECT</code>
| <code>12000</code>
| <code>2000</code>
| DialogSelect.xml
|-
| <code>musicinformation</code>
| <code>WINDOW_MUSIC_INFO</code>
| <code>12001</code>
| <code>2001</code>
| DialogAlbumInfo.xml
|-
| <code>okdialog</code>
| <code>WINDOW_DIALOG_OK</code>
| <code>12002</code>
| <code>2002</code>
| DialogOK.xml
|-
| <code>movieinformation</code>
| <code>WINDOW_VIDEO_INFO</code>
| <code>12003</code>
| <code>2003</code>
| DialogVideoInfo.xml
|-
| <code>fullscreenvideo</code>
| <code>WINDOW_FULLSCREEN_VIDEO</code>
| <code>12005</code>
| <code>2005</code>
| VideoFullScreen.xml
|-
| <code>visualisation</code>
| <code>WINDOW_VISUALISATION</code>
| <code>12006</code>
| <code>2006</code>
| MusicVisualisation.xml
|-
| <code>slideshow</code>
| <code>WINDOW_SLIDESHOW</code>
| <code>12007</code>
| <code>2007</code>
| SlideShow.xml
|-
| <code>filestackingdialog</code>
| <code>WINDOW_DIALOG_FILESTACKING</code>
| <code>12008</code>
| <code>2008</code>
| DialogFileStacking.xml
|-
| <code>karaoke</code>
| <code>WINDOW_KARAOKELYRICS</code>
| <code>12009</code>
| <code>2009</code>
| MusicKaraokeLyrics.xml
|-
| <code>weather</code>
| <code>WINDOW_WEATHER</code>
| <code>12600</code>
| <code>2600</code>
| MyWeather.xml
|-
| <code>screensaver</code>
| <code>WINDOW_SCREENSAVER</code>
| <code>12900</code>
| <code>2900</code>
| none
|-
| <code>videoosd</code>
| <code>WINDOW_OSD</code>
| <code>12901</code>
| <code>2901</code>
| VideoOSD.xml
|-
| <code>videomenu</code>
| <code>WINDOW_MEDIA_MENU</code>
| <code>12902</code>
| <code>2902</code>
| none
|-
| <code>startup</code>
| <code>WINDOW_STARTUP_ANIM</code>
| <code>12999</code>
| <code>2999</code>
| startup.xml
|- {{frodo row}}
| <code>skinsettings</code>
| <code>-</code>
| <code>-</code>
| <code>-</code>
| SkinSettings.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>startwindow</code>
| <code>-</code>
| <code>-</code>
| <code>-</code>
| shortcut to the current startwindow
|-
| 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)
|-
| <code>pointer</code>
| <code>- </code>
| <code>- </code>
| <code>105 </code>
| Pointer.xml
|-
| <code>musicoverlay</code>
| <code>WINDOW_MUSIC_OVERLAY</code>
| <code>12903</code>
| <code>2903</code>
| MusicOverlay.xml
|-
| <code>videooverlay</code>
| <code>WINDOW_VIDEO_OVERLAY</code>
| <code>12904</code>
| <code>2904</code>
| VideoOverlay.xml
|-
| <code>Python Windows </code>
| <code>- </code>
| <code>- </code>
| <code>3000–3099 </code>
| none
|}
<section end="main content" />
== Removed window IDs ==
* <code>networksettings</code> - Removed in v12 Frodo
* <code>musicscan</code> - Removed in v12 Frodo
* <code>videoscan</code> - Removed in v12 Frodo
* <code>videofiles</code> - Removed in v13 Gotham
* <code>pvr</code> - Removed in v14 Helix

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

Window IDs

2014-10-12T07:06:08Z

Xhaggi:

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Python development|Skinning}}
<section begin="main content" />
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].

* [[keymap.xml]] uses the Window name.
* XBMC's C++ code uses the Window definitions and Window ID's.
* skin .xml files use the Delta Window ID's
* XBMC.ActivateWindow() can use either the Window name, the Window ID, or the delta Window ID.
* sounds.xml can use the window name or window ID 

'''You can use secondary parameters with all media windows, as can be seen here:'''
* [[Opening Windows and Dialogs]] 
'''Example:'''
* You want a button in your skin or on your remote taking you directly to the movie listing you let that button do

ActivateWindow(Videos,MovieTitles) (v11 Eden and up)

{| class="prettytable"
|-
! Name !! Definition !! Window ID !! Delta window ID !! source XML file
|-
| <code>home</code>
| <code>WINDOW_HOME</code>
| <code>10000</code>
| <code>0</code>
| Home.xml
|-
| <code>programs</code>
| <code>WINDOW_PROGRAMS</code>
| <code>10001</code>
| <code>1</code>
| MyPrograms.xml
|-
| <code>pictures</code>
| <code>WINDOW_PICTURES</code>
| <code>10002</code>
| <code>2</code>
| MyPics.xml
|-
| <code>filemanager</code>
| <code>WINDOW_FILES</code>
| <code>10003</code>
| <code>3</code>
| FileManager.xml
|-
| <code>settings</code>
| <code>WINDOW_SETTINGS_MENU</code>
| <code>10004</code>
| <code>4</code>
| Settings.xml
|-
| <code>music</code>
| <code>WINDOW_MUSIC</code>
| <code>10005</code>
| <code>5</code>
| None – this is just a wrapper for the current My Music view (who's IDs are 501 and 502)
|-
| <code>video</code>
| <code>WINDOW_VIDEOS</code>
| <code>10006</code>
| <code>6</code>
| None – this is just a wrapper for the current My Video view (who's IDs are 21-25)
|-
| <code>systeminfo</code>
| <code>WINDOW_SYSTEM_INFORMATION</code>
| <code>10007</code>
| <code>7</code>
| SettingsSystemInfo.xml
|-
| <code>screencalibration</code>
| <code>WINDOW_MOVIE_CALIBRATION</code>
| <code>10011</code>
| <code>11</code>
| SettingsScreenCalibration.xml
|-
| <code>picturessettings</code>
| <code>WINDOW_SETTINGS_MYPICTURES</code>
| <code>10012</code>
| <code>12</code>
| SettingsCategory.xml
|-
| <code>programssettings</code>
| <code>WINDOW_SETTINGS_MYPROGRAMS</code>
| <code>10013</code>
| <code>13</code>
| SettingsCategory.xml
|-
| <code>weathersettings</code>
| <code>WINDOW_SETTINGS_MYWEATHER</code>
| <code>10014</code>
| <code>14</code>
| SettingsCategory.xml
|-
| <code>musicsettings</code>
| <code>WINDOW_SETTINGS_MYMUSIC</code>
| <code>10015</code>
| <code>15</code>
| SettingsCategory.xml
|-
| <code>systemsettings</code>
| <code>WINDOW_SETTINGS_SYSTEM</code>
| <code>10016</code>
| <code>16</code>
| SettingsCategory.xml
|-
| <code>videossettings</code>
| <code>WINDOW_SETTINGS_MYVIDEOS</code>
| <code>10017</code>
| <code>17</code>
| SettingsCategory.xml
|- {{frodo row}}
| <code>servicesettings</code>
| <code>WINDOW_SETTINGS_SERVICE</code>
| <code>10018</code>
| <code>18</code>
| SettingsCategory.xml '''(Frodo addition)'''
|-
| <code>appearancesettings</code>
| <code>WINDOW_SETTINGS_APPEARANCE</code>
| <code>10019</code>
| <code>19</code>
| SettingsCategory.xml
|-
| <code>scripts</code>
| <code>WINDOW_SCRIPTS</code>
| <code>10020</code>
| <code>20</code>
| MyScripts.xml
|-
| <code>videolibrary</code>
| <code>WINDOW_VIDEO_NAV</code>
| <code>10025</code>
| <code>25</code>
| MyVideoNav.xml - Replaces the following .XML files: MyVideoGenre (WINDOW_VIDEO_GENRE), MyVideoActors (WINDOW_VIDEO_ACTOR), MyVideoYear (WINDOW_VIDEO_YEAR), MyVideoTitle (WINDOW_VIDEO_TITLE)
|-
| <code>videoplaylist</code>
| <code>WINDOW_VIDEO_PLAYLIST</code>
| <code>10028</code>
| <code>28</code>
| MyVideoPlaylist.xml
|-
| <code>loginscreen</code>
| <code>WINDOW_LOGINSCREEN</code>
| <code>10029</code>
| <code>29</code>
| LoginScreen.xml
|-
| <code>profiles</code>
| <code>WINDOW_SETTINGS_PROFILES</code>
| <code>10034</code>
| <code>34</code>
| SettingsProfile.xml
|-
| <code>addonbrowser</code>
| <code>WINDOW_ADDON_BROWSER</code>
| <code>10040</code>
| <code>40</code>
| AddonBrowser.xml
|-
| <code>yesnodialog</code>
| <code>WINDOW_DIALOG_YES_NO</code>
| <code>10100</code>
| <code>100</code>
| DialogYesNo.xml
|-
| <code>progressdialog</code>
| <code>WINDOW_DIALOG_PROGRESS</code>
| <code>10101</code>
| <code>101</code>
| DialogProgress.xml
|-
| <code>virtualkeyboard</code>
| <code>WINDOW_DIALOG_KEYBOARD</code>
| <code>10103</code>
| <code>103</code>
| DialogKeyboard.xml
|-
| <code>volumebar</code>
| <code>WINDOW_DIALOG_VOLUME_BAR</code>
| <code>10104</code>
| <code>104</code>
| DialogVolumeBar.xml
|-
| <code>contextmenu</code>
| <code>WINDOW_DIALOG_CONTEXT_MENU</code>
| <code>10106</code>
| <code>106</code>
| DialogContextMenu.xml
|-
| <code>infodialog</code>
| <code>WINDOW_DIALOG_KAI_TOAST</code>
| <code>10107</code>
| <code>107</code>
| DialogKaiToast.xml
|-
| <code>numericinput</code>
| <code>WINDOW_DIALOG_NUMERIC</code>
| <code>10109</code>
| <code>109</code>
| DialogNumeric.xml
|-
| <code>shutdownmenu</code>
| <code>WINDOW_DIALOG_BUTTON_MENU</code>
| <code>10111</code>
| <code>111</code>
| DialogButtonMenu.xml
|-
| <code>mutebug</code>
| <code>WINDOW_DIALOG_MUTE_BUG</code>
| <code>10113</code>
| <code>113</code>
| DialogMuteBug.xml
|-
| <code>playercontrols</code>
| <code>WINDOW_DIALOG_PLAYER_CONTROLS</code>
| <code>10114</code>
| <code>114</code>
| PlayerControls.xml
|-
| <code>seekbar</code>
| <code>WINDOW_DIALOG_SEEK_BAR</code>
| <code>10115</code>
| <code>115</code>
| DialogSeekBar.xml
|-
| <code>musicosd</code>
| <code>WINDOW_DIALOG_MUSIC_OSD</code>
| <code>10120</code>
| <code>120</code>
| MusicOSD.xml
|-
| <code>visualisationpresetlist</code>
| <code>WINDOW_DIALOG_VIS_PRESET_LIST</code>
| <code>10122</code>
| <code>122</code>
| VisualizationPresetList.xml
|-
| <code>osdvideosettings</code>
| <code>WINDOW_DIALOG_VIDEO_OSD_SETTINGS</code>
| <code>10123</code>
| <code>123</code>
| VideoOSDSettings.xml
|-
| <code>osdaudiosettings</code>
| <code>WINDOW_DIALOG_AUDIO_OSD_SETTINGS</code>
| <code>10124</code>
| <code>124</code>
| VideoOSDSettings.xml
|-
| <code>videobookmarks</code>
| <code>WINDOW_DIALOG_VIDEO_BOOKMARKS</code>
| <code>10125</code>
| <code>125</code>
| VideoOSDBookmarks.xml
|-
| <code>filebrowser</code>
| <code>WINDOW_DIALOG_FILE_BROWSER</code>
| <code>10126</code>
| <code>126</code>
| FileBrowser.xml
|-
| <code>networksetup</code>
| <code>WINDOW_DIALOG_NETWORK_SETUP</code>
| <code>10128</code>
| <code>128</code>
| DialogNetworkSetup.xml
|-
| <code>mediasource</code>
| <code>WINDOW_DIALOG_MEDIA_SOURCE</code>
| <code>10129</code>
| <code>129</code>
| DialogMediaSource.xml
|-
| <code>profilesettings</code>
| <code>WINDOW_PROFILE_SETTINGS</code>
| <code>10130</code>
| <code>130</code>
| ProfileSettings.xml
|-
| <code>locksettings</code>
| <code>WINDOW_LOCK_SETTINGS</code>
| <code>10131</code>
| <code>131</code>
| LockSettings.xml
|-
| <code>contentsettings</code>
| <code>WINDOW_DIALOG_CONTENT_SETTINGS</code>
| <code>10132</code>
| <code>132</code>
| DialogContentSettings.xml
|-
| <code>favourites</code>
| <code>WINDOW_DIALOG_FAVOURITES</code>
| <code>10134</code>
| <code>134</code>
| DialogFavourites.xml
|-
| <code>songinformation</code>
| <code>WINDOW_DIALOG_SONG_INFO</code>
| <code>10135</code>
| <code>135</code>
| DialogSongInfo.xml
|-
| <code>smartplaylisteditor</code>
| <code>WINDOW_DIALOG_SMART_PLAYLIST_EDITOR</code>
| <code>10136</code>
| <code>136</code>
| SmartPlaylistEditor.xml
|-
| <code>smartplaylistrule</code>
| <code>WINDOW_DIALOG_SMART_PLAYLIST_RULE</code>
| <code>10137</code>
| <code>137</code>
| SmartPlaylistRule.xml
|-
| <code>busydialog</code>
| <code>WINDOW_DIALOG_BUSY</code>
| <code>10138</code>
| <code>138</code>
| DialogBusy.xml
|-
| <code>pictureinfo</code>
| <code>WINDOW_DIALOG_PICTURE_INFO</code>
| <code>10139</code>
| <code>139</code>
| DialogPictureInfo.xml
|-
| <code>addonsettings</code>
| <code>WINDOW_DIALOG_ADDON_SETTINGS</code>
| <code>10140</code>
| <code>140</code>
| DialogAddonSettings.xml
|-
| <code>accesspoints</code>
| <code>WINDOW_DIALOG_ACCESS_POINTS</code>
| <code>10141</code>
| <code>141</code>
| DialogAccessPoints.xml
|-
| <code>fullscreeninfo</code>
| <code>WINDOW_DIALOG_FULLSCREEN_INFO</code>
| <code>10142</code>
| <code>142</code>
| DialogFullScreenInfo.xml
|-
| <code>karaokeselector</code>
| <code>WINDOW_DIALOG_KARAOKE_SONGSELECT</code>
| <code>10143</code>
| <code>143</code>
| DialogKaraokeSongSelector.xml
|-
| <code>karaokelargeselector</code>
| <code>WINDOW_DIALOG_KARAOKE_SELECTOR</code>
| <code>10144</code>
| <code>144</code>
| DialogKaraokeSongSelectorLarge.xml
|-
| <code>sliderdialog</code>
| <code>WINDOW_DIALOG_SLIDER</code>
| <code>10145</code>
| <code>145</code>
| DialogSlider.xml
|-
| <code>addoninformation</code>
| <code>WINDOW_DIALOG_ADDON_INFO</code>
| <code>10146</code>
| <code>146</code>
| DialogAddonInfo.xml
|-
| <code>textviewer</code>
| <code>WINDOW_DIALOG_TEXT_VIEWER</code>
| <code>10147</code>
| <code>147</code>
| DialogTextViewer.xml
|-
| <code>peripherals</code>
| <code>WINDOW_DIALOG_PERIPHERAL_MANAGER</code>
| <code>10149</code>
| <code>149</code>
| DialogPeripheralManager.xml
|-
| <code>peripheralsettings</code>
| <code>WINDOW_DIALOG_PERIPHERAL_SETTINGS</code>
| <code>10150</code>
| <code>150</code>
| DialogPeripheralSettings.xml
|-
| <code>extendedprogressdialog</code>
| <code>WINDOW_DIALOG_EXT_PROGRESS</code>
| <code>10151</code>
| <code>151</code>
| DialogExtendedProgressBar.xml
|- {{frodo row}}
| <code>mediafilter</code>
| <code>WINDOW_DIALOG_MEDIA_FILTER</code>
| <code>10152</code>
| <code>152</code>
| DialogMediaFilter.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{Gotham row}}
| <code>subtitlesearch</code>
| <code>WINDOW_DIALOG_SUBTITLES</code>
| <code>10153</code>
| <code>153</code>
| DialogSubtitles.xml '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>musicplaylist</code>
| <code>WINDOW_MUSIC_PLAYLIST</code>
| <code>10500</code>
| <code>500</code>
| MyMusicPlaylist.xml
|-
| <code>musicfiles</code>
| <code>WINDOW_MUSIC_FILES</code>
| <code>10501</code>
| <code>501</code>
| MyMusicSongs.xml
|-
| <code>musiclibrary</code>
| <code>WINDOW_MUSIC_NAV</code>
| <code>10502</code>
| <code>502</code>
| MyMusicNav.xml
|-
| <code>musicplaylisteditor</code>
| <code>WINDOW_MUSIC_PLAYLIST_EDITOR</code>
| <code>10503</code>
| <code>503</code>
| MyMusicPlaylistEditor.xml
|- {{frodo row}}
| <code>pvr</code>
| <code>WINDOW_PVR</code>
| <code>10601</code>
| <code>601</code>
| MyPVR.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{helix row}}
| <code>tvchannels</code>
| <code>WINDOW_TV_CHANNELS</code>
| <code>10615</code>
| <code>615</code>
| MyPVRChannels.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvrecordings</code>
| <code>WINDOW_TV_RECORDINGS</code>
| <code>10616</code>
| <code>616</code>
| MyPVRRecordings.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvguide</code>
| <code>WINDOW_TV_GUIDE</code>
| <code>10617</code>
| <code>617</code>
| MyPVRGuide.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvtimers</code>
| <code>WINDOW_TV_TIMERS</code>
| <code>10618</code>
| <code>618</code>
| MyPVRTimers.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvsearch</code>
| <code>WINDOW_TV_SEARCH</code>
| <code>10619</code>
| <code>619</code>
| MyPVRSearch.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiochannels</code>
| <code>WINDOW_RADIO_CHANNELS</code>
| <code>10620</code>
| <code>620</code>
| MyPVRChannels.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiorecordings</code>
| <code>WINDOW_RADIO_RECORDINGS</code>
| <code>10621</code>
| <code>621</code>
| MyPVRRecordings.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radioguide</code>
| <code>WINDOW_RADIO_GUIDE</code>
| <code>10622</code>
| <code>622</code>
| MyPVRGuide.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiotimers</code>
| <code>WINDOW_RADIO_TIMERS</code>
| <code>10623</code>
| <code>623</code>
| MyPVRTimers.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiosearch</code>
| <code>WINDOW_RADIO_SEARCH</code>
| <code>10624</code>
| <code>624</code>
| MyPVRSearch.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{frodo row}}
| <code>pvrguideinfo</code>
| <code>WINDOW_DIALOG_PVR_GUIDE_INFO</code>
| <code>10602</code>
| <code>602</code>
| DialogPVRGuideInfo.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrrecordinginfo</code>
| <code>WINDOW_DIALOG_PVR_RECORDING_INFO</code>
| <code>10603</code>
| <code>603</code>
| DialogPVRRecordingInfo.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrtimersetting</code>
| <code>WINDOW_DIALOG_PVR_TIMER_SETTING</code>
| <code>10604</code>
| <code>604</code>
| DialogPVRTimerSettings.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrgroupmanager</code>
| <code>WINDOW_DIALOG_PVR_GROUP_MANAGER</code>
| <code>10605</code>
| <code>605</code>
| DialogPVRGroupManager.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrchannelmanager</code>
| <code>WINDOW_DIALOG_PVR_CHANNEL_MANAGER</code>
| <code>10606</code>
| <code>606</code>
| DialogPVRChannelManager.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrguidesearch</code>
| <code>WINDOW_DIALOG_PVR_GUIDE_SEARCH</code>
| <code>10607</code>
| <code>607</code>
| DialogPVRGuideSearch.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrosdchannels</code>
| <code>WINDOW_DIALOG_PVR_OSD_CHANNELS</code>
| <code>10610</code>
| <code>610</code>
| DialogPVRChannelsOSD.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrosdguide</code>
| <code>WINDOW_DIALOG_PVR_OSD_GUIDE</code>
| <code>10611</code>
| <code>611</code>
| DialogPVRGuideOSD.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>virtualkeyboard</code>
| <code>WINDOW_VIRTUAL_KEYBOARD</code>
| <code>11000</code>
| <code>1000</code>
| none
|-
| <code>selectdialog</code>
| <code>WINDOW_DIALOG_SELECT</code>
| <code>12000</code>
| <code>2000</code>
| DialogSelect.xml
|-
| <code>musicinformation</code>
| <code>WINDOW_MUSIC_INFO</code>
| <code>12001</code>
| <code>2001</code>
| DialogAlbumInfo.xml
|-
| <code>okdialog</code>
| <code>WINDOW_DIALOG_OK</code>
| <code>12002</code>
| <code>2002</code>
| DialogOK.xml
|-
| <code>movieinformation</code>
| <code>WINDOW_VIDEO_INFO</code>
| <code>12003</code>
| <code>2003</code>
| DialogVideoInfo.xml
|-
| <code>fullscreenvideo</code>
| <code>WINDOW_FULLSCREEN_VIDEO</code>
| <code>12005</code>
| <code>2005</code>
| VideoFullScreen.xml
|-
| <code>visualisation</code>
| <code>WINDOW_VISUALISATION</code>
| <code>12006</code>
| <code>2006</code>
| MusicVisualisation.xml
|-
| <code>slideshow</code>
| <code>WINDOW_SLIDESHOW</code>
| <code>12007</code>
| <code>2007</code>
| SlideShow.xml
|-
| <code>filestackingdialog</code>
| <code>WINDOW_DIALOG_FILESTACKING</code>
| <code>12008</code>
| <code>2008</code>
| DialogFileStacking.xml
|-
| <code>karaoke</code>
| <code>WINDOW_KARAOKELYRICS</code>
| <code>12009</code>
| <code>2009</code>
| MusicKaraokeLyrics.xml
|-
| <code>weather</code>
| <code>WINDOW_WEATHER</code>
| <code>12600</code>
| <code>2600</code>
| MyWeather.xml
|-
| <code>screensaver</code>
| <code>WINDOW_SCREENSAVER</code>
| <code>12900</code>
| <code>2900</code>
| none
|-
| <code>videoosd</code>
| <code>WINDOW_OSD</code>
| <code>12901</code>
| <code>2901</code>
| VideoOSD.xml
|-
| <code>videomenu</code>
| <code>WINDOW_MEDIA_MENU</code>
| <code>12902</code>
| <code>2902</code>
| none
|-
| <code>startup</code>
| <code>WINDOW_STARTUP_ANIM</code>
| <code>12999</code>
| <code>2999</code>
| startup.xml
|- {{frodo row}}
| <code>skinsettings</code>
| <code>-</code>
| <code>-</code>
| <code>-</code>
| SkinSettings.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>startwindow</code>
| <code>-</code>
| <code>-</code>
| <code>-</code>
| shortcut to the current startwindow
|-
| 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)
|-
| <code>pointer</code>
| <code>- </code>
| <code>- </code>
| <code>105 </code>
| Pointer.xml
|-
| <code>musicoverlay</code>
| <code>WINDOW_MUSIC_OVERLAY</code>
| <code>12903</code>
| <code>2903</code>
| MusicOverlay.xml
|-
| <code>videooverlay</code>
| <code>WINDOW_VIDEO_OVERLAY</code>
| <code>12904</code>
| <code>2904</code>
| VideoOverlay.xml
|-
| <code>Python Windows </code>
| <code>- </code>
| <code>- </code>
| <code>3000–3099 </code>
| none
|}
<section end="main content" />
== Removed window IDs ==
* <code>networksettings</code> - Removed in v12 Frodo
* <code>musicscan</code> - Removed in v12 Frodo
* <code>videoscan</code> - Removed in v12 Frodo
* <code>videofiles</code> - Removed in v13 Gotham
* <code>pvr</code> - Removed in v14 Helix

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

Window IDs

2014-10-12T07:05:05Z

Xhaggi:

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Python development|Skinning}}
<section begin="main content" />
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].

* [[keymap.xml]] uses the Window name.
* XBMC's C++ code uses the Window definitions and Window ID's.
* skin .xml files use the Delta Window ID's
* XBMC.ActivateWindow() can use either the Window name, the Window ID, or the delta Window ID.
* sounds.xml can use the window name or window ID 

'''You can use secondary parameters with all media windows, as can be seen here:'''
* [[Opening Windows and Dialogs]] 
'''Example:'''
* You want a button in your skin or on your remote taking you directly to the movie listing you let that button do

ActivateWindow(Videos,MovieTitles) (v11 Eden and up)

{| class="prettytable"
|-
! Name !! Definition !! Window ID !! Delta window ID !! source XML file
|-
| <code>home</code>
| <code>WINDOW_HOME</code>
| <code>10000</code>
| <code>0</code>
| Home.xml
|-
| <code>programs</code>
| <code>WINDOW_PROGRAMS</code>
| <code>10001</code>
| <code>1</code>
| MyPrograms.xml
|-
| <code>pictures</code>
| <code>WINDOW_PICTURES</code>
| <code>10002</code>
| <code>2</code>
| MyPics.xml
|-
| <code>filemanager</code>
| <code>WINDOW_FILES</code>
| <code>10003</code>
| <code>3</code>
| FileManager.xml
|-
| <code>settings</code>
| <code>WINDOW_SETTINGS_MENU</code>
| <code>10004</code>
| <code>4</code>
| Settings.xml
|-
| <code>music</code>
| <code>WINDOW_MUSIC</code>
| <code>10005</code>
| <code>5</code>
| None – this is just a wrapper for the current My Music view (who's IDs are 501 and 502)
|-
| <code>video</code>
| <code>WINDOW_VIDEOS</code>
| <code>10006</code>
| <code>6</code>
| None – this is just a wrapper for the current My Video view (who's IDs are 21-25)
|-
| <code>systeminfo</code>
| <code>WINDOW_SYSTEM_INFORMATION</code>
| <code>10007</code>
| <code>7</code>
| SettingsSystemInfo.xml
|-
| <code>screencalibration</code>
| <code>WINDOW_MOVIE_CALIBRATION</code>
| <code>10011</code>
| <code>11</code>
| SettingsScreenCalibration.xml
|-
| <code>picturessettings</code>
| <code>WINDOW_SETTINGS_MYPICTURES</code>
| <code>10012</code>
| <code>12</code>
| SettingsCategory.xml
|-
| <code>programssettings</code>
| <code>WINDOW_SETTINGS_MYPROGRAMS</code>
| <code>10013</code>
| <code>13</code>
| SettingsCategory.xml
|-
| <code>weathersettings</code>
| <code>WINDOW_SETTINGS_MYWEATHER</code>
| <code>10014</code>
| <code>14</code>
| SettingsCategory.xml
|-
| <code>musicsettings</code>
| <code>WINDOW_SETTINGS_MYMUSIC</code>
| <code>10015</code>
| <code>15</code>
| SettingsCategory.xml
|-
| <code>systemsettings</code>
| <code>WINDOW_SETTINGS_SYSTEM</code>
| <code>10016</code>
| <code>16</code>
| SettingsCategory.xml
|-
| <code>videossettings</code>
| <code>WINDOW_SETTINGS_MYVIDEOS</code>
| <code>10017</code>
| <code>17</code>
| SettingsCategory.xml
|- {{frodo row}}
| <code>servicesettings</code>
| <code>WINDOW_SETTINGS_SERVICE</code>
| <code>10018</code>
| <code>18</code>
| SettingsCategory.xml '''(Frodo addition)'''
|-
| <code>appearancesettings</code>
| <code>WINDOW_SETTINGS_APPEARANCE</code>
| <code>10019</code>
| <code>19</code>
| SettingsCategory.xml
|-
| <code>scripts</code>
| <code>WINDOW_SCRIPTS</code>
| <code>10020</code>
| <code>20</code>
| MyScripts.xml
|-
| <code>videolibrary</code>
| <code>WINDOW_VIDEO_NAV</code>
| <code>10025</code>
| <code>25</code>
| MyVideoNav.xml - Replaces the following .XML files: MyVideoGenre (WINDOW_VIDEO_GENRE), MyVideoActors (WINDOW_VIDEO_ACTOR), MyVideoYear (WINDOW_VIDEO_YEAR), MyVideoTitle (WINDOW_VIDEO_TITLE)
|-
| <code>videoplaylist</code>
| <code>WINDOW_VIDEO_PLAYLIST</code>
| <code>10028</code>
| <code>28</code>
| MyVideoPlaylist.xml
|-
| <code>loginscreen</code>
| <code>WINDOW_LOGINSCREEN</code>
| <code>10029</code>
| <code>29</code>
| LoginScreen.xml
|-
| <code>profiles</code>
| <code>WINDOW_SETTINGS_PROFILES</code>
| <code>10034</code>
| <code>34</code>
| SettingsProfile.xml
|-
| <code>addonbrowser</code>
| <code>WINDOW_ADDON_BROWSER</code>
| <code>10040</code>
| <code>40</code>
| AddonBrowser.xml
|-
| <code>yesnodialog</code>
| <code>WINDOW_DIALOG_YES_NO</code>
| <code>10100</code>
| <code>100</code>
| DialogYesNo.xml
|-
| <code>progressdialog</code>
| <code>WINDOW_DIALOG_PROGRESS</code>
| <code>10101</code>
| <code>101</code>
| DialogProgress.xml
|-
| <code>virtualkeyboard</code>
| <code>WINDOW_DIALOG_KEYBOARD</code>
| <code>10103</code>
| <code>103</code>
| DialogKeyboard.xml
|-
| <code>volumebar</code>
| <code>WINDOW_DIALOG_VOLUME_BAR</code>
| <code>10104</code>
| <code>104</code>
| DialogVolumeBar.xml
|-
| <code>contextmenu</code>
| <code>WINDOW_DIALOG_CONTEXT_MENU</code>
| <code>10106</code>
| <code>106</code>
| DialogContextMenu.xml
|-
| <code>infodialog</code>
| <code>WINDOW_DIALOG_KAI_TOAST</code>
| <code>10107</code>
| <code>107</code>
| DialogKaiToast.xml
|-
| <code>numericinput</code>
| <code>WINDOW_DIALOG_NUMERIC</code>
| <code>10109</code>
| <code>109</code>
| DialogNumeric.xml
|-
| <code>shutdownmenu</code>
| <code>WINDOW_DIALOG_BUTTON_MENU</code>
| <code>10111</code>
| <code>111</code>
| DialogButtonMenu.xml
|-
| <code>mutebug</code>
| <code>WINDOW_DIALOG_MUTE_BUG</code>
| <code>10113</code>
| <code>113</code>
| DialogMuteBug.xml
|-
| <code>playercontrols</code>
| <code>WINDOW_DIALOG_PLAYER_CONTROLS</code>
| <code>10114</code>
| <code>114</code>
| PlayerControls.xml
|-
| <code>seekbar</code>
| <code>WINDOW_DIALOG_SEEK_BAR</code>
| <code>10115</code>
| <code>115</code>
| DialogSeekBar.xml
|-
| <code>musicosd</code>
| <code>WINDOW_DIALOG_MUSIC_OSD</code>
| <code>10120</code>
| <code>120</code>
| MusicOSD.xml
|-
| <code>visualisationpresetlist</code>
| <code>WINDOW_DIALOG_VIS_PRESET_LIST</code>
| <code>10122</code>
| <code>122</code>
| VisualizationPresetList.xml
|-
| <code>osdvideosettings</code>
| <code>WINDOW_DIALOG_VIDEO_OSD_SETTINGS</code>
| <code>10123</code>
| <code>123</code>
| VideoOSDSettings.xml
|-
| <code>osdaudiosettings</code>
| <code>WINDOW_DIALOG_AUDIO_OSD_SETTINGS</code>
| <code>10124</code>
| <code>124</code>
| VideoOSDSettings.xml
|-
| <code>videobookmarks</code>
| <code>WINDOW_DIALOG_VIDEO_BOOKMARKS</code>
| <code>10125</code>
| <code>125</code>
| VideoOSDBookmarks.xml
|-
| <code>filebrowser</code>
| <code>WINDOW_DIALOG_FILE_BROWSER</code>
| <code>10126</code>
| <code>126</code>
| FileBrowser.xml
|-
| <code>networksetup</code>
| <code>WINDOW_DIALOG_NETWORK_SETUP</code>
| <code>10128</code>
| <code>128</code>
| DialogNetworkSetup.xml
|-
| <code>mediasource</code>
| <code>WINDOW_DIALOG_MEDIA_SOURCE</code>
| <code>10129</code>
| <code>129</code>
| DialogMediaSource.xml
|-
| <code>profilesettings</code>
| <code>WINDOW_PROFILE_SETTINGS</code>
| <code>10130</code>
| <code>130</code>
| ProfileSettings.xml
|-
| <code>locksettings</code>
| <code>WINDOW_LOCK_SETTINGS</code>
| <code>10131</code>
| <code>131</code>
| LockSettings.xml
|-
| <code>contentsettings</code>
| <code>WINDOW_DIALOG_CONTENT_SETTINGS</code>
| <code>10132</code>
| <code>132</code>
| DialogContentSettings.xml
|-
| <code>favourites</code>
| <code>WINDOW_DIALOG_FAVOURITES</code>
| <code>10134</code>
| <code>134</code>
| DialogFavourites.xml
|-
| <code>songinformation</code>
| <code>WINDOW_DIALOG_SONG_INFO</code>
| <code>10135</code>
| <code>135</code>
| DialogSongInfo.xml
|-
| <code>smartplaylisteditor</code>
| <code>WINDOW_DIALOG_SMART_PLAYLIST_EDITOR</code>
| <code>10136</code>
| <code>136</code>
| SmartPlaylistEditor.xml
|-
| <code>smartplaylistrule</code>
| <code>WINDOW_DIALOG_SMART_PLAYLIST_RULE</code>
| <code>10137</code>
| <code>137</code>
| SmartPlaylistRule.xml
|-
| <code>busydialog</code>
| <code>WINDOW_DIALOG_BUSY</code>
| <code>10138</code>
| <code>138</code>
| DialogBusy.xml
|-
| <code>pictureinfo</code>
| <code>WINDOW_DIALOG_PICTURE_INFO</code>
| <code>10139</code>
| <code>139</code>
| DialogPictureInfo.xml
|-
| <code>addonsettings</code>
| <code>WINDOW_DIALOG_ADDON_SETTINGS</code>
| <code>10140</code>
| <code>140</code>
| DialogAddonSettings.xml
|-
| <code>accesspoints</code>
| <code>WINDOW_DIALOG_ACCESS_POINTS</code>
| <code>10141</code>
| <code>141</code>
| DialogAccessPoints.xml
|-
| <code>fullscreeninfo</code>
| <code>WINDOW_DIALOG_FULLSCREEN_INFO</code>
| <code>10142</code>
| <code>142</code>
| DialogFullScreenInfo.xml
|-
| <code>karaokeselector</code>
| <code>WINDOW_DIALOG_KARAOKE_SONGSELECT</code>
| <code>10143</code>
| <code>143</code>
| DialogKaraokeSongSelector.xml
|-
| <code>karaokelargeselector</code>
| <code>WINDOW_DIALOG_KARAOKE_SELECTOR</code>
| <code>10144</code>
| <code>144</code>
| DialogKaraokeSongSelectorLarge.xml
|-
| <code>sliderdialog</code>
| <code>WINDOW_DIALOG_SLIDER</code>
| <code>10145</code>
| <code>145</code>
| DialogSlider.xml
|-
| <code>addoninformation</code>
| <code>WINDOW_DIALOG_ADDON_INFO</code>
| <code>10146</code>
| <code>146</code>
| DialogAddonInfo.xml
|-
| <code>textviewer</code>
| <code>WINDOW_DIALOG_TEXT_VIEWER</code>
| <code>10147</code>
| <code>147</code>
| DialogTextViewer.xml
|-
| <code>peripherals</code>
| <code>WINDOW_DIALOG_PERIPHERAL_MANAGER</code>
| <code>10149</code>
| <code>149</code>
| DialogPeripheralManager.xml
|-
| <code>peripheralsettings</code>
| <code>WINDOW_DIALOG_PERIPHERAL_SETTINGS</code>
| <code>10150</code>
| <code>150</code>
| DialogPeripheralSettings.xml
|-
| <code>extendedprogressdialog</code>
| <code>WINDOW_DIALOG_EXT_PROGRESS</code>
| <code>10151</code>
| <code>151</code>
| DialogExtendedProgressBar.xml
|- {{frodo row}}
| <code>mediafilter</code>
| <code>WINDOW_DIALOG_MEDIA_FILTER</code>
| <code>10152</code>
| <code>152</code>
| DialogMediaFilter.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{Gotham row}}
| <code>subtitlesearch</code>
| <code>WINDOW_DIALOG_SUBTITLES</code>
| <code>10153</code>
| <code>153</code>
| DialogSubtitles.xml '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>musicplaylist</code>
| <code>WINDOW_MUSIC_PLAYLIST</code>
| <code>10500</code>
| <code>500</code>
| MyMusicPlaylist.xml
|-
| <code>musicfiles</code>
| <code>WINDOW_MUSIC_FILES</code>
| <code>10501</code>
| <code>501</code>
| MyMusicSongs.xml
|-
| <code>musiclibrary</code>
| <code>WINDOW_MUSIC_NAV</code>
| <code>10502</code>
| <code>502</code>
| MyMusicNav.xml
|-
| <code>musicplaylisteditor</code>
| <code>WINDOW_MUSIC_PLAYLIST_EDITOR</code>
| <code>10503</code>
| <code>503</code>
| MyMusicPlaylistEditor.xml
|- {{frodo row}}
| <code>pvr</code>
| <code>WINDOW_PVR</code>
| <code>10601</code>
| <code>601</code>
| MyPVR.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{helix row}}
| <code>tvchannels</code>
| <code>WINDOW_TV_CHANNELS</code>
| <code>10615</code>
| <code>615</code>
| MyPVRChannels.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvrecordings</code>
| <code>WINDOW_TV_RECORDINGS</code>
| <code>10616</code>
| <code>616</code>
| MyPVRRecordings.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvguide</code>
| <code>WINDOW_TV_GUIDE</code>
| <code>10617</code>
| <code>617</code>
| MyPVRGuide.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvtimers</code>
| <code>WINDOW_TV_TIMERS</code>
| <code>10618</code>
| <code>618</code>
| MyPVRTimers.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>tvsearch</code>
| <code>WINDOW_TV_SEARCH</code>
| <code>10619</code>
| <code>619</code>
| MyPVRSearch.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiochannels</code>
| <code>WINDOW_RADIO_CHANNELS</code>
| <code>10620</code>
| <code>620</code>
| MyPVRChannels.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiorecordings</code>
| <code>WINDOW_RADIO_RECORDINGS</code>
| <code>10621</code>
| <code>621</code>
| MyPVRRecordings.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radioguide</code>
| <code>WINDOW_RADIO_GUIDE</code>
| <code>10622</code>
| <code>622</code>
| MyPVRGuide.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiotimers</code>
| <code>WINDOW_RADIO_TIMERS</code>
| <code>10623</code>
| <code>623</code>
| MyPVRTimers.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{helix row}}
| <code>radiosearch</code>
| <code>WINDOW_RADIO_SEARCH</code>
| <code>10624</code>
| <code>624</code>
| MyPVRSearch.xml '''([[:Category:Helix feature|Helix addition]])'''
|- {{frodo row}}
| <code>pvrguideinfo</code>
| <code>WINDOW_DIALOG_PVR_GUIDE_INFO</code>
| <code>10602</code>
| <code>602</code>
| DialogPVRGuideInfo.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrrecordinginfo</code>
| <code>WINDOW_DIALOG_PVR_RECORDING_INFO</code>
| <code>10603</code>
| <code>603</code>
| DialogPVRRecordingInfo.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrtimersetting</code>
| <code>WINDOW_DIALOG_PVR_TIMER_SETTING</code>
| <code>10604</code>
| <code>604</code>
| DialogPVRTimerSettings.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrgroupmanager</code>
| <code>WINDOW_DIALOG_PVR_GROUP_MANAGER</code>
| <code>10605</code>
| <code>605</code>
| DialogPVRGroupManager.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrchannelmanager</code>
| <code>WINDOW_DIALOG_PVR_CHANNEL_MANAGER</code>
| <code>10606</code>
| <code>606</code>
| DialogPVRChannelManager.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrguidesearch</code>
| <code>WINDOW_DIALOG_PVR_GUIDE_SEARCH</code>
| <code>10607</code>
| <code>607</code>
| DialogPVRGuideSearch.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrosdchannels</code>
| <code>WINDOW_DIALOG_PVR_OSD_CHANNELS</code>
| <code>10610</code>
| <code>610</code>
| DialogPVRChannelsOSD.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>pvrosdguide</code>
| <code>WINDOW_DIALOG_PVR_OSD_GUIDE</code>
| <code>10611</code>
| <code>611</code>
| DialogPVRGuideOSD.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>virtualkeyboard</code>
| <code>WINDOW_VIRTUAL_KEYBOARD</code>
| <code>11000</code>
| <code>1000</code>
| none
|-
| <code>selectdialog</code>
| <code>WINDOW_DIALOG_SELECT</code>
| <code>12000</code>
| <code>2000</code>
| DialogSelect.xml
|-
| <code>musicinformation</code>
| <code>WINDOW_MUSIC_INFO</code>
| <code>12001</code>
| <code>2001</code>
| DialogAlbumInfo.xml
|-
| <code>okdialog</code>
| <code>WINDOW_DIALOG_OK</code>
| <code>12002</code>
| <code>2002</code>
| DialogOK.xml
|-
| <code>movieinformation</code>
| <code>WINDOW_VIDEO_INFO</code>
| <code>12003</code>
| <code>2003</code>
| DialogVideoInfo.xml
|-
| <code>fullscreenvideo</code>
| <code>WINDOW_FULLSCREEN_VIDEO</code>
| <code>12005</code>
| <code>2005</code>
| VideoFullScreen.xml
|-
| <code>visualisation</code>
| <code>WINDOW_VISUALISATION</code>
| <code>12006</code>
| <code>2006</code>
| MusicVisualisation.xml
|-
| <code>slideshow</code>
| <code>WINDOW_SLIDESHOW</code>
| <code>12007</code>
| <code>2007</code>
| SlideShow.xml
|-
| <code>filestackingdialog</code>
| <code>WINDOW_DIALOG_FILESTACKING</code>
| <code>12008</code>
| <code>2008</code>
| DialogFileStacking.xml
|-
| <code>karaoke</code>
| <code>WINDOW_KARAOKELYRICS</code>
| <code>12009</code>
| <code>2009</code>
| MusicKaraokeLyrics.xml
|-
| <code>weather</code>
| <code>WINDOW_WEATHER</code>
| <code>12600</code>
| <code>2600</code>
| MyWeather.xml
|-
| <code>screensaver</code>
| <code>WINDOW_SCREENSAVER</code>
| <code>12900</code>
| <code>2900</code>
| none
|-
| <code>videoosd</code>
| <code>WINDOW_OSD</code>
| <code>12901</code>
| <code>2901</code>
| VideoOSD.xml
|-
| <code>videomenu</code>
| <code>WINDOW_MEDIA_MENU</code>
| <code>12902</code>
| <code>2902</code>
| none
|-
| <code>startup</code>
| <code>WINDOW_STARTUP_ANIM</code>
| <code>12999</code>
| <code>2999</code>
| startup.xml
|- {{frodo row}}
| <code>skinsettings</code>
| <code>-</code>
| <code>-</code>
| <code>-</code>
| SkinSettings.xml '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>startwindow</code>
| <code>-</code>
| <code>-</code>
| <code>-</code>
| shortcut to the current startwindow
|-
| 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)
|-
| <code>pointer</code>
| <code>- </code>
| <code>- </code>
| <code>105 </code>
| Pointer.xml
|-
| <code>musicoverlay</code>
| <code>WINDOW_MUSIC_OVERLAY</code>
| <code>12903</code>
| <code>2903</code>
| MusicOverlay.xml
|-
| <code>videooverlay</code>
| <code>WINDOW_VIDEO_OVERLAY</code>
| <code>12904</code>
| <code>2904</code>
| VideoOverlay.xml
|-
| <code>Python Windows </code>
| <code>- </code>
| <code>- </code>
| <code>3000–3099 </code>
| none
|}
<section end="main content" />
== Removed window IDs ==
* <code>networksettings</code> - Removed in v12 Frodo
* <code>musicscan</code> - Removed in v12 Frodo
* <code>videoscan</code> - Removed in v12 Frodo
* <code>videofiles</code> - Removed in v13 Gotham

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

Template:Helix row

2014-10-12T06:58:52Z

Xhaggi: Created page with "style="background:#8cd5f0;""

style="background:#8cd5f0;"

Archive:Skin migration PVR section for Helix release

2014-07-17T06:46:18Z

Xhaggi: /* Migrate your home menu entries */

== Introduction ==
This guide describes how to migrate the PVR section of your existing skin to the upcoming Helix release.

First we want to explain what's changed, before we start with the mirgration guide.
We split up the existing TV window (''MyPVR'') and the underlaying views ''channels'', ''guide'' etc. in its own windows and in its own XML files. Furthermore we split up the TV and Radio part of the PVR section and add unique window names like ''TVChannels'', ''RadioGuide'' etc. to activate such a window (''ActivateWindow(TVGuide)'').
We also removed most of the static button id's previously used for navigating through the former views and added some default functionality such as support for views, sorting type and sorting direction, which you remember from the video windows.

'''New XML files:'''
* MyPVRChannels.xml
* MyPVRGuide.xml
* MyPVRRecordings.xml
* MyPVRSearch.xml
* MyPVRTimers.xml

'''New window names:'''
* TVChannels & RadioChannels -> MyPVRChannels.xml
* TVGuide & RadioGuide -> MyPVRGuide.xml
* TVRecordings & RadioRecordings -> MyPVRRecordings.xml
* TVSearch & RadioSearch -> MyPVRSearch.xml
* TVTimers & RadioTimers -> MyPVRTimers.xml

'''New buttons'''
* added a new group selection dialog, button "Channel Groups" (ID: 28)
* added view support, button "View As" (ID: 2)
* added ability to sort the listings, "Sort by" button (ID: 3), "Sort direction" button (ID: 4)

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L74

'''New static list ids'''
* ID: 10 -> guide EPG grip
* ID: 11 -> guide view now
* ID: 12 -> guide view next
* ID: 13 -> guide view channel

see: 
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRGuide.xml#L5 
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/ViewsPVRGuide.xml

'''New properties'''
* new GUI info properties ''PVR.HasTVChannels'' and ''PVR.HasRadioChannels'' to determine if there are tv and radio channels
* new window property ''IsRadio'' to determine if you are the TV or Radio window (see https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L104)
 

== Migrate your home menu entries ==

* Replace the existing calls to the built-in functions ''ActivateWindowAndFocus(MyPVR, 32,0, 11,0)'' with ''ActivateWindow(TVChannels)'' or ''ActivateWindow(RadioChannels)'' etc. (see the list of new window names)
see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesHomeMenuItems.xml#L258

== Migrate the existing views to the new window XML files ==

* copy over the content of your existing ''MyPVR.xml'' to each new XML file (''MyPVRChannels.xml, MyPVRGuide.xml'')
* remove the ''<include>'' parts where you include the different views (''channels, guide etc.'') and replace each with its corresponding content for this window, except the radio channels view (ID: 12) which we do not differ from the tv channel list anymore.
* As we now support the view functionality like we do in the video window, you have to define a ''<views>'' element right after the ''<window>'' element (ex. ''<views>50</views>'').
* Now it's up to you if you want to replace the different id's used for each listing (11 = channel list, 13 = Recordings) with a single ID, for example 50. If not, please make sure your id's used in the ''<views>'' element match your control id's.

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRChannels.xml

=== Guide Window ===
'''IMPORTANT:''' In guide window (''MyPVRGuide.xml'') you have to use the static view id's (epg = 10, now = 11, next = 12, channel = 13) within the ''<view>'' element (''<views>10,11,12,13</views>''), but it's up to you which view you want to support. Remove each id which you don't want to support (ex. ''<views>10</views>'' -> EPG view only).

* clone the view "now/next" as we split this view into now (ID: 11) and next (ID: 12)
* change the view id for the guide channel view from ID 15 to ID 13
* you have to add a ''<viewtype>'' to each control to define the name of the view (''<viewtype label="19032">list</viewtype>''). Label ID's: 19032 = EPG, 19030 = Now, 19031 = Next, 19029 = Channel 

see:
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRGuide.xml
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/ViewsPVRGuide.xml#L19
 
 

== Migrate the sideblade menu ==

* there is no need to add special button id's to switch the windows (like channels, recordings). Use ''<onclick>ActivateWindow(...)</onclick>'' and the new property ''IsRadio'' to indicate which window should be activated.
* add the button to access the new group selection dialog (ID: 28)
* add the button "View as" to change the views of this window (ID: 2)
* add the buttons "Sort by" (ID: 3) and "Sort direction" (ID: 4) to sort your listings

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L74

== Migrate the section header (breadcrumb) ==

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L3

Archive:Skin migration PVR section for Helix release

2014-07-17T06:41:54Z

Xhaggi: /* Migrate the existing views to the new window XML files */

== Introduction ==
This guide describes how to migrate the PVR section of your existing skin to the upcoming Helix release.

First we want to explain what's changed, before we start with the mirgration guide.
We split up the existing TV window (''MyPVR'') and the underlaying views ''channels'', ''guide'' etc. in its own windows and in its own XML files. Furthermore we split up the TV and Radio part of the PVR section and add unique window names like ''TVChannels'', ''RadioGuide'' etc. to activate such a window (''ActivateWindow(TVGuide)'').
We also removed most of the static button id's previously used for navigating through the former views and added some default functionality such as support for views, sorting type and sorting direction, which you remember from the video windows.

'''New XML files:'''
* MyPVRChannels.xml
* MyPVRGuide.xml
* MyPVRRecordings.xml
* MyPVRSearch.xml
* MyPVRTimers.xml

'''New window names:'''
* TVChannels & RadioChannels -> MyPVRChannels.xml
* TVGuide & RadioGuide -> MyPVRGuide.xml
* TVRecordings & RadioRecordings -> MyPVRRecordings.xml
* TVSearch & RadioSearch -> MyPVRSearch.xml
* TVTimers & RadioTimers -> MyPVRTimers.xml

'''New buttons'''
* added a new group selection dialog, button "Channel Groups" (ID: 28)
* added view support, button "View As" (ID: 2)
* added ability to sort the listings, "Sort by" button (ID: 3), "Sort direction" button (ID: 4)

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L74

'''New static list ids'''
* ID: 10 -> guide EPG grip
* ID: 11 -> guide view now
* ID: 12 -> guide view next
* ID: 13 -> guide view channel

see: 
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRGuide.xml#L5 
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/ViewsPVRGuide.xml

'''New properties'''
* new GUI info properties ''PVR.HasTVChannels'' and ''PVR.HasRadioChannels'' to determine if there are tv and radio channels
* new window property ''IsRadio'' to determine if you are the TV or Radio window (see https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L104)
 

== Migrate your home menu entries ==

* Replace the existing calls to the built-in functions ''ActivateWindowAndFocus(MyPVR, 32,0, 11,0)'' with ''ActivateWindow(TVChannels)'' or ''ActivateWindow(RadioChannels)'' etc. (see the list of new window names)

== Migrate the existing views to the new window XML files ==

* copy over the content of your existing ''MyPVR.xml'' to each new XML file (''MyPVRChannels.xml, MyPVRGuide.xml'')
* remove the ''<include>'' parts where you include the different views (''channels, guide etc.'') and replace each with its corresponding content for this window, except the radio channels view (ID: 12) which we do not differ from the tv channel list anymore.
* As we now support the view functionality like we do in the video window, you have to define a ''<views>'' element right after the ''<window>'' element (ex. ''<views>50</views>'').
* Now it's up to you if you want to replace the different id's used for each listing (11 = channel list, 13 = Recordings) with a single ID, for example 50. If not, please make sure your id's used in the ''<views>'' element match your control id's.

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRChannels.xml

=== Guide Window ===
'''IMPORTANT:''' In guide window (''MyPVRGuide.xml'') you have to use the static view id's (epg = 10, now = 11, next = 12, channel = 13) within the ''<view>'' element (''<views>10,11,12,13</views>''), but it's up to you which view you want to support. Remove each id which you don't want to support (ex. ''<views>10</views>'' -> EPG view only).

* clone the view "now/next" as we split this view into now (ID: 11) and next (ID: 12)
* change the view id for the guide channel view from ID 15 to ID 13
* you have to add a ''<viewtype>'' to each control to define the name of the view (''<viewtype label="19032">list</viewtype>''). Label ID's: 19032 = EPG, 19030 = Now, 19031 = Next, 19029 = Channel 

see:
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRGuide.xml
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/ViewsPVRGuide.xml#L19
 
 

== Migrate the sideblade menu ==

* there is no need to add special button id's to switch the windows (like channels, recordings). Use ''<onclick>ActivateWindow(...)</onclick>'' and the new property ''IsRadio'' to indicate which window should be activated.
* add the button to access the new group selection dialog (ID: 28)
* add the button "View as" to change the views of this window (ID: 2)
* add the buttons "Sort by" (ID: 3) and "Sort direction" (ID: 4) to sort your listings

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L74

== Migrate the section header (breadcrumb) ==

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L3

Archive:Skin migration PVR section for Helix release

2014-07-17T06:41:22Z

Xhaggi: /* Migrate the existing views to the new window XML files */

== Introduction ==
This guide describes how to migrate the PVR section of your existing skin to the upcoming Helix release.

First we want to explain what's changed, before we start with the mirgration guide.
We split up the existing TV window (''MyPVR'') and the underlaying views ''channels'', ''guide'' etc. in its own windows and in its own XML files. Furthermore we split up the TV and Radio part of the PVR section and add unique window names like ''TVChannels'', ''RadioGuide'' etc. to activate such a window (''ActivateWindow(TVGuide)'').
We also removed most of the static button id's previously used for navigating through the former views and added some default functionality such as support for views, sorting type and sorting direction, which you remember from the video windows.

'''New XML files:'''
* MyPVRChannels.xml
* MyPVRGuide.xml
* MyPVRRecordings.xml
* MyPVRSearch.xml
* MyPVRTimers.xml

'''New window names:'''
* TVChannels & RadioChannels -> MyPVRChannels.xml
* TVGuide & RadioGuide -> MyPVRGuide.xml
* TVRecordings & RadioRecordings -> MyPVRRecordings.xml
* TVSearch & RadioSearch -> MyPVRSearch.xml
* TVTimers & RadioTimers -> MyPVRTimers.xml

'''New buttons'''
* added a new group selection dialog, button "Channel Groups" (ID: 28)
* added view support, button "View As" (ID: 2)
* added ability to sort the listings, "Sort by" button (ID: 3), "Sort direction" button (ID: 4)

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L74

'''New static list ids'''
* ID: 10 -> guide EPG grip
* ID: 11 -> guide view now
* ID: 12 -> guide view next
* ID: 13 -> guide view channel

see: 
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRGuide.xml#L5 
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/ViewsPVRGuide.xml

'''New properties'''
* new GUI info properties ''PVR.HasTVChannels'' and ''PVR.HasRadioChannels'' to determine if there are tv and radio channels
* new window property ''IsRadio'' to determine if you are the TV or Radio window (see https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L104)
 

== Migrate your home menu entries ==

* Replace the existing calls to the built-in functions ''ActivateWindowAndFocus(MyPVR, 32,0, 11,0)'' with ''ActivateWindow(TVChannels)'' or ''ActivateWindow(RadioChannels)'' etc. (see the list of new window names)

== Migrate the existing views to the new window XML files ==

* copy over the content of your existing ''MyPVR.xml'' to each new XML file (''MyPVRChannels.xml, MyPVRGuide.xml'')
* remove the ''<include>'' parts where you include the different views (''channels, guide etc.'') and replace each with its corresponding content for this window, except the radio channels view (ID: 12) which we do not differ from the tv channel list anymore.
* As we now support the view functionality like we do in the video window, you have to define a ''<views>'' element right after the ''<window>'' element (ex. ''<views>50</views>'').
* Now it's up to you if you want to replace the different id's used for each listing (11 = channel list, 13 = Recordings) with a single ID, for example 50. If not, please make sure your id's used in the ''<views>'' element match your control id's.

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRChannels.xml

=== Guide Window ===
'''IMPORTANT:''' In guide window (''MyPVRGuide.xml'') you have to use the static view id's (epg = 10, now = 11, next = 12, channel = 13) within the ''<view>'' element (''<views>10,11,12,13</views>''), but it's up to you which view you want to support. Remove each id which you don't want to support (ex. ''<views>10</views>'' -> EPG view only).

* clone the view "now/next" as we split this view into now (ID: 11) and next (ID: 12)
* change the view id for the guide channel view from ID 15 to ID 13
* you have to add a ''<viewtype>'' to each control to define the name of the view (''<viewtype label="19032">list</viewtype>''). Label ID's: 19032 = EPG, 19030 = Now, 19031 = Next, 19029 = Channel 

see:
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/MyPVRGuide.xml
https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/ViewsPVRGuide.xml#L19

 
 

== Migrate the sideblade menu ==

* there is no need to add special button id's to switch the windows (like channels, recordings). Use ''<onclick>ActivateWindow(...)</onclick>'' and the new property ''IsRadio'' to indicate which window should be activated.
* add the button to access the new group selection dialog (ID: 28)
* add the button "View as" to change the views of this window (ID: 2)
* add the buttons "Sort by" (ID: 3) and "Sort direction" (ID: 4) to sort your listings

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L74

== Migrate the section header (breadcrumb) ==

see: https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/IncludesPVR.xml#L3