Official Kodi Wiki - User contributions [en]

HOW-TO:Install Kodi for Linux

2023-02-14T20:05:19Z

Davu:

{{Mininav|[[Linux]] {{L2| [[Installing]] }} }}

== Installing Kodi on Ubuntu-based distributions with Team Kodi PPA ==

The recommended way of installing Kodi on Ubuntu and its derivatives (Linux Mint, Kali Linux, Pop! OS etc) is to use official Team Kodi PPA.

{{Warning|Ubuntu releases 16.04 LTS ("Xenial") or later, respectively, include their own Kodi builds in their official package repositories, customized to satisfy their interpretations of what is acceptable under their open-source mandates. If you have installed your distribution's Kodi packages, please purge them using the command <syntaxhighlight lang="shell" inline>sudo apt purge kodi\*</syntaxhighlight> before trying to install team-xbmc PPA packages.}}

{{Warning|Releases from Team Kodi PPA are NOT compatible with Debian GNU / Linux and distributions built on top of Debian's binary package repositories! Please refer to '''Debian''' section of this page for installation instructions on such distributions!}}

See [[SFTP]] or [http://help.ubuntu.com/community/UsingTheTerminal Click here to find out how to use the terminal.]

=== Adding Team Kodi PPA repository ===

Use the command line terminal in Ubuntu, and enter the following commands. Follow the prompts as you would any other software installation.

<syntaxhighlight lang="shell">
sudo apt install software-properties-common
sudo add-apt-repository -y ppa:team-xbmc/ppa
sudo apt install kodi
</syntaxhighlight>

{{#lst:Official_Ubuntu_PPA|repos}}

Note that this PPA only provides builds for Ubuntu i386 and Ubuntu amd64 but ''not for Ubuntu armhf'', which can run on a Raspberry Pi.

=== Installing binary add-ons (PVR, audio decoders, audio encoders, screensavers, visualizations, audio DSP) ===
{{See|Ubuntu binary add-ons}}

=== Installing a development build ===
{{See also|Development builds}}
To install a beta/unstable version of {{Kodi}} you must first add the unstable repository, then install XBMC. Use <code>ppa:team-xbmc/xbmc-nightly</code> for nightly builds and <code>ppa:team-xbmc/unstable</code> for [[Development_builds|beta]] builds.

<syntaxhighlight lang="shell">
sudo apt install software-properties-common
sudo add-apt-repository -y ppa:team-xbmc/xbmc-nightly
sudo apt install kodi
</syntaxhighlight>

Note that if you have any addons (such as PVR clients), these must be updated as well (they will not be updated automatically):
<syntaxhighlight lang="shell">
sudo apt install kodi-pvr-mythtv
</syntaxhighlight>

=== Upgrading ===
<section begin="Ubuntu upgrade" />
To update Kodi when a new version is released, just do a general system/package or use the following commands in the terminal (or via [[SFTP]]):

<syntaxhighlight lang="shell">
sudo apt update
sudo apt upgrade --with-new-pkgs
</syntaxhighlight>
<section end="Ubuntu upgrade" />

=== Downgrading to a stable version from a development version ===
If you install a nightly build or an unstable release and want to return to a stable release, follow these instructions:

Remove the unstable or nightly PPA:
<syntaxhighlight lang="shell">
apt-cache policy | grep -Eo 'team-xbmc/(unstable|nightly)' | sudo xargs -r add-apt-repository -ryP
</syntaxhighlight>

Then restore the stable version with the following commands:
<syntaxhighlight lang="shell">
sudo add-apt-repository ppa:team-xbmc/ppa
sudo apt-get update
sudo apt-get remove kodi kodi-x11
sudo apt-get install kodi
</syntaxhighlight>

=== Downgrading between newer and older stable versions ===
If you want to return to the next most recent stable release, follow these instructions:

Remove the current stable packages and PPA:
<syntaxhighlight lang="shell">
sudo apt purge kodi\*
sudo add-apt-repository -r ppa:team-xbmc/ppa
</syntaxhighlight>

Then install the "oldstable" version with the following commands:
<syntaxhighlight lang="shell">
sudo add-apt-repository -y ppa:team-xbmc/kodi-old
sudo apt install kodi
</syntaxhighlight>

=== Reverting to an earlier nightly ===
ALthough launchpad doesn't list older nightlies in their PPA, they are usually still available for download directly from the website. Visit the [https://launchpad.net/~team-xbmc/+archive/ubuntu/xbmc-nightly/+packages?field.name_filter=&field.status_filter=superseded&field.series_filter= xbmc-nightly repository index], where you will then have to download the appropriate .deb files and manually install them using <code>sudo dpkg -i [path to downloaded file]</code>.

=== Uninstalling ===
If you need to uninstall Kodi and purge its global configuration files (for instance, in the attempt to troubleshoot a persistent crash or other errors), do so by using the first of the following commands. If that fails to solve the issue, you will likely need to remove your user settings folder with all of your settings and library data to return to a state equivalent to what existed before Kodi was first installed on the system. This will not delete any videos or music, but just the settings and library data itself, but it is still recommended to keep a backup of them in case it's discovered that they weren't at issue and you are able to effect another solution. An example of how to accomplish a backup and then deletion of your user settings is provided on the last two lines, the highlighted one being responsible for making the backup which can thereafter be found in your home folder with the filename kodi-backup_''timestamp''.tar.xz.

<syntaxhighlight lang="shell" highlight="2-3">
sudo apt purge kodi\*
tar cf - "${HOME}/.kodi/" | xz -z9e - >"${HOME}/kodi-backup_$(date +%m%d%y-%H%M).tar.xz"
rm -Ri "${HOME}/.{kodi,xbmc}/"
</syntaxhighlight>

== Flatpak ==

If you want to use the flatpak version and do not know, if your distro supports flatpak check https://flatpak.org/setup/ for install instructions.

After you've sorted that, go to https://flathub.org/apps/details/tv.kodi.Kodi and hit the install button or copy the instructions at the end of the page to your terminal and execute them.

=== Beta channel ===
You can also run Kodi flatpak betas, if you install the flatpak beta remote.

<syntaxhighlight lang="shell" highlight="2-3">
flatpak remote-add --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
</syntaxhighlight>

Then install via
<syntaxhighlight lang="shell" highlight="2-3">
flatpak install flathub-beta tv.kodi.Kodi
</syntaxhighlight>

You should now have an entry on your system, that's labeled `Kodi (Beta)`, that you can use to run the beta. Be warned, it will use the same paths as the older versions, so they might clash. Usually they go along well, but make backups, if you need your data.

== Embedded/Appliance type install==

=== LibreELEC ===
{{main|LibreELEC}}
{{#lst:LibreELEC|intro}}

== Third Party Repositories ==


The instructions in this section are for unofficial Linux binaries that are un/semi supported by Team Kodi. Most of those binaries use system ffmpeg or even worse totally untested libav, which is not recommended for {{kodi}} as we support ffmpeg only.

=== Debian ===
Debian GNU/Linux ships its own '''Kodi from Debian''' flavor with following changes:

* Only system libraries are used (no embedded third-party libraries except of libdvdread and libdvdnav)
* Old web interface (Chorus) is shipped to ensure Debian Free Software Guides (DFSG) compatibility

as well as a subset of Kodi binary addons packaged in [https://qa.debian.org/developer.php?email=vasek.gello@gmail.com main repository of Debian].

{{Warning|'''Team Kodi offers no official support to "Kodi from Debian"!''' Please refer to links below for support!}}

The support for Kodi from Debian is provided via the following channels:
# [https://forum.kodi.tv/showthread.php?tid=363611 Kodi from Debian - Support Thread] on Kodi forums
# [https://github.com/xbmc/xbmc/issues Github issues]
# [https://bugs.debian.org Debian Bug Tracker]

==== Checking installed and available Kodi packages ====

You can check what versions of Kodi and its binary add-ons are installed with the following command:

<syntaxhighlight lang=bash>
dpkg -l | grep kodi
</syntaxhighlight>

To check what versions of Kodi are available, use this command:

<syntaxhighlight lang=bash>
apt-cache policy kodi*
</syntaxhighlight>

==== Installing Kodi on Debian Unstable or Testing ====

Installation of Kodi from Debian on Debian unstable ("sid") and testing is straightforward:

<syntaxhighlight lang=bash>
sudo apt update
sudo apt install kodi
</syntaxhighlight>

To install Kodi binary add-ons (like '''PVR IPTV Simple''', for example):

<syntaxhighlight lang=bash>
sudo apt install kodi-pvr-iptvsimple
</syntaxhighlight>

'''NOTE''': Make sure user running Kodi belongs to the following groups
(for example, for user '''kodi''')

<syntaxhighlight lang=bash>
$ groups kodi
kodi: cdrom,audio,render,video,plugdev,users,dialout,dip,input
</syntaxhighlight>

This needs to be done to ensure Video Acceleration API (VA-API) is properly initialized during Kodi start-up and videos playing get acceleration using VAAPI and not VDPAU on Intel or AMD cards. To add user to groups, use the command:

<syntaxhighlight lang=bash>
usermod -a -G cdrom,audio,render,video,plugdev,users,dialout,dip,input kodi
</syntaxhighlight>

==== Installing Kodi on Debian 10 "buster" ====

By default, Debian buster users get Kodi 17.6 "Krypton". However, it is possible to get Kodi 19.x "Matrix" from buster-backports.

To get Kodi 17.6 and the corresponding add-ons, use the method described in '''Debian Unstable or Testing''' section above.

To get Kodi 19.x and the corresponding add-ons from Debian Backports:

<syntaxhighlight lang=bash>
# Add Debian Backports repository for Debian 10 "buster"
if ! apt-cache policy 2>/dev/null | grep -q "http://.*buster-backports"; then
echo "deb http://deb.debian.org/debian/ buster-backports main contrib" | sudo tee /etc/apt/sources.list.d/buster-backports.list
fi

# Update APT lists
sudo apt-get update

# Install Kodi from backports:
sudo apt-get install {kodi,kodi-bin,kodi-data,kodi-repository-kodi,libspdlog1}/buster-backports

# (OPTIONAL) Install Kodi binary add-ons (for example, 'PVR IPTV Simple'):
sudo apt-get install kodi-pvr-iptvsimple/buster-backports
</syntaxhighlight>

==== Installing Kodi on Debian 9 "stretch" ====

By default, Debian stretch users get Kodi 17.1 "Krypton". No higher version is packaged in backports.

To get Kodi 17.1 and the corresponding add-ons, use the method described in '''Debian Unstable or Testing''' section above.

=== Raspberry Pi OS ===
{{see also|HOW-TO:Install Kodi on Raspberry Pi}}
Installing on Raspberry Pi OS is done with:

<syntaxhighlight lang=bash>
sudo apt-get install kodi
</syntaxhighlight>

Upgrading on Raspberry Pi OS is done with:

<syntaxhighlight lang=bash>
sudo apt-get update
sudo apt-get upgrade
</syntaxhighlight>

== Installation from source ==
If distribution packages are not available, or you need a newer version, or specific features enabled, then you will most likely need to compile from source. See our '''[[Compiling Kodi]]''' guide.

{{Updated|20}}

[[Category:Linux]]
[[Category:How-to]]
[[Category:Installation|Linux]]

Advancedsettings.xml

2022-01-15T10:41:14Z

Davu:

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

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

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

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

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](aka|ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

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

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

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

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

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

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

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

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

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

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

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

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

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

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

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

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

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

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

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

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

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

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

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

==== Extra artwork ====

Applies to Kodi v18 only.

Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.

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


<tvshowextraart>
<arttype>characterart</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</tvshowextraart>

<tvseasonextraart>
<arttype>landscape</arttype>
</tvseasonextraart>

<episodeextraart>
<arttype>fanart</arttype>
</episodeextraart>

<movieextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</movieextraart>

<moviesetextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</moviesetextraart>

<musicvideoextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
</musicvideoextraart>
</videolibrary>
</syntaxhighlight>

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

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useisodates>false</useisodates> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

<curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref>

=== cache ===
{{see also|HOW-TO:Modify_the_video_cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

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

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

== File system settings ==

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

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).

Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

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

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

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

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

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

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

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<controllerdeadzone>''' - Removed in v17
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

Advancedsettings.xml

2022-01-15T10:37:14Z

Davu:

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

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

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

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

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](aka|ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

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

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

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

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

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

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

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

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

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

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

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

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

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

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

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

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

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

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

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

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

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

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then}}

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

==== Extra artwork ====

Applies to Kodi v18 only.

Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.

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


<tvshowextraart>
<arttype>characterart</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</tvshowextraart>

<tvseasonextraart>
<arttype>landscape</arttype>
</tvseasonextraart>

<episodeextraart>
<arttype>fanart</arttype>
</episodeextraart>

<movieextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</movieextraart>

<moviesetextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</moviesetextraart>

<musicvideoextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
</musicvideoextraart>
</videolibrary>
</syntaxhighlight>

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

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useisodates>false</useisodates> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

<curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref>

=== cache ===
{{see also|HOW-TO:Modify_the_video_cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

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

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

== File system settings ==

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

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).

Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

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

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

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

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

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

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

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<controllerdeadzone>''' - Removed in v17
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

Ubuntu PVR add-ons

2021-08-23T22:31:45Z

Davu:

{{PVR_guide}}
{{mininav| [[PVR]] }}
__NOTOC__

<section begin="intro" />PVR client add-ons are binary [[add-ons]], but in Ubuntu they are not packaged with Kodi. All other official Kodi versions have these add-ons included with the default install. For Ubuntu, they must be installed through apt-get.<section end="intro" />

If you don't already have the Team Kodi (team-xbmc) PPA added, then you will need to do so in order to install the PVR client add-ons. See... '''[[HOW-TO:Install_Kodi_for_Linux|Install {{kodi}} for Linux]]'''

= Downloading Packages =
# Quit Kodi if it is already running
# Open a terminal window
# Type in '''sudo apt-get update''' and enter your password when prompted
# Type in '''sudo apt-get install ''PACKAGENAMEHERE'''''
#: Replace ''PACKAGENAMEHERE'' with a package name from the table below.
#: example: '''''sudo apt-get install kodi-pvr-argustv'''''
# Restart {{kodi}} to load the add-on

The PVR client add-on should now be installed.

= Activating Add-on =
Once the package is installed it is not automatically enabled. To enable the PVR add-on:
# Go to {{highlight|Settings > Add-ons > My Add-ons > PVR Clients}}
# Open the Information page for the PVR add-on
# Select '''Enable'''
# From this page, you can also adjust the add-on settings using the '''configure''' button

== Packages ==
<section begin="packages" />
{| class="prettytable"
|-
! style="width:250px; | Package name
! style="width:250px; | Description
|-
| kodi-pvr-argustv || [[Add-on:ARGUS_TV_client|Argus TV Client]]
|-
| kodi-pvr-demo || [[Add-on:PVR_Demo_Client|PVR Demo Client]]
|-
| kodi-pvr-dvblink || [[Add-on:TVMosaic/DVBLink_PVR_Client|DVBLink Client]]
|-
| kodi-pvr-dvbviewer || [[Add-on:DVBViewer_Client|DVBViewer Client]]
|-
| kodi-pvr-filmon || [[Add-on:PVR_Filmon_Client|Filmon PVR Client]]
|-
| kodi-pvr-freebox || [[Add-on:PVR_Freebox_TV|Freebox TV Client]]
|-
| kodi-pvr-hdhomerun || [[HDHomeRun]]
|-
| kodi-pvr-hts || [[Add-on:Tvheadend_HTSP_Client|Tvheadend HTSP Client]]
|-
| kodi-pvr-iptvsimple || [[Add-on:PVR_IPTV_Simple_Client|IPTV Simple Client]]
|-
| kodi-pvr-mediaportal-tvserver || [[Add-on:MediaPortal_PVR_Client|MediaPortal Client]]
|-
| kodi-pvr-mythtv || [[Add-on:MythTV_PVR_Client|Myth TV Client]]
|-
| kodi-pvr-nextpvr || [[Add-on:NextPVR_PVR_Client|NextPVR Client]]
|-
| kodi-pvr-njoy || [[Add-on:Njoy_N7_PVR_Client|Njoy PVR Client]]
|-
| kodi-pvr-octonet || [[Add-on:Digital_Devices_Octopus_NET_Client|Octonet Net Client]]
|-
| kodi-pvr-pctv || [[Add-on:PCTV_Systems_Client|PCTV Systems Client]]
|-
| kodi-pvr-plutotv || [[Add-on:Pluto.TV|Pluto TV Client]]
|-
| kodi-pvr-sledovanitv-cz || [[Add-on:PVR_Client_for_sledovanitv.cz_(unofficial)|sledovanitv.cz PVR Client]]
|-
| kodi-pvr-stalker || [[Add-on:Stalker_Client|Stalker Client]]
|-
| kodi-pvr-teleboy || [[Add-on:Teleboy_PVR_Client|Teleboy PVR Client]]
|-
| kodi-pvr-vbox || [[Add-on:VBox_TV_Gateway_PVR_Client|VBox Home TV Gateway Client]]
|-
| kodi-pvr-vdr-vnsi || [[VDR|VDR Client]]
|-
| kodi-pvr-vuplus || [[Add-on:Enigma2_Client|Enigma2 Client]]
|-
| kodi-pvr-waipu || [[Add-on:Waipu.tv_PVR_Client|Waipu PVR Client]]
|-
| kodi-pvr-wmc || [[ServerWMC]]
|-
| kodi-pvr-zattoo || [[Add-on:Zattoo_PVR_Client|Zattoo PVR Client]]
|}
<section end="packages" />

{{top}}
{{updated|19}}

[[Category:PVR]]
[[Category:Index]]
[[Category:Linux]]
[[Category:Manual]]
[[Category:Karellen]]

Ubuntu PVR add-ons

2021-08-23T05:28:00Z

Davu:

{{PVR_guide}}
{{mininav| [[PVR]] }}
__NOTOC__

<section begin="intro" />PVR client add-ons are binary [[add-ons]], but in Ubuntu they are not packaged with Kodi. All other official Kodi versions have these add-ons included with the default install. For Ubuntu, they must be installed through apt-get.<section end="intro" />

If you don't already have the Team Kodi (team-xbmc) PPA added, then you will need to do so in order to install the PVR client add-ons. See... '''[[HOW-TO:Install_Kodi_for_Linux|Install {{kodi}} for Linux]]'''

= Downloading Packages =
# Quit Kodi if it is already running
# Open a terminal window
# Type in '''sudo apt-get update''' and enter your password when prompted
# Type in '''sudo apt-get install ''PACKAGENAMEHERE'''''
#: Replace ''PACKAGENAMEHERE'' with a package name from the table below.
#: example: '''''sudo apt-get install kodi-pvr-argustv'''''
# Restart {{kodi}} to load the add-on

The PVR client add-on should now be installed.

= Activating Add-on =
Once the package is installed it is not automatically enabled. To enable the PVR add-on:
# Go to {{highlight|Settings > Add-ons > My Add-ons > PVR Clients}}
# Open the Information page for the PVR add-on
# Select '''Enable'''
# From this page, you can also adjust the add-on settings using the '''configure''' button

== Packages ==
<section begin="packages" />
{| class="prettytable"
|-
! style="width:250px; | Package name
! style="width:250px; | Description
|-
| kodi-pvr-argustv || [[Add-on:ARGUS_TV_client|Argus TV Client]]
|-
| kodi-pvr-demo || [[Add-on:PVR_Demo_Client|PVR Demo Client]]
|-
| kodi-pvr-dvblink || [[Add-on:TVMosaic/DVBLink_PVR_Client|DVBLink Client]]
|-
| kodi-pvr-dvbviewer || [[Add-on:DVBViewer_Client|DVBViewer Client]]
|-
| kodi-pvr-filmon || [[Add-on:PVR_Filmon_Client|Filmon PVR Client]]
|-
| kodi-pvr-freebox || [[Add-on:PVR_Freebox_TV|Freebox TV Client]]
|-
| kodi-pvr-hdhomerun || [[HDHomeRun]]
|-
| kodi-pvr-hts || [[Add-on:Tvheadend_HTSP_Client|Tvheadend HTSP Client]]
|-
| kodi-pvr-iptvsimple || [[Add-on:PVR_IPTV_Simple_Client|IPTV Simple Client]]
|-
| kodi-pvr-mediaportal-tvserver || [[Add-on:MediaPortal_PVR_Client|MediaPortal Client]]
|-
| kodi-pvr-mythtv || [[Add-on:MythTV_PVR_Client|Myth TV Client]]
|-
| kodi-pvr-nextpvr || [[Add-on:NextPVR_PVR_Client|NextPVR Client]]
|-
| kodi-pvr-njoy || [[Add-on:Njoy_N7_PVR_Client|Njoy PVR Client]]
|-
| kodi-pvr-octonet || [[Add-on:Digital_Devices_Octopus_NET_Client|Octonet Net Client]]
|-
| kodi-pvr-pctv || [[Add-on:PCTV_Systems_Client|PCTV Systems Client]]
|-
| kodi-pvr-plutotv || [[Add-on:Pluto.TV|Pluto TV Client]]
|-
| kodi-pvr-sledovanitv-cz || [[Add-on:PVR_Client_for_sledovanitv.cz_(unofficial)|sledovanitv.cz PVR Client]]
|-
| kodi-pvr-stalker || [[Add-on:Stalker_Client|Stalker Client]]
|-
| kodi-pvr-teleboy || [[Add-on:Teleboy_PVR_Client|Teleboy PVR Client]]
|-
| kodi-pvr-hts || [[Add-on:Tvheadend_HTSP_Client| TVHeadend Client]]
|-
| kodi-pvr-vbox || [[Add-on:VBox_TV_Gateway_PVR_Client|VBox Home TV Gateway Client]]
|-
| kodi-pvr-vdr-vnsi || [[VDR|VDR Client]]
|-
| kodi-pvr-vuplus || [[Add-on:Enigma2_Client|Enigma2 Client]]
|-
| kodi-pvr-waipu || [[Add-on:Waipu.tv_PVR_Client|Waipu PVR Client]]
|-
| kodi-pvr-wmc || [[ServerWMC]]
|-
| kodi-pvr-zattoo || [[Add-on:Zattoo_PVR_Client|Zattoo PVR Client]]
|}
<section end="packages" />

{{top}}
{{updated|19}}

[[Category:PVR]]
[[Category:Index]]
[[Category:Linux]]
[[Category:Manual]]
[[Category:Karellen]]

Settings/System/Audio

2021-06-25T06:40:04Z

Davu:

{{mininav| [[Settings]] | [[Settings/System|System]] }}

__TOC__

<section begin="intro" />This page contains the options and settings to ensure your audio device functions correctly with {{kodi}}. The settings chosen here can have a big impact on CPU load on lower powered hardware, so it is worth the time to understand the available options and how they should be configured.

The options shown in the images are from a Windows 10 HTPC and may differ from other hardware platforms. Some options change depending on whether an WASAPI or Direct Sound driver is selected in the Output selector.

If this is your first time adjusting the Audio Settings you may like to use the '''''[[Audio_quickstart_guide|Audio Quick Start Guide]]'''''. <section end="intro" />

:'''''See Also: [[Audio]]'''''
:'''''See Also: [[AudioEngine|Audio Engine]]'''''
{{-}}

= Audio Decoder =
Select your Audio device and configure it to match your audio system.
<gallery mode="packed" widths="700px" heights="394px">
File:Settings-System-Audio-01.jpg
</gallery>

== Audio output device ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Select the device to be used for playback of '''decoded''' audio.<br>
If you do not have an AVR or TV that can decode all audio stream formats then {{kodi}} will decode the audio stream.
Even if you do have an AVR, not all audio can be sent via passthrough- eg flac, mp3, wav and other music files and AAC audio streams<br>
This setting nominates which audio device {{kodi}} should use.
Windows users should select '''WASAPI'''
|-
| '''See Also:'''
| '''''[[Windows_audio|Windows Audio Driver Setup]]'''''
|-
| '''See Also:'''
| '''''[[PulseAudio|Pulse Audio Driver Setup]]'''''
|}

== Number of channels ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Select the number of channels supported by the audio connection, or the number of speakers if connected by analogue connections. This setting does not apply to passthrough audio.<br>
Note: S/PDIF supports 2.0 channels only but can still output multichannel audio using a format supported by passthrough.
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Output configuration ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Set the properties of the audio output. Available options are as follows:
* '''Fixed''' - Output properties are set to the specified sampling rate & speaker configuration at all times.
* '''Best Match''' - Output properties are set to always be as close a match to the source properties as possible.
* '''Optimised''' - Output properties are set at the start of playback and will not change if the properties of the source change.
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Volume control steps ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This is the number of button presses to go from mute to full volume. Higher numbers for finer volume adjustments.
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Maintain original volume on downmix ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Downmixing combines the Left, Right, Center, Left surround, and Right surround channels to drive stereo or mono speakers. Select how audio is downmixed. eg from 5.1 to 2.0<br>
* '''Enabled'''- Maintains the volume level of the original audio source, however the dynamic range is compressed.
* '''Disabled'''- Maintains the dynamic range of the original audio source when downmixed however the volume will be lower.<br>
Note: Dynamic range is the difference between the quitest and loudest sounds. Enable this if you find that the movie dialogues are very low.<br>
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Stereo upmix ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Select to enable upmixing of 2 channel audio to the number of audio channels specified by the Output Configuration setting above.
|}

== Resample quality ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source. Available options are...
* '''Low'''- Is fast and will have minimal impact on system resources such as the use of the CPU.
* '''Medium & High'''- Uses progressively more system resources.
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Threshold for pitch correction ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| When the speed change exceeds this threshold, a pitch correction filter will be applied to reduce the "chipmonk" effect of voices. This can occur when using 1.5x playback speed. Can be set from 0 to 100
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Keep audio device alive ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Select the behaviour when no sound is required for either playback or GUI Sounds. Available options are...
* '''Always'''- Continuous inaudible signal is output which keeps the receiving audio equipment alive for any new sounds, however this might also block sound from other applications.
* '''1-10 Minutes'''- Same as '''Always''' except the audio device will be allowed to sleep after the selected period expires
* '''Off'''- Audio output enters a suspended state.<br>
Note: Sounds can be missed if the system is slow in waking.
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Send low volume noise ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| To keep AV Receivers awake, an inaudible random noise signal is sent. This setting can be disabled when using headphones or analogue outputs.
|}

= GUI Sounds =
This section deals with feedback and confirmation sounds created by the {{kodi}} user interface.
<gallery mode="packed" widths="700px" heights="394px">
File:Settings-System-Audio-02.jpg
</gallery>

== Play GUI sounds ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Configure when you want to hear the sounds. Available options are...
* '''Only when playback is stopped''' (default)
* '''Always'''
* '''Never'''
|}

== GUI sounds ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Select the preferred sound theme. More are available for download.
|}

= Audio Passthrough =
If you have an AVR, then using Passthrough will send the raw audio stream to the AVR for decoding.

Passthrough capable hardware and an AV Receiver capable of decoding some or all of the formats listed below is required.

Any formats that the Receiver cannot decode will be decoded by the {{kodi}} ''Audio Output Decoder'' using the Output Audio Device specified in setting 1.1 above.

If you have a quality AV Receiver, Audio Passthrough should be used.

'''''Note:'''''<br>
Do not enable a codec type if the AV Receiver does not support that codec. Doing so will result in poor playback of video, typically with very low frames-per-second video and no audio.

If connected directly to a TV be aware that TV's are not compatible with DTS, TrueHD or DTS-HD. Typically '''AC3''' is the only encoded format a TV will be compatible with.

<gallery mode="packed" widths="700px" heights="394px">
File:Settings-System-Audio-03.jpg
</gallery>

== Allow Passthrough ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select to allow passthrough audio for playback of compressed audio such as Dolby Digital (AC3), DTS, etc. The Client of the AudioEngine might decide to decode the audio stream under certain conditions.
{{red|'''Note:''' Enabling the setting '''''[[Settings/Player/Videos#Sync_playback_to_display|Sync Playback to Display]]''''' will disable Passthrough as audio corrections will need to be made to perform the sync operations.}}
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

== Passthrough output device ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the device to be used for passthrough of the encoded formats. Windows users should use WASAPI as passthrough is not available for all codecs when using DirectSound.
The following codecs can be passed through and should be set in accordance with the capabilities of the AV Receiver:
* Dolby Digital (AC3) capable Receiver
** Enable Dolby Digital (AC3) transcoding
:: Note: Use this option to play a movie which uses DTS but your AVR isn't DTS capable to end up with Dolby Digital.
* DTS capable receiver
* TrueHD capable receiver
* DTS-HD capable receiver
|-
| '''See Also:'''
| '''''[[Audio_quickstart_guide|Audio Settings]]'''''
|}

= References =
<references />

{{top}}
{{updated|19}}

[[Category:Settings]]

Advancedsettings.xml

2021-05-20T18:04:52Z

Davu:

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

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

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

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

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default).
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

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

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

==== pvrrecordings ====
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

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

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

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

== Video library settings ==

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

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

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

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

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

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

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

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

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

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

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

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

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

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

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

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

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

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

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

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

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

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

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

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

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

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

==== Extra artwork ====

Applies to Kodi v18 only.

Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.

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


<tvshowextraart>
<arttype>characterart</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</tvshowextraart>

<tvseasonextraart>
<arttype>landscape</arttype>
</tvseasonextraart>

<episodeextraart>
<arttype>fanart</arttype>
</episodeextraart>

<movieextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</movieextraart>

<moviesetextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</moviesetextraart>

<musicvideoextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
</musicvideoextraart>
</videolibrary>
</syntaxhighlight>

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

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

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

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

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

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

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

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

=== fanart ===
{{anchor|.3Cfanart.3E}}
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)
*Used for '''music only'''
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.

Example:
<syntaxhighlight lang=xml enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
<section begin="musicthumbs" />A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang=xml enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight><section end="musicthumbs" />

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useisodates>false</useisodates> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

==== Music library extra artwork ====

New for Kodi v18.
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "thumb" for artists and albums, and "fanart" for artists.

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


<artistextraart>
<arttype>banner</arttype>
<arttype>clearlogo</arttype>
<arttype>clearart</arttype>
<arttype>landscape</arttype>
</artistextraart>

<albumextraart>
<arttype>discart</arttype>
<arttype>spine</arttype>
<arttype>back</arttype>
</albumextraart>
</musiclibrary>
</syntaxhighlight>

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

=== cache ===
{{see also|HOW-TO:Modify_the_video_cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

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

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

== File system settings ==

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

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

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

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

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

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

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

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

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<controllerdeadzone>''' - Removed in v17
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

Image Control

2020-08-29T08:00:52Z

Davu:

{{mininav| [[Skinning]] }}
<section begin="main content" />
The image control is used for displaying images in Kodi. You can choose the position, size, transparency and contents of the image to be displayed.

= Texture Loading =
== Normal texture loading ==
The only textures loaded by Kodi are the ones currently visible. Nothing displays on the screen until all the images have been loaded in memory, this can result in "jerky" scrolling through panel containers. As you scroll down, Kodi will delay the scrolling animation until all of the images in the next row are loaded.

== Background loading ==
Images are loaded one at a time in a background worker thread and are shown as soon as xbmc processes them. Has the benefit that images can be loaded into memory before they're visible, resulting in smoother scrolling and transitions.

== Preloading ==
Used to automatically load the next items (or rows/columns in the case of a panel) while scrolling. Currently limited to 2.

= Example =
<syntaxhighlight lang="xml" enclose="div">
<control type="image" id="1">
<description>My first image control</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<fadetime>200</fadetime>
<texture border="5" flipy="true" flipx="false">mytexture.png</texture>
<bordertexture border="5">mybordertexture.png</bordertexture>
<bordersize>5</bordersize>
<aspectratio>keep</aspectratio>
</control>
</syntaxhighlight>

= Image Size and Type Restrictions =
For the <texture> tags, and for all <texture> tags in other controls, there is a small set of rules that you should follow if at all possible:

= Size =
Images can be any size, though some graphics cards allow only power of 2 textures, so this may be a consideration. For the most case, it doesn't really matter what size things are - Kodi will quite happily load most files.

= Formats =
If you wish to use transparency, then use PNG. It is suggested that you use PNG and JPG as much as possible. Note that once the images are injected into Textures.xbt, they are not stored as JPG or PNG – rather they are stored in a native format used for GPUs for faster loading, such as ARGB or DXTc textures. The size of the images (in kb) is therefore not as important as the size of the images in pixels – so feel free to store them in a lossless (eg PNG) manner if you wish.

The only exception to this is if you require an animated texture. In this case, we support only animated GIF. There are also some animated gifs that may not work. Use ImageReady CS and make sure you set the gif-anim to “restore to background” and they should work fine.

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

{| class="prettytable"
! Tag !! Description
|-
| '''aspectratio'''
| This specifies how the image will be drawn inside the box defined by <code><width></code> and <code><height></code>. [[Aspect Ratio|See here for more information]].
|-
| '''texture'''
| Specifies the image file which should be displayed. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''bordertexture'''
| Specifies the image file which should be displayed as a border around the image. Use the <code><bordersize></code> to specify the size of the border. The <code><width></code>,<code><height></code> box specifies the size of the image plus border.
|-
| '''bordersize'''
| Specifies the size of the border. A single number specifies the border should be the same size all the way around the image, whereas a comma separated list of 4 values indicates left,top,right,bottom values.
|-
| '''info'''
| Specifies the information that this image control is presenting. Kodi will select the texture to use based on this tag. [[InfoLabels|See here for more information.]]
|-
| '''fadetime'''
| This specifies a crossfade time that will be used whenever the underlying <texture> filename changes. The previous image will be held until the new image is ready, and then they will be crossfaded. This is particularly useful for a large thumbnail image showing the focused item in a list, or for fanart or other large backdrops.
|-
| '''background'''
| For images inside a container, you can specify background="true" to load the textures in a background worker thread.
|}

<section end="main content" />

[[Category:Skin development]]

Avahi Zeroconf

2020-08-18T23:03:48Z

Davu:

__TOC__
== General ==
=== What is Avahi (Zeroconf) ===
<section begin="intro"/>Avahi is a system which facilitates service discovery on a local network via the mDNS/DNS-SD protocol suite. This enables Kodi to recognize media sources inside your local network without knowing where the sources are located and what protocol is used. Compatible technology is found in Apple MacOS X (branded Bonjour and sometimes Zeroconf). Avahi is available for linux and derivates (BSD) afaik.<section end="intro"/>

For more details have a look at [http://www.avahi.org avahi.org].

=== Installing ===
Since the Installation of Avahi depends on the used operating system please realise that this page only covers the configuration of static service announcements (for services which don't have avahi support included). For installation instructions just use a www search engine with the keywords "install avahi on <enter operting system here".

== Services supported by Kodi ==

Kodi can receive service announcements for the following protocols: samba, FTP, HTSP, WebDAV, NFS and SFTP (ssh server).

Most HTSP, samba (minimum version 3.3.x), WEBDAV and iTunes (DAAP) servers are supposed to have support for zeroconf built in. This means that these services should be announcent automatically when avahi is installed. No static service announcement configuration should be needed then.

== Static service announcement ==
=== What about it? ===
For services which don't support zeroconf registration there is an easy possibility to make avahi announce them. For each service which should be announced there has to be a configuration file. Normally these files should reside in /etc/avahi/services and end with the file extension ".service". The Kodi zeroconf browser supports txt-records. This means that it can parse some of the official DNS-SD keys (see [http://www.dns-sd.org/ServiceTypes.html ServiceTypes] under "Defined TXT keys"). Kodi parses the "path","u"(username) and "p"(password) keys. This allows to specify a complete service including the path and account information for accessing it.

'''The Avahi daemon has to run on the same server which hosts the services which should be announced.'''

The section below has some sample configurations which would allow static announcements for the supported protocols. For general information according to the config files see the [http://avahi.org/download/avahi.service.5.xml official man page].

=== Sample service configurations ===

==== NFS service (/etc/avahi/services/nfs.service) ====
The following configuration would announce a NFS server (with the nfs default port 2049) with the exported path ''/path/to/nfsexport''. Kodi Zeroconf browser would show this entry as ''NFS server at <name of server>''. The "%h" gets substituted by the hostname of the server. When clicking this entry - Kodi would show the available path on that service with ''/path/to/nfsexport''. Clicking on that one would generate the following url: '''nfs://<ip of server>:2049/path/to/nfsexport/'''

<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
<name replace-wildcards="yes">NFS server at %h</name>
<service>
<type>_nfs._tcp</type>
<port>2049</port>
<txt-record>path=/path/to/nfsexport</txt-record>
</service>
</service-group>

==== WEBDAV service (/etc/avahi/services/webdav.service) ====
The following configuration would announce a WebDAV server (e.x. apache at port 80) with the accessible path ''/webdav/path''. Kodi Zeroconf browser would show this entry as ''WebDav on <name of server>''. The "%h" gets substituted by the hostname of the server. When clicking this entry - Kodi would show the available path on that service with ''/webdav/path''. Clicking on that one would generate the following url: '''dav://<ip of server>:80/webdav/path/'''.

<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
<name replace-wildcards="yes">WebDav on %h</name>
<service>
<type>_webdav._tcp</type>
<port>80</port>
<txt-record>path=/webdav/path</txt-record>
</service>
</service-group>

==== SFTP service (/etc/avahi/services/sftp.service) ====
The following configuration would announce a sftp/ssh server (on default port 22) with the accessible path ''/path/to/be/accessed'', the user ''sshuser'' and the password ''sshpass''. Kodi Zeroconf browser would show this entry as ''SFTP on <name of server>''. The "%h" gets substituted by the hostname of the server. When clicking this entry - Kodi would show the available path on that service with ''/path/to/be/accessed''. Clicking on that one would generate the following url: '''sftp://sshuser:sshpass@<ip of server>:22/path/to/be/accessed/'''.

<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
<name replace-wildcards="yes">SFTP on %h</name>
<service>
<type>_sftp-ssh._tcp</type>
<port>22</port>
<txt-record>path=/path/to/be/accessed</txt-record>
<txt-record>u=sshuser</txt-record>
<txt-record>p=sshpass</txt-record>
</service>
</service-group>

==== FTP service (/etc/avahi/services/ftp.service) ====
The following configuration would announce a FTP server (on default port 21) with the accessible path ''/ftppath'', the user ''ftpuser'' and the password ''ftppass''. Kodi Zeroconf browser would show this entry as ''FTP on <name of server>''. The "%h" gets substituted by the hostname of the server. When clicking this entry - Kodi would show the available path on that service with ''/ftppath''. Clicking on that one would generate the following url: '''ftp:/ftpuser:ftppass@<ip of server>:21/ftppath/'''.

<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
<name replace-wildcards="yes">FTP on %h</name>
<service>
<type>_ftp._tcp</type>
<port>21</port>
<txt-record>path=/ftppath</txt-record>
<txt-record>u=ftpuser</txt-record>
<txt-record>p=ftppass</txt-record>
</service>
</service-group>

==== SAMBA service - pre 3.3.x (/etc/avahi/services/smb.service) ====
The following configuration would announce a SAMBA server (on default port 445). Kodi Zeroconf browser would show this entry as ''SAMBA on <name of server>''. The "%h" gets substituted by the hostname of the server. When clicking this entry - Kodi would show the available shares on that samba server.

<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
<name replace-wildcards="yes">SAMBA on %h</name>
<service>
<type>_smb._tcp</type>
<port>445</port>
</service>
</service-group>

[[Category:File sharing]]

Advancedsettings.xml

2020-07-16T22:56:33Z

Davu: /* Network settings */

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

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

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

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

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default).
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang=xml enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

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

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

Default: Off



== Video library settings ==

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

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

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

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

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

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

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

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

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

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

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

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

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

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

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

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

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

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

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

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

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

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

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

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

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

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

==== Extra artwork ====

New for Kodi v18.
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.

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


<tvshowextraart>
<arttype>characterart</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</tvshowextraart>

<tvseasonextraart>
<arttype>landscape</arttype>
</tvseasonextraart>

<episodeextraart>
<arttype>fanart</arttype>
</episodeextraart>

<movieextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</movieextraart>

<moviesetextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</moviesetextraart>

<musicvideoextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
</musicvideoextraart>
</videolibrary>
</syntaxhighlight>

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

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

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

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

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

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

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

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

=== fanart ===
{{anchor|.3Cfanart.3E}}
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)
*Used for '''music only'''
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.

Example:
<syntaxhighlight lang=xml enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
<section begin="musicthumbs" />A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang=xml enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight><section end="musicthumbs" />

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useartistsortname>false</useartistsortname> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

==== Music library extra artwork ====

New for Kodi v18.
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "thumb" for artists and albums, and "fanart" for artists.

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


<artistextraart>
<arttype>banner</arttype>
<arttype>clearlogo</arttype>
<arttype>clearart</arttype>
<arttype>landscape</arttype>
</artistextraart>

<albumextraart>
<arttype>discart</arttype>
<arttype>spine</arttype>
<arttype>back</arttype>
</albumextraart>
</musiclibrary>
</syntaxhighlight>

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

<syntaxhighlight lang=xml enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
</network>
</syntaxhighlight>

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

=== cache ===
{{see also|HOW-TO:Modify_the_video_cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

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

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

== File system settings ==

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

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

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

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

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

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

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

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

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

== Removed tags ==
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<controllerdeadzone>''' - Removed in v17

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang=xml enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

= References =
<references />

{{Updated|17}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

Android hardware

2020-06-18T15:25:28Z

Davu:

{{mininav|[[Android]]}}
<section begin="intro" />For most [[wikipedia:High-definition video|high-definition video]]s (1080p or higher resolution), hardware video decoding is necessary for smooth video playback on most Android devices. Therefor this article contains a list of SoC chipset hardware, (SoC stands for "System on a Chip" which contain the CPU plus GPU and VPU circuits combination, and is also known as a "chipset"), as on Android platforms this SoC chipset is what can playback common video codecs smoothly using Kodi/XBMC.<section end="intro" />

The fact is, while some devices might be able to smoothly decode [[wikipedia:Standard-definition television|standard-definition video]]s and even some 720p or higher resolution videos using only software video decoding with raw CPU compute power, offloading a large part of video decoding tasks to an integrated VPU (Video Processor Unit) that is optimized specifically for this job is considered essential for almost all Android devices to be able to smoothly playback high definition videos.

==Basic requirements==
{{see also|Supported hardware}}
{{#lst:Supported hardware|Android}}

==How do I know what chipset I have?==
There are so many out there so it can something be difficult to find out, but these are some good websites for looking up the SoC (System on a Chip) chipset used in your Android hardware device:

* http://www.iboum.com - Digital media players
* http://gsmarena.com - Phones
* [[Wikipedia:Comparison of Android devices]]
* http://www.androidcentral.com/devices

Also as a reference you can compare different SoC (System on a Chip) chipset specifications on system-on-a-chip.findthebest.com as well as in http://docs.google.com/spreadsheets/d/1GT7I4P8MDlfYvRaL9Wv0NplQJryl54pO_6-9P3g7Fvk/

==Compatible chipsets==
These specific mass-market hardware SoC chipsets listed below should be capable at least partial hardware accelerated video decoding support for the more popular video codecs in the latest official Kodi builds for Android. Also understand that for some devices you might first need to upgrade the hardware firmware image on the device to achieve smooth playback at 1080p or higher resolution. Please contact your hardware manufacturer support for an updated system update firmware and apply that upgrade image before installing Kodi.

{{warning|These pages are maintained by the community and should not be considered an endorsement or recommendation. The information on this page might contain errors. It might also contain ants, and their antsy antics. '''[[Kodi:General disclaimer|*]]''' }}

{|
| A "|| {{yes}} ||" mark indicates that SoC (System-on-a-Chip) chipset should be able to decode those codecs at least 1080p in Kodi without issues.
|}
{| width="100%" class="datatable"
|-
! rowspan="2" | Chip<br />manufacturer !! rowspan="2" | SoC chipset !! rowspan="2" | Examples of media players / development boards running Android and using these SoC chipsets with Kodi support !! colspan="5" | Hardware video decoding !! rowspan="2" | Notes
|-
! H.264 !! MPEG-2 !! VC-1 / WMV 9 !! HEVC (H.265) !! VP9
|-
| Allwinner || A31 / A31s / A33 || Justop Quadro, Mele A1000G/M8/M9, Measy B4K/U4K, VidOn Box, VidOn.me AV200 || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || <ref name="Open-source violator">Warning for open source violators that do not comply with Kodi's GPL license! There are a few SoC manufacturers, like example Allwinner and Realtek or media player using their chipsets, that violate the GPL license that Kodi (and XBMC before) is bound under. This type of violation done by forking and not releasing all source code that they integrate into Kodi / XBMC when they modify or add closed source code or non-complatible code. This is because Kodi's code is bound under an open source license that require that all code integrating with Kodi's own GPL project is also releasing under a GPL compatible license. Other that hurting the Kodi project by not contributing as required, the risk for end-users buying hardware that rely on open source violations is not getting any support for the official Kodi project.</ref>
|-
| Allwinner || A80 / A83T || Tronsmart Draco AW80, Rikomagic MK80 || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || <ref name="Open-source violator"/>
|-
| [[Amlogic]] || AML8726-M1 / AML8726-M3 / AML8726-M6 / AML8726-MX / AML8726-MXS / AML8726-MXL || [[Pivos XIOS|Pivos XIOS DS/XS]], GameStick (by PlayJam), Geniatech ATV1220/ATV520/ATV1610, MyGica ATV420/ATV500/ATV1610, JynxBox M1/M6, Matricom G-Box Midnight MX2, [[WeTek Play]] || {{yes}} || {{yes}} || {{yes}} || {{no}} || {{no}} ||
|-
| [[Amlogic]] || S801 / M802 / S802 / M802 (formerly AML8726-M8) || Geniatech ATV582 / MyGica ATV582, Minix Neo X8/X8-H, Eny Technology ES8, Tronsmart Vega S89/S89-H, Beelink S82/S82H/M8, Xiaomi Mi Box Enhanced || {{yes}} || {{yes}} || {{yes}} || {{no}} || {{no}} ||
|-
| [[Amlogic]] || S805 / M805 / S806 / M806 / S812 || Eny Technology EM9/M8S/M8C/EM6Q-MXQ, Geniatech ATV585/ATV1810 / MyGica ATV585/ATV1810, Minix NEO X6 /X8-H Plus, [[ODROID|Hardkernel ODROID-C1]], Ugoos S85, SkyStream X5, Sumvision Cyclone X4, Xtreamer Wonder, Beelink S82 Plus, WeTek Core || {{yes}} || {{yes}} || {{yes}} || {{yes}}<br />{{smaller|(8-bit only)}} || {{?}} || <ref name="8-bit Main HEVC (H.265) profile support only">Some SoC's hardware video decoders like the one in Amlogic S805/M805/S806/M806/S812 and Rockchip RK3288/RK3368 are limited to only supporting the Main HEVC (H.265) profile, which means that they only support 8-bit color range and lower bit-rate, and they do therefor not support the Main10 HEVC or Main12 profiles which is uses for 10-bit and 12-bit color ranges respectivly, which also require support for higher bit-rates. This usually also means that they will not be capable of playing HEVC videos encoded in 4K (2160p) resolution at 60 FPS (frames per second). For more information see http://en.wikipedia.org/wiki/High_Efficiency_Video_Coding_tiers_and_levels</ref>
|-
| [[Amlogic]] || S905 || Beelink MINI MX, Geniatech ATV495/ATV1950, MyGica ATV49/ATV1950, [[ODROID|Hardkernel ODROID-C2]], Ugoos AM1/AM2 || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{?}} ||
|-
| [[Amlogic]] || S905D / S905M / S905X / S908 || [[Xiaomi Mi Box|Xiaomi Mi Box (2016)]] / Xiaomi Mi Box 3 / Xiaomi Mi Box S (2018) || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} ||
|-
| [[Amlogic]] || S912 || Beelink GT1, Eny Technology Enybox X2, Rikomagic MK22, Videostrong KM8 Pro || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} ||
|-
| Broadcom || BCM2836 / BCM2837 || || {{?}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| Broadcom || BCM28145 / BCM28155 || [[Amazon Fire TV Stick|Amazon Fire TV Stick (2014/2015)]] || {{yes}} || {{yes}} || {{yes}} || {{no}} || {{yes}} ||
|-
| [[Freescale]]/NSX || i.MX 6 series (i.MX6 / i.MX6S / i.MX6SL / i.MX6D / i.MX6DL / i.MX6Q) || [[CompuLab Utilite]], [[SolidRun CuBox-i|SolidRun CuBox-i & CuBoxTV]], [[SolidRun Hummingboard]], [[UDOO|UDOO Neo/Duo/Quad]], [[Wandboard|Wandboard Solo/Dual/Quad ]] || {{?}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| HiSilicon || Hi3798C V200 || HiMedia Q10 Pro || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} ||
|-
| Intel || Atom E3815 / E3825 || Intel MinnowBoard MAX Development Board || {{?}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| Intel || Atom Z3530 / Z3560 / Z3580 / Z3735 || [[Google Nexus Player]], Minix Neo Z64 || {{yes}} || {{no}} || {{no}} || {{no}} || {{no}} ||
|-
| Intel || Celeron N3000 / N3050 / N3150, and Pentium N3700 || ASRock Beebox, Gigabyte BRIX|| {{yes}} || {{yes}} || {{yes}} || {{no}} || {{no}} ||
|-
| Intel || Core M3 6Y30 / M5 6Y54 / M5 6Y57 / M5 6Y75 || Intel Compute Stick || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} ||
|-
| MediaTek || MT5890 || Sony Android TV (2015 and 2016) || {{yes}} || {{yes}} || {{no}} || {{yes}} || {{yes}} <br />{{smaller|(4K TV only)}} ||
|-
| MediaTek || MTK6589 / MT6589 / MT6589T / MT6589M || || {{?}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| MediaTek || MT8127 || Amazon Fire Tablet (7", 2015), Amazon Fire TV Stick with Alexa (2016) || {{yes}} || {{no}} || {{no}} || {{yes}} || {{yes}} ||
|-
| MediaTek || MT8173 || [[Amazon Fire TV|Amazon Fire TV (2015)]] || {{yes}} || {{yes}} || {{no}} || {{yes}} || {{yes}} ||
|-
| MStar || MSO9180 / MSO9180D1R / MSO9280 / MSO9810 || Egreat A9, Kaiboer F5/Q6/C9-M, MeLE V10/X2000, UyeSee T1H, Tronsmart Pavo M9, Xtreamer Prodigy, Zidoo X9 || {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} ||
|-
| Nvidia || [[Tegra 3]] || [[OUYA]] || {{yes}} || {{no}} || {{no}} || {{no}} || {{no}} ||
|-
| Nvidia || [[Tegra 4]] / [[Tegra 4i]] / [[Tegra 4s]] || ZTE FunBox, Mad Catz M.O.J.O., NanoTech Nuvola NP-1 / NP-C / NP-H1, UTStarcom MC8768, Google ADT-1 (Android TV Developer Kit), [https://en.wikipedia.org/wiki/Shield_Portable Nvidia SHIELD Portable] || {{Yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{?}} || {{no}} || {{no}} ||
|-
| Nvidia || [[Tegra K1|Tegra K1 (TK1)]] || Unuiga Game PC U1, Snail Games OBox, UTStarcom MC8718, [https://en.wikipedia.org/wiki/Shield_Tablet#Shield_Tablet_K1 Nvidia SHIELD Tablet K1] || {{Yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{?}} || {{no}} || {{no}} ||
|-
| Nvidia || [[Tegra X1|Tegra X1 (TX1)]] || [[Nvidia SHIELD TV]] || {{Yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{yes}}<br />{{smaller|(CPU)}} || {{Yes}} || {{yes}} ||
|-
| Qualcomm || Snapdragon 210 / 212 || || {{?}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| Qualcomm || Snapdragon 410 / 412 / 415 / 425 / 430 / 435 || DragonBoard 410c (Turn off "MediaCodec" HW acceleration). Nobel64 Development Board || {{yes}} || {{yes}} || {{?}} || {{no}} || {{no}} ||
|-
| Qualcomm || Snapdragon 600 || [[Amazon Fire TV|Amazon Fire TV (2014)]], Compulab Utilite2, DragonBoard 600c, Inforce 6410Plus Development Board, Intrinsyc Open-Q 600 Development Board || {{yes}} || {{yes}} || {{yes}} || {{no}} || {{no}} ||
|-
| Qualcomm || Snapdragon 617 || Lenovo Moto G4 || {{yes}} || {{yes}} || {{no}} || {{yes}} || {{yes}} ||
|-
| Qualcomm || Snapdragon 652 || Samsung Galaxy Tab S2 || {{yes}} || {{no}} || {{yes}} || {{yes}} || {{yes}} ||
|-
| Qualcomm || Snapdragon 800 / 801 / 805 || [[Razor Forge TV]] || {{?}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| Qualcomm || Snapdragon 808 / 810 / 820 || HTC M9 (Turn off "MediaCodec" HW accelleration) || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{?}} ||
|-
| Qualcomm || Snapdragon S4 || || {{yes}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| Realtek || RTD1195 (RTK 1195) || || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || <ref name="Open-source violator"/>
|-
| Realtek || RTD1295 (RTK 1295) || || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || <ref name="Open-source violator"/>
|-
| Rockchip || RK3066 || Imito MX1/MX2, Minix NeoG4/X5, MK808/802, Ugoos UG802/UG007 || {{yes}} || {{?}} || {{no}} || {{no}} || {{no}} ||
|-
| Rockchip || RK3188 || Jesurun DX05, Minix X7, MK802IV, MK809III, MK902, Ugoos UG007B, Tronsmart T428/MK908, CS968, CR11s, J22, GM282, LT88, T-R42, CS919-II, K-R42, CS918, MK888 || {{yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{?}} || {{no}} || {{no}} ||
|-
| Rockchip || RK3036 / RK3126 / RK3128 / RK3288 || Firefly-RK3288, ChipSpark PopMetal, Uyesee G1H, Nagrace HPH NT-V6, Eny Technology EKB318/EKB328, Kingnovel R6/K-R68, Beelink R28, FireFly FirePrime Development Board, Ugoos UT3/UM3, Rikomagic MK902 II, Measy B4S, Ruach A20s, CloudMedia OpenHour, CloudnetGo CR12/CR13CR16, Tronsmart Orion R28, Youku Box K1, Unuiga Game Box 19-6R || {{yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{?}} || {{no}} || {{no}} ||
|-
| Rockchip || RK3368 || Beelink i68, CloudnetGo CR18/CR13 Plus, Eny Technology EKB368, Himedia H7 III, Measy B4T, Ruach A20s-H, Rikomagic MK68, Tronsmart Orion R68, Zidoo X6/X6 Pro || {{yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{yes}}<br />{{smaller|(CPU)}} || {{no}} || {{no}} ||
|-
| Rockchip || RK3228 / RK3228B / RK3228H || || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{?}} ||
|-
| Rockchip || RK3229 / RK3399 || Firefly-RK3399, MXQ-4K || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{?}} ||
|-
| Samsung || Exynos 3 Single (formerly Exynos 3110) || || {{yes}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|-
| Samsung || Exynos 4 Dual/Quad series (formerly Exynos 4210 / 4212 /4412 / 4418) || [[ODROID|Hardkernel ODROID-U3/U2/X2]], FriendlyARM NanoPC-T1/NanoPC-T2 || {{yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{yes}}<br />{{smaller|(CPU)}} || {{no}} || {{no}} ||
|-
| Samsung || Exynos 5 Hexa/Octa series (Exynos 5260 / 5410/ 5420 / 5422) || [[ODROID|Hardkernel ODROID-XU/XU2/XU3/XU3 Lite]], Arndale Octa || {{yes}} || {{yes}}<br />{{smaller|(CPU)}} || {{yes}}<br />{{smaller|(CPU)}} || {{no}} || {{no}} ||
|-
| Samsung || Exynos 7 Octa (Exynos 5433) || Samsung Galaxy Tab S2 (SM-T815) || {{yes}} || {{no}} || {{yes}} || {{yes}} || {{no}} ||
|-
| Samsung || Exynos 8 Octa series (Exynos 8890) || Samsung Galaxy S7 (Europe) || {{yes}} || {{no}} || {{yes}} || {{yes}} || {{yes}} ||
|-
| Texas Instruments || OMAP4430 / OMAP4440 / OMAP5430 / OMAP5432 || || {{yes}} || {{?}} || {{?}} || {{no}} || {{no}} ||
|}

== Common codecs currently without hardware decoding in Kodi ==
Videos encoded with these codecs can only be played back in Kodi using software video decoding using CPU, meaning no decoding tasks are offloaded to optimized VPU or GPU hardware. Many videos may still play back just fine at standard definition resolutions, while others might have severe issues with playback.

As platforms with faster CPUs come out for Android software video decoding using CPU will get better, but do not expect miracles from the average Android box. It still all can depend on how demanding the decoding of that particular video encoding is or how high resolution it uses, and how powerful the CPU is.

* H.264 Hi10P - No hardware decoders for [[Hi10P]] (High 10 Profile, also known 10-bit H.264) currently exist for any ARM hardware. Most H.264 Hi10P videos will not play smoothly as most ARM CPUs are just not powerful enough to software decode it fast enough.
* H.264 MVC - No open source software decoder or hardware decoding for [http://en.wikipedia.org/wiki/Multiview_Video_Coding MVC (Multiview Video Coding)] stereoscopic 3D video decoding currently exist for Kodi on any platform. Kodi relies on FFmpeg for software demuxing and decoding, so Kodi have to wait for FFmpeg to first add software decoding support of MVC for H.264, and for hardware decoding Kodi relies on the SoC chipset hardware manufacturer to add support for this to their SDK (Software Developer Kits) and for the media player box manufacturers to implement that into their firmware images.
* H.265 MVC (HEVC MVC) - No open source software decoder or hardware decoding for [http://en.wikipedia.org/wiki/Multiview_Video_Coding MVC (Multiview Video Coding)] stereoscopic 3D video decoding currently exist for Kodi on any platform. Kodi relies on FFmpeg for software demuxing and decoding, so Kodi have to wait for FFmpeg to first add software decoding support of MVC for H.265 (HEVC), and for hardware decoding Kodi relies on the SoC chipset hardware manufacturer to add support for this to their SDK (Software Developer Kits) and for the media player box manufacturers to implement that into their firmware images.
* RealVideo/RMVB (RV 8/9/10) - There is currently no support in Kodi for RealVideo hardware video decoding, though software decoding of RMVB videos is possible via FFmpeg but can struggle with high definition sources on older or low-end hardware.
* VP8 (WebM v1 video) and VP9 (WebM v2 video) - There is currently no support in Kodi for VP8 hardware video decoding, though software decoding of VP8 videos is possible via FFmpeg but can struggle with high definition sources on older or low-end hardware. Most hardware manufacturers have not even implemented API support for VP8 decoding in the firmware images of Android for their devices, and this is despite the fact that the WebM project licenses VP8 hardware accelerators (RTL IP) to semiconductor companies for 1080p encoding and decoding at zero cost. Nvidia and Rockchip and a few other less known companies does however provide hardware decoding of VP8 in their SoCs, for Tegra 4 and RK29xx respectivly. ARM, Broadcom, Texas Instruments, and Qualcomm as well as ZiiLABS, ST-Ericsson, and Huawei have all announced upcoming support for hardware acceleration of the WebM format and VP8/VP9 codecs. Intel have also let its intention known that they will add hardware-based acceleration for WebM and VP8/VP9 codecs in its future Atom-based chips if the format gains popularity. VP9 does howver to this date not appear to have hardware decoding support in all but the very newest ARM SoCs for Android, such as exanple Nvidia Tegra X1 (TX1) used in Nvidia Shield TV.

==Notes==
<references />

== Device specific info ==
Here are a few device-specific guides/help areas that the community has provided.

{{Device notice}}


<dpl>
category = HTPC
category = Android
format = ,{{list2|%PAGE%}}
</dpl>

{{updated|16}}

[[Category:Android]]
[[Category:Hardware]]

Archive:CompuLab Utilite

2020-06-12T17:31:51Z

Davu:

{{mininav| [[Devices]] | [[Freescale]] | [[Android]] {{l2| [[Linux]] }} }}
{{device notice}}

[[File:Compulab-Utilite.jpg|400px|right]]

<section begin="intro" />'''CompuLab Utilite''' multi-purpose ARM-based mini-computer that is capable of running either {{Kodi}} on Android or on Linux, both using firmware images provided by CompuLab development team and third-parties of which many comes with {{Kodi}} pre-installed.<section end="intro" />

CompuLab Utilite hardware is built around the scalable and open source friendly Freescale i.MX6 family of SoC (System-on-Chip) with ARM Cortex-A9 processors, 2D/3D hardware graphics processing unit, video decoding and encoding acceleration hardware, and HDMI 1.4 1080p 3D output support.

== Installing Kodi ==
=== Linux ===
The easiest way to use Kodi on a Utilite is to just install a Kodi-specific OS to your mSD card with one of the following OS's. The Utilite will boot directly up into Kodi and nearly every setting can be easily configured within the Kodi GUI
<section begin="install" />
* [[GeeXboX]] - '''[http://wiki.solid-run.com/GeeXboX instructions]'''
<section end="install" />

=== Android ===
Kodi can also be installed onto a Utilite that is running [[Android]] using the normal Android instructions.
<section begin="install" />
* [[Android]] - '''[[HOW-TO:Install Kodi for Android|instructions]]'''
<section end="install" />

== See also ==
* [[Android hardware]]
* [[Android]]

== Links ==
* http://www.compulab.co.il/utilite-computer/web/utilite-overview

[[Category:Linux]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Freescale]]

Archive:Google Nexus Player

2020-06-12T17:31:37Z

Davu:

{{mininav|[[Devices]]|[[Android]] }}
{{device notice}}

{{Infobox information appliance
| name = Google Nexus Player
| image = [[File:nexusplayer.jpg|300px]]
| manufacturer = Google (and Asus)
| releasedate = 2014-11-03 (US)
| os = [[wikipedia:Android TV|Android TV]] (based on [[wikipedia:Android Lollipop|Android 5.0 "Lollipop"]])
| soc = Intel Atom 'Silvermont'
| cpu = Intel Atom Z3560 (Anniedale) 1.8GHz Quad-Core 64-bit x86 CPU
| graphics = PowerVR Series 6 (G6430) Graphics
| display = 1080p
| storage = 8 GB internal (eMMC)
| memory = 1 GB RAM (LPDDR3)
| connectivity = HDMI with CEC support, Bluetooth 4.1, Micro-USB, WiFi 802.11ac 2x2 (MIMO), DC-power (18 Watt)
| dimensions = 120 × 120 × 20 mm (weighs 235 grams)
}}
[[File:Nexus Player Ports.png|right|300px|Nexus Player ports|thumb]]

<section begin="intro" />'''Nexus Player''' is an x86-64 (64-bit Intel Atom CPU) based [[Android]] digital media player co-developed by Google and Asus. Running the [[wikipedia:Android Lollipop|Android 5.0 "Lollipop"]] operating system, this Nexus Player was the first device to employ Google's [[wikipedia:Android TV|Android TV]] platform.<section end="intro" />

== Installing Kodi ==
{{main|HOW-TO:Install Kodi for Android}}
The Google Nexus Player uses the "x86" version of Kodi for Android.

== Remote ==
{{main|Alternative keymaps for Nexus Player remote}}

See '''[[Alternative keymaps for Nexus Player remote]]''' for how to improve how the Nexus Player remote works in Kodi.

== Install Sideload Launcher (optional) ==
Because Google will currently not display side-loaded apps in its default "Leanback Launcher" you can use this "Sideload Launcher" app by Chainfire to more easily launch apps that have not been approved by Google or does otherwise not meet the declaration requirements needed for showing up on the default "Leanback Launcher" (on the [[wikipedia:Android TV|Android TV]] homescreen) for [[wikipedia:Android TV|Android TV]].
* 1. Install "Sideload Launcher" app by Chainfire from Google Play store http://play.google.com/store/apps/details?id=eu.chainfire.tv.sideloadlauncher
* 2. Reboot your Nexus Player by unplugging (as it does not have a software reboot) or by entering <code>adb reboot</code> from command line / terminal.
* 3. Start the "Sideload Launcher" app and use it to launch {{Kodi}} or other third-party apps that you have side-load installed.

== Video guide ==

{{youtube|YgjnOkxpslQ}}

== Known issues ==
*

== Random notes ==
{{large|''Feel free to place various notes, tips, and links here. As this section of the wiki gets more organized, those notes will be properly sorted. Consider this like a dumping ground for when you're not sure where to put something.''}}
* Not a issue for {{Kodi}}, but keep in mind that unlike almost all Android media players out there, the Nexus Player features a x86-64 (64-bit Intel Atom CPU) chipset instead of a ARM based SoC/CPU, and this means that some other Android apps and games that work on other Android media players may not work on the Nexus Player because of this reason.
* CEC support not confirmed but assumed as it is suppose to be prerequisite for [[wikipedia:Android TV|Android TV]]?
* HDMI 1.4b video/audio output with HDCP 1.4. Resolution: 720p and 1080p up to 60fps?
* Weight 235 gram
* As noted in Install section, v5.0 build LRX21M and LRX21V don't seem to have ADB debugging options (i.e. for connecting to device over a network). Also, Sideload Launcher may not be needed as sideloaded Kodi (v14 beta 3) shows up under Apps on Nexus Player's main screen.
* The hardware remote for the Nexus Player is rather limited in functionality. While it will work for the majority of navigation needs, it is recommended to install a [https://play.google.com/store/search?q=kodi%20xbmc%20remote&c=apps&hl=en full feature software remote app] for your phone or tablet such as [https://play.google.com/store/apps/details?id=org.xbmc.kore KORE - Kodi Remote ] or [https://play.google.com/store/apps/details?id=org.leetzone.android.yatsewidgetfree&hl=en Yatse, the Kodi Remote] found at the Google Play Store for Android. These software remotes will give access to the menus of Kodi, otherwise not available through the Nexus Player hardware remote.

== See also ==
* [[Android]]
** [[Android hardware]]

== Links ==
* Kodi forum thread about the Google Nexus Player: http://forum.kodi.tv/showthread.php?tid=206515
* Kodi forum thread about Google ADT-1 (Android TV Development Kit): http://forum.kodi.tv/showthread.php?tid=198998
** [http://developer.android.com/tv/adt-1/index.html ADT-1 Development Kit documentation and FAQ]
* [http://www.google.com/nexus/player/ Official website for Nexus Player]
* [https://play.google.com/store/devices/details/Nexus_Player?id=nexus_player Official Google store for Nexus Player]
* Wikipedia article on Nexus Player: [[wikipedia:Nexus Player]]
* Wikipedia article on Android TV: [[wikipedia:Android TV]]
* Sideload Launcher (by Chainfire) for Android TV application thread: http://forum.xda-developers.com/android/apps-games/app-sideload-launcher-android-tv-t2914962
* Android Developers Blog: http://android-developers.blogspot.se
* XDA Developers Forum: http://forum.xda-developers.com

Archive:MK808B Plus

2020-06-12T17:31:14Z

Davu:

{{mininav| [[Devices]] }}
{{device notice}}

{{Infobox information appliance
| image = [[File:MK808B_Plus.jpg|250px]]
| name = MK808B Plus
| manufacturer = No brand?
| releasedate = November 2014?
| os = [[Android]] 4.4 "KitKat")
| soc = [[Amlogic]] S805
| cpu = [[Amlogic]] S805 SoC with Quad-Core ARM Cortex A5 @ 1.5GHz
| graphics = Mali-450MP GPU
| display = 1080p
| storage = 8 GB (NAND Flash) internal + MicroSD/SDHC Memory Slot (upto 32GB)
| memory = 1 GB (DDR3) RAM
| connectivity = HDMI 1.4b (female), 1 x USB 2.0 host port + 1 x Mini-USB OTG-port, Bluetooth 4.0, 802.11 b/g/n WiFi, 1 x Mini-USB for DC-power
| dimensions = 88 x 32 x 16 mm
| weight = 30 grams
}}
<section begin="intro" />'''MK808B Plus''' (not to be confused with the very different MK808 or MK808B), is a small inexpensive ARM-based Android "stick" hardware that uses an [[Amlogic]] S805 SoC chipset. MK808B Plus is also able to run {{Kodi}} on Linux using unofficial third-party firmware images of example OpenELEC.

While the integrated WiFi support in it is pretty sucky, for about $35 USD, the MK808B Plus is a fairly good value as a decent 1080p set-top box device that can decode most popular used video codecs today, including HEVC (H.265).<section end="intro" />

==Overview==
Today you can find several other inexpensive and decent H.265 capable Android based media player set-top box for less than $50 built on the Amlogic S805 SoC that are all capable of playing HEVC (H.265) videos, but MK808B Plus may just be the cheapest H.265 capable player on the market, as this Amlogic S805 based Android TV stick can be found for around $35 USD including shipping from many different Chinese online stores.

The MK808B Plus device ships with a micro USB OTG adapter, an HDMI-cable, a USB power-adapter with a Mini-USB cable, and a user-manual. Compared to full-size Amlogic S805 players, you do not get a wired Ethernet (RJ45) port, no optical SP/DIF audio autport, or more than USB host ports. The original default firmware runs Android 4.4 with the MediaBox user interface, and it usually comes pre-loaded with an older version or XBMC Kodi.

==Installing Kodi for Android==
Most users can simply install the normal '''[[Android]]''' version of Kodi onto the MK808B Plus.

==Notes==
*HEVC (H.265) hardware decoding requires a nightly development build of Kodi.

[[Category:Linux]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Amlogic]]

Archive:OUYA

2020-06-12T17:30:53Z

Davu:

{{mininav|[[Devices]]|[[Android]]}}
{{device notice}}

{{Infobox information appliance
| name = OUYA
| image = [[File:ouya_plus_gamepad.jpg|250px]]
| manufacturer = OUYA, Inc.
| releasedate = June 25, 2013 (Retail)
| os = [[Android]] 4.1 "Jellybean") with custom Ouya launcher
| soc = [[Nvidia Tegra]] 3 (T33)
| cpu = [[Nvidia Tegra]] 3 (T33) SoC with Quad-Core ARM Cortex-A9 CPU @1.7 GHz
| graphics = Nvidia GeForce ULP GPU
| display = 1080p
| storage = 8 GB internal eMMC flash memory + USB Memory Stick support
| memory = 1 GB (DDR3) RAM
| connectivity = HDMI 1.4b (female), 2 x USB 2.0 host port + 1 x Mini-USB OTG-port, Bluetooth LE 4.0, 802.11 b/g/n WiFi, 10/100 Ethernet, 12-volt DC-power
| dimensions = 75×75×82 mm (2.95×2.95×3.23 in)
| weight = 300 g (11 oz)
}}

{{forum link2|1=Read this page and still need help? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=164 ''Kodi for Android'' Kodi.tv support forum].}}
<section begin="intro" />'''OUYA''' is an Android-based game console and set-top-box that contains a [[Nvidia Tegra]] based ARM-processor that can handle most {{Kodi}} skins, in addition to outputting video in Full HD (1080p).<section end="intro" />

__TOC__
== Main topics ==
Other OUYA-specific wiki pages for topics, guides, and advice. For [[General topics|everything else]], standard Kodi pages will normally apply.
{{Index two column
| image 1 = Gnome-emblem-downloads.png
| link 1 = HOW-TO:Install Kodi on OUYA
| image 2 = FAQ icon.png
| link 2 = Android FAQ
| link 3 = #How-Tos
| link name 3 = How-Tos
| description 3 =
| link 4 = #Controller
| link name 4 = Controller
| description 4 =
| link 5 = #Known issues
| link name 5 = Known issues
| description 5 =
| link 6 = #Random notes
| link name 6 = Random notes
| description 6 =
| link 7 = #Links
| link name 7 = Links
| description 7 =
}}

== Installing ==

{{OUYA warning}}

Old how-to for Kodi v14.2: '''[[HOW-TO:Install Kodi on OUYA]]'''.

== How-Tos ==
{{see also|Android#How-tos}}
Assorted how-tos related to Kodi running on OUYA that have been added to the wiki:


<dpl>
category = How-to
category = OUYA
notcategory = Outdated
format = ,{{list2|%PAGE%}}
</dpl>

== Controller ==
[[File:OUYA-Controller-Map-store.jpg|500px|right|border]]

{{-}}

== Known issues ==
* Audio passthrough for some users will likely require '''[[SPMC]]''', which is a modified version of Kodi.

* Wifi on the OUYA might not be enough for some high bitrate HD streams. In this case, using wired ethernet is recommended.

* Android, which OUYA's OS is based on, is limited right now to 60Hz. Those with media that plays back at 50Hz might see occasional stutter.

* Volume control does not adjust the volume level. It will mute the audio if volume is turned all the way down.

== Random notes ==
{{large|''Feel free to place various notes, tips, and links here. As this section of the wiki gets more organized, those notes will be properly sorted. Consider this like a dumping ground for when you're not sure where to put something.''}}

* If you want to open Kodi automatically when the OUYA boots up, you can choose between two applications, "BootyCall" or "Auto pilot", both are available on the OUYA store.

::'''BootyCall''' [https://www.ouya.tv/game/BootyCall] ($2.99) - This application functions as a default launcher ensuring your chosen application, XBMC/Kodi in this case, is the first application loaded and also is returned to upon exiting other applications.

::'''Auto Pilot''' [https://www.ouya.tv/game/AutoPilot/] (Free) - When installed the name will show up as "BOOT". Connecting the BlueTooth remote may close Kodi after, to avoid this issue, use an Kodi remote (Official, Yatse, etc...).

* Easy Infra red remote (no root): I figured the easiest way on getting IR is to use a cheap "PC Remote". The "PC Remote" receiver actually emulates a full keyboard based on infra red and starts at 5 USD (http://www.amazon.com/gp/offer-listing/B0050PUGZE/ref=dp_olp_new?ie=UTF8&condition=new). You can later swap this remote for a remote with learning capabilities, as the Sony RMVLZ620 (~25 USD), you learn the codes from the "PC Remote" and you get yourself an awesome IR solution that will keep working even if you get those pesky Ouya updates.

* OUYA Specific Addon Repo: You can find an OUYA specific repository of addons available, [https://github.com/EldonMcGuinness/Eldon-XBMC-Repo/releases](Eldon's Kodi Repo). Some of the plugins are specific to the OUYA platform, while others will work on android devices in general.

== See also ==
* [[Android hardware]] - Other Android platform which {{Kodi}} supports hardware video decoding on.
* [[Android]] - Android operating system information in regards to {{Kodi}} usage.

== Links ==
* http://ouya.tv - OUYA website
* http://forums.ouya.tv - OUYA support and development forum
* http://forum.kodi.tv/forumdisplay.php?fid=164 - Kodi for Android support forum
* http://ouyaforum.com/showthread.php?5966-XBMC-on-Ouya-OUYA-Inc - Great support thread for the unofficial "XBMC for OUYA v12" version
* http://forum.xda-developers.com/showthread.php?t=2359390 - WonderEkin's mod/tweak collection - Install Google Play Store, Disable auto update, Switch 720p/1080p res, Overscan fix, etc.
* http://forum.xda-developers.com/showthread.php?t=2387507 - WonderEkin's app to root OUYA

{{Helix updated}}

[[Category:Index]]
[[Category:OUYA|*]]
[[Category:ARM]]
[[Category:Nvidia Tegra|*]]

Archive:Pivos XIOS XS

2020-06-12T17:30:27Z

Davu:

{{mininav|[[Devices]]|[[Android]] }}
{{device notice}}

{{Infobox information appliance
| name = XIOS XS Media Play
| image = [[File:Pivos_XIOS_XS.jpg|300px]]
| manufacturer = Pivos Technology Group, Inc.
| releasedate = July 2014 ?
| os = TOFU Media OS (based on [[Android]] 4.2 "Jelly Bean")
| soc = Amlogic AML8726-MX
| cpu = [[Amlogic]] AML8726-MX SoC with Dual-Core Cortex A9 ARM CPU @ 1.5 GHz
| graphics = Mali-400MP2 GPU
| display = 1080p
| storage = 8 GB (eMMC) internal + MicroSD/SDHC Memory Slot (upto 32GB)
| memory = 1 GB (DDR3) RAM
| connectivity = HDMI 1.4b with CEC support, optical S/PDIF audio out, 2 x USB 2.0 host ports, Bluetooth 4.0, 10/100 Ethernet, 802.11 b/g/n WiFi, DC-power
| dimensions = 87.5 × 87 × 18 mm
}}

{{forum link2|1=Read this page and still need help? Check out these forums: [http://forum.kodi.tv/forumdisplay.php?fid=164 Android] & [http://forum.kodi.tv/forumdisplay.php?fid=52 Linux].}}
<section begin="intro" />'''Pivos XIOS XS''' (or "XIOS XS Media Play") is an ARM-based media player set-top box that can currently run {{Kodi}} on Android, and in the future might also be able to run {{Kodi}} on Linux using unofficial third-party image firmware, similar to its predecessor [[Pivos XIOS DS]].

This Pivos XIOS XS and its predecessor [[Pivos XIOS DS]] doesn't need to be jailbroken and was previously both reference hardware target for {{Kodi}} on Android development. While Pivos XIOS DS only had a single CPU core and performed roughly at the level as a jailbroken ATV2, Pivos XIOS XS have a dual-core CPU which can perform about twice as fast as its predecessor. Both also come with comes with USB ports, micro-SD card, Ethernet port, integrated WiFi, and a remote control.<section end="intro" />
__TOC__
{{-}}

== Installing Kodi ==
* ?

=== Android ===
* Pivos XIOS users should use the normal {{Kodi}} for Android (ARM) builds from kodi.tv: '''http://kodi.tv/download/'''

=== Linux ===
* ?

== Remote control ==
* ?

== Random notes ==
{{large|''Feel free to place various notes, tips, and links here. As this section of the wiki gets more organized, those notes will be properly sorted. Consider this like a dumping ground for when you're not sure where to put something.''}}

== See also ==
* [[Pivos XIOS DS]] - XIOS DS from Pivos was the predecessor to XIOS XS
* [[Android hardware]] - Other Android platform which {{Kodi}} supports hardware video decoding on.
* [[Android]] - Android operating system information in regards to {{Kodi}} usage.

== Links ==
* http://pivosgroup.com/xios.html - Pivos XIOS DS product page
* http://www.pivosforums.com/viewforum.php?f=28 Pivos XIOS XS help forums from Pivosforums.com

[[Category:Pivos XIOS|*]]
[[Category:ARM]]
[[Category:Linux]]
[[Category:Hardware]]
[[Category:Amlogic]]

Archive:Razer Forge TV

2020-06-12T17:29:53Z

Davu:

{{mininav|[[Devices]]|[[Android]] }}
{{device notice}}

{{Infobox information appliance
| name = Razer Forge TV
| image = [[File:Razor Forge TV.jpg|300px]]
| manufacturer = Razer
| releasedate = 2015-04-29 (US)
| os = [[wikipedia:Android TV|Android TV]] (based on [[wikipedia:Android Lollipop|Android 5.0 "Lollipop"]])
| soc = Qualcomm Snapdragon 805
| cpu = Qualcomm Snapdragon 805 ARM Quad-Core Krait 450 CPU @ 2.5GHz per core
| graphics = Adreno 420 GPU
| display = 1080p
| storage = 16 GB internal (eMMC)
| memory = 2 GB RAM
| connectivity = HDMI 1.4 output, USB 3.0, Bluetooth 4.1 + HS, Micro-USB, Gigabit Ethernet, WiFi 802.11ac 2x2 (MIMO), DC-power (18 Watt)
| dimensions = 105mm X 105mm X 17mm
}}

<section begin="intro" />'''Razer Forge TV''' is an ARM-processor based [[Android]] digital media player running the [[wikipedia:Android Lollipop|Android 5.0 "Lollipop"]] operating system using Google's [[wikipedia:Android TV|Android TV]] platform.<section end="intro" />
__TOC__
{{-}}
==Overview==
The general consensus is to avoid the Razer Forge. While it is an official Android TV product, it lacks support from Razer and companies like Netflix have blocked installing on them (no one knows why, but it's most likely a decision from Netflix and not Razer). The hardware itself is not bad, but there is little to make it stand out from alternatives such as the Nexus Player, Shield TV, and even the Amazon Fire TV.

== Installing Kodi ==
{{main|HOW-TO:Install Kodi for Android}}
Razer Forge TV uses the "ARM" version of Kodi for Android.

== Sideloading Kodi (development builds, etc) ==
{{incomplete}}
''Assumed?:'' You first need to enable developer options to activate Android Debug Bridge (adb) debugging and allow unknown sources before you can side-load latest beta or nightly version of {{Kodi}} for x86 (not ARM).
===Enable developer options and activate ADB debugging===
====Enable developer options====
* 1. Scroll down and click on Settings.
* 2. Scroll down and click on About.
* 3. Scroll down a last time to Build Number. Tap on build number repeatedly (should be about 7 times) until a bubble appears saying you’ve unlocked the developer options.
====Enable ADB debugging====
* 1. Return to the Settings menu using the steps above.
* 2. Scroll down to the bottom and you’ll see the Developer options.
* 3. Open Developer options and ADB debugging should be the third option. Enable it.

====Enable USB debugging (if ADB debugging not available)====
In case ADB debugging is not listed under developer options (as has been seen with v5.0 build LRX21M), try connecting via USB using the following:
* 1. Return to the Settings menu using the steps above.
* 2. Under the Preferences section, scroll to the right to find the Developer options.
* 3. Open Developer options and then Debugging, and USB debugging should be the first option. Enable it.
* 4. Connect a computer with ADB installed using a USB cable.

====Allow unknown sources====
* 1. Return to the Settings menu using the steps above.
* 2. Scroll down and click on Security.
* 3. Enable "Unknown sources" to allow installation of apps from sources other than the Google Play store, this will allow side-loading of apps like {{Kodi}}.
====Install {{Kodi}}====
# Download your preferred version of Kodi listed in [[Development builds]].
# Connect to Razer Forge with ADB:
#* If using USB, run <code>adb usb</code> from command line / terminal.
#* If using ADB over network, run <code>adb start-server; adb connect <ip address of Razer Forge></code> from command line / terminal.
# Check that the device is attached correctly. Run <code>adb devices</code> If you see the device as "unauthorized" confirmation from the Razer Forge to trust the attached computer is needed.
# Finally, to install, run <code>adb install <path to apk file></code> (use <code>adb --help</code> to see additional install options like <code>-r</code> that keeps app data on a reinstall).

==Install Sideload Launcher (optional)==
{{incomplete}}
''Assumed?:'' Because Google will currently not display side-loaded apps in its default "Leanback Launcher" you can use this "Sideload Launcher" app by Chainfire to more easily launch apps that have not been approved by Google or does otherwise not meet the declaration requirements needed for showing up on the default "Leanback Launcher" (on the [[wikipedia:Android TV|Android TV]] homescreen) for [[wikipedia:Android TV|Android TV]].
* 1. Install "Sideload Launcher" app by Chainfire from Google Play store http://play.google.com/store/apps/details?id=eu.chainfire.tv.sideloadlauncher
* 2. Reboot your Razer Forge by unplugging (as it does not have a software reboot) or by entering <code>adb reboot</code> from command line / terminal.
* 3. Start the "Sideload Launcher" app and use it to launch {{Kodi}} or other third-party apps that you have side-load installed.

== Video guides ==
?

== Known issues ==
* ?

==Random notes==
{{large|''Feel free to place various notes, tips, and links here. As this section of the wiki gets more organized, those notes will be properly sorted. Consider this like a dumping ground for when you're not sure where to put something.''}}
* ?

== See also ==
* [[Android]]
** [[Android hardware]]

== Links ==
* Kodi forum thread about the Razer Forge TV http://forum.kodi.tv/showthread.php?tid=225153

[[Category:ARM]]

Archive:SolidRun CuBox-i

2020-06-12T17:29:37Z

Davu:

{{mininav| [[Devices]] | [[Freescale]] | [[Android]] {{l2| [[Linux]] }} }}
{{device notice}}

[[File:Cubox-i.jpg|right|thumb|300px|CuBox-i]]
<section begin="intro" />'''CuBox-i''' series (which includes ''CuBoxTV'') is SolidRun's second-generation family of multi-purpose ARM-based mini-computers that is capable of running either {{Kodi}} on Android or on Linux, both using firmware images provided by SolidRun development team and third-parties of which many comes with {{Kodi}} pre-installed.<section end="intro" />

With its hardware built around SolidRun MicroSOM platform the CuBox-i series uses scalable and open source friendly Freescale i.MX6 family of SoC (System-on-Chip) ranging from a single to quad ARM Cortex-A9 processor cores, 2D/3D hardware graphics processing unit, video decoding and encoding acceleration hardware, and HDMI 1.4 1080p 3D output support.

== Installing Kodi ==
=== Linux ===
The easiest way to use Kodi on a CuBox-i is to just install a Kodi-specific OS to your mSD card with one of the following OS's. The CuBox-i will boot directly up into Kodi and nearly every setting can be easily configured within the Kodi GUI
<section begin="install" />
* [[GeeXboX]] - '''[http://wiki.solid-run.com/GeeXboX instructions]'''
* [[XBian]] - '''[http://wiki.solid-run.com/XBian instructions]'''
<section end="install" />
=== Android ===
Kodi can also be installed onto a CuBox-i that is running [[Android]] using the normal Android instructions.
<section begin="install" />
* [[Android]] - '''[[HOW-TO:Install Kodi for Android|instructions]]'''
<section end="install" />

== Hardware specification ==
[[File:CuBox-i-ports.png|300px|thumb|left|Ports on the back of the CuBox-i]]
{| cellspacing="10"
|-
| valign=top |
;Front
The front is not shown on the image. The LED and infrared receiver/transmitter are all behind the plastic window on the lower right.
# Status LED
# Infrared receiver
# Infrared transmitter
| valign=top |
;Back
# Optical S/PDIF audio out
# Power connector
# Ethernet port
# HDMI port
# Micro SD card slot
#: {{small| {{note| Install the micro-SD card so that the contacts face UP (towards the HDMI port). To ensure contact, the card must be fully inserted, with no portion extending beyond the edge of the CuBox. }} }}
# Upper USB port
# Lower USB port
# eSATA port
# Micro USB to RS232 port
|}
{{-}}

'''Size:''' Approximately: 55mm x 55mm x 42mm (2.17 x 2.17 x 1.65 inches)

=== CuBox-i family comparison table ===
{{collapse top|Click "Expand" to see comparison table --->}}
{| class="wikitable"
|
| CuBox-i1
| CuBox-i2
| CuBox-i2eX
| CuBox-i2ultra <sup>1</sup>
| CuBoxTV (CuBox-iTV)
| CuBox-i4pro
|-
| Chipset
| Solo
| Dual Light
| Dual
| Dual
| Quad
| Quad
|-
| Core Count
| 1 @ 1GHz
| 2 @ 1GHz
| 2 @ 1GHz
| 2 @ 1GHz
| 4 @ 1GHz
| 4 @ 1GHz
|-
| Memory Size
| 512MByte DDR3
| 1GByte DDR3
| 1GByte DDR3
| 1GByte DDR3
| 1GByte DDR3
| 2GByte DDR3
|-
| Memory Config
| 32bit @ 800Mbps
| 64bit @ 800Mbps
| 64bit @ 1066Mbps
| 64bit @ 1066Mbps
| 64bit @ 1066Mbps
| 64bit @ 1066Mbps
|-
| 3D GPU
| GC880
| GC880
| GC2000
| GC2000
| GC2000
| GC2000
|-
| 3D GPU Type
| OpenGL|ES 1.1/2.0
| OpenGL|ES 1.1/2.0
| OpenGL|ES 1.1/2.0, OpenCL 1.1E
| OpenGL|ES 1.1/2.0, OpenCL 1.1E
| OpenGL|ES 1.1/2.0, OpenCL 1.1E
| OpenGL|ES 1.1/2.0, OpenCL 1.1E
|-
| HW Video Dec/Enc
| Multiformat
| Multiformat
| Multiformat
| Multiformat
| Multiformat
| Multiformat
|-
| HDMI 1080p
| 1.4, 3D and CEC support
| 1.4, 3D and CEC support
| 1.4, 3D and CEC support
| 1.4, 3D and CEC support
| 1.4, 3D and CEC support
| 1.4, 3D and CEC support
|-
| Ethernet
| 10/100 Mbps
| 10/100 Mbps
| 10/100/1000 Mbps <sup>2</sup>
| 10/100/1000 Mbps <sup>2</sup>
| 10/100/1000 Mbps <sup>2</sup>
| 10/100/1000 Mbps <sup>2</sup>
|-
| WiFi 11b/g/n/BlueTooth 2.1
| Optional
| Optional
| Optional
| align="center"| v
| align="center"| v
| align="center"| v
|-
| Micro SD Interface
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
|-
| eSata II 3Gbps <sup>3</sup>
|
|
| align="center"| v
| align="center"| v
|
| align="center"| v
|-
| RTC With Backup Battery
|
|
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
|-
| Optical S/PDIF Audio Out
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
| align="center"| v
|-
| Micro USB to RS-232
|
|
| align="center"| v
| align="center"| v
|
| align="center"| v
|-
| USB Host
| 2x USB 2.0
| 2x USB 2.0
| 2x USB 2.0
| 2x USB 2.0
| 2x USB 2.0
| 2x USB 2.0
|-
| InfraRed for Remote Control
| 38KHz Receiver
| 38KHz Receiver
| 38KHz Receiver & Transmitter
| 38KHz Receiver & Transmitter
| 38KHz Receiver
| 38KHz Receiver & Transmitter
|}

Notes:
# The CuBox-i2ultra has been replaced by the CuBox-i2eX. The only difference is that WiFi/BlueTooth is now optional
# 1000Mbps link is limited to 470Mbps actual bandwidth due to internal chip bus limitation
# With command based switching port multiplier support
{{collapse bottom}}

== See also ==
* [[All platforms FAQ]]
* [[Linux]]
** [[Linux FAQ|{{Kodi}} for Linux specific FAQ]]
* [[Android]]
** [[Android FAQ|{{Kodi}} for Android specific FAQ]]
** [[Android hardware]]

== Links ==
* [http://www.solid-run.com/products/cubox-i-mini-computer/ Solid-Run Product Page]
* [http://www.solid-run.com/community Solid-Run Community]
* [http://wiki.solid-run.com/Kodi Solid-Run wiki for Kodi]

[[Category:Linux]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Freescale]]

Archive:SolidRun Hummingboard

2020-06-12T17:29:20Z

Davu:

{{mininav| [[Devices]] | [[Freescale]] | [[Android]] {{l2| [[Linux]] }} }}
{{device notice}}

[[File:hummingboard.jpg|400px|right]]
<section begin="intro" />'''Hummingboard''' is SolidRun's ARM-based development board that is capable of running either {{Kodi}} on Android or on Linux, both using firmware images provided by SolidRun development team and third-parties of which many comes with {{Kodi}} pre-installed.

With its hardware built around the same SolidRun MicroSOM platform as the [[SolidRun CuBox-i]] series, it uses scalable and open source friendly Freescale i.MX6 family of SoC (System-on-Chip) ranging from a single to quad ARM Cortex-A9 processor cores, 2D/3D hardware graphics processing unit, video decoding and encoding acceleration hardware, and HDMI 1.4 1080p 3D output support.<section end="intro" />

* http://www.solid-run.com/products/hummingboard/

== Installing Kodi ==
=== Linux ===
The easiest way to use Kodi on a Hummingboard is to just install a Kodi-specific OS to your mSD card with one of the following OS's. The Hummingboard will boot directly up into Kodi and nearly every setting can be easily configured within the Kodi GUI
<section begin="install" />
* [[GeeXboX]] - '''[http://wiki.solid-run.com/GeeXboX instructions]'''
* [[XBian]] - '''[http://wiki.solid-run.com/XBian instructions]'''
<section end="install" />
=== Android ===
Kodi can also be installed onto a Hummingboard that is running [[Android]] using the normal Android instructions.
<section begin="install" />
* [[Android]] - '''[[HOW-TO:Install Kodi for Android|instructions]]'''
<section end="install" />

== See also ==
* [[All platforms FAQ]]
* [[Linux]]
** [[Linux FAQ|{{Kodi}} for Linux specific FAQ]]
* [[Android]]
** [[Android FAQ|{{Kodi}} for Android specific FAQ]]
** [[Android hardware]]

== Links ==
* [http://www.solid-run.com Solid-Run Home Page]
* [http://www.solid-run.com/community Solid-Run Community]
* [http://wiki.solid-run.com/Kodi Solid-Run wiki for Kodi]

[[Category:Linux]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Freescale]]

Archive:UDOO

2020-06-12T17:29:01Z

Davu:

{{mininav| [[Devices]] | [[Freescale]] | [[Android]] {{l2| [[Linux]] }} }}
{{device notice}}

[[File:UDOO_Quad.jpg|400px|right]]
<section begin="intro" />'''UDOO''' is a series of [[Freescale]] i.MX 6 single-board computers integrated with a [http://arduino.cc/en/pmwiki.php?n=Main/ArduinoBoardDue Arduino 2] compatible microcontroller, primarily designed for the education of computer science, the world of makers and the Internet of Things.

The product was initially launched on Kickstarter at April 2013 reaching wide consensus, with three models of UDOO available: UDOO Dual Basic, UDOO Dual, UDOO Quad, respectively priced at $99, $115, $135 at launch.<section end="intro" />

==Overview==
UDOO is designed as a development platform that merges a Dual or Quad Core ARM Freescale]] Cortex-A9 i.MX 6 CPU, with optimal performances both on [[Linux]] and on [[Android]] operating system, and an Arduino 2 compatible board, embedded with a dedicated ARM Atmel SAM3X 8E CPU.

UDOO is a joint effort of [http://www.aidilab.com Aidilab srl] and [http://www.seco.com SECO USA Inc], in collaboration with a multidisciplinary team of researchers with expertise in interaction design, embedded systems, sensor networks and cognitive science.

== Installing Kodi ==
=== Linux ===
The easiest way to use Kodi on a UDOO board is to just install a Kodi-specific OS to your Micro SD card with one of the following OS's. The UDOO board will boot directly up into Kodi and nearly every setting can be easily configured within the Kodi GUI
<section begin="install" />
* [[GeeXboX]] - '''[http://wiki.solid-run.com/GeeXboX instructions]'''
* [http://www.udoo.org/downloads/ UDOOBuntu] - '''[http://www.udoo.org/downloads/]'''
<section end="install" />

=== Android ===
Kodi can also be installed onto a UDOO board that is running [[Android]] using the normal Android instructions.
<section begin="install" />
* [[Android]] - '''[[HOW-TO:Install Kodi for Android|instructions]]'''
<section end="install" />

==External Links==
* http://www.udoo.org/
*http://elinux.org/UDOO_Distributions

[[Category:Linux]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Freescale]]

Archive:Wandboard

2020-06-12T17:28:39Z

Davu:

{{mininav| [[Devices]] | [[Freescale]] | [[Android]] {{l2| [[Linux]] }} }}
{{device notice}}

[[File:Wandboard_angle.jpg|400px|right]]
<section begin="intro" />'''Wandboard''' is an ARM-based development board that is capable of running either {{Kodi}} on Android or on Linux, both using firmware images provided by WandboardWandboard development team and third-parties of which many comes with {{Kodi}} pre-installed.

Wandboard uses scalable and open source friendly Freescale i.MX6 family of SoC (System-on-Chip) ranging from a single to quad ARM Cortex-A9 processor cores, 2D/3D hardware graphics processing unit, video decoding and encoding acceleration hardware, and HDMI 1.4 1080p 3D output support.<section end="intro" />

* http://www.wandboard.org

== Installing Kodi ==
=== Linux ===
The easiest way to use Kodi on a Wandboard is to just install a Kodi-specific OS to your mSD card with one of the following OS's. The Wandboard will boot directly up into Kodi and nearly every setting can be easily configured within the Kodi GUI
<section begin="install" />
* [[GeeXboX]] - '''[http://wiki.solid-run.com/GeeXboX instructions]'''
<section end="install" />

=== Android ===
Kodi can also be installed onto a Wandboard that is running [[Android]] using the normal Android instructions.
<section begin="install" />
* [[Android]] - '''[[HOW-TO:Install Kodi for Android|instructions]]'''
<section end="install" />

[[Category:Linux]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Freescale]]

Archive:WeTek Core

2020-06-12T17:28:13Z

Davu:

{{mininav|[[Devices]]|[[Android]] }}
{{device notice}}

{{Infobox information appliance
| image = [[File:product1.png|250px]]
| name = WeTek Core
| manufacturer = [[WeTek|WeTek Electronics Limited]]
| releasedate = December 2015
| os = WeTek OS (based on [[Android]] 5.1.1 "Lollipop"), OpenELEC
| soc = [[AMLogic]] S812-H
| cpu = [[AMLogic]] S812-H Quad-core ARM® Cortex™-A9r4 up to 2GHz
| graphics = Octo-core ARM® Mali™-450
| display = 4K@30
| storage = 8 GB (NAND Flash) internal + MicroSD/SDHC Memory Slot (upto 32GB)
| memory = 2 GB (DDR3) RAM
| connectivity = HDMI, optical S/PDIF audio out, 4 x USB 2.0 host ports (2 external, 2 internal), Bluetooth 4.0, Gigabit Ethernet, 802.11 b/g/n 2.4 & 5 GHz WiFi, DC-power, A/V output
}}

{{forum link2|1=Read this page and still need help? Check out these forums: [http://forum.kodi.tv/forumdisplay.php?fid=164 Android] & [http://forum.kodi.tv/forumdisplay.php?fid=52 Linux].}}
<section begin="intro" />'''WeTek Core''' is an ARM-based media player device that can currently run either {{Kodi}} on [[Android]] or on [[Linux]], both using official first-party firmware images provided by WeTek and OpenELEC development teams which comes with {{Kodi}} pre-installed.
<section end="intro" />
__TOC__
{{-}}

== Overview ==
WeTek Core is shipped from factory with Kodi 15.2 Isengard version pre-installed in WeTek OS Android. Beside support of {{Kodi}} on Android, WeTek Core support booting of Linux {{Kodi}} distribution OpenELEC from microSD, so users can preserve Android at NAND Flash.

{{youtube|qUrz8KfgAC4}}

== Ports ==

[[File:backDevice.png|500px|thumb|center|Ports on the back of the WeTek Play]]

==== Back ====
# A/V output
# Ethernet port
# HDMI port
# Optical S/PDIF port
# DCI in

[[File:right-side.png|500px|thumb|center|Ports on the side of the WeTek Play]]

==== Side ====
# USB 2.0 port's
# Micro SD card slot

== Installing {{Kodi}} ==
* WeTek OS comes already include Kodi 15.2 Isengard build for WeTek Core.

=== Android ===
WeTek Core users should download and use the official {{Kodi}} for Android

* Download '''http://kodi.tv/download/'''
* [https://play.google.com/store/apps/details?id=org.xbmc.kodi Google Play]

=== Linux ===

===== WeTek OpenELEC / Kodi Installer=====
WeTek OpenELEC / Kodi Installer allow you to install [[Archive:OpenELEC]]:
* Download [http://update.wetekos.com:8080/download/OpenELEC/installer/WeTekOpenELECInstaller.exe WeTek OpenELEC / Kodi Installer]
[[File:WeTek Play - OpenELEC installer.jpg|400px]]

===== Linux {{Kodi}} and OpenELEC installation to Micro SD card =====
WeTek Core come with pre-installed WeTek OS Android on NAND Flash. In case that you want to leave Android on NAND, you can always boot [[Archive:OpenELEC]] from Micro SD card

{{youtube|jmTZkxgxrrE}}

== See also ==
* [[WeTek]]
**[[WeTek Play]]
* [[Android hardware]]
* [[Android]]

==Links==
* http://wetek.com - WeTek Electronics website
* [http://forum.kodi.tv/showthread.php?tid=238923 WeTek Core thread at Kodi Forum]
* http://www.wetekforums.com WeTek Core help forums from WeTekForums.com
* http://goo.gl/qD1wlj WeTek Play video review and unboxing
* http://goo.gl/g0p4pk WeTek Play Video tutorials at YouTube
* [http://www.cnx-software.com/2014/08/16/review-of-wetek-play-android-dvb-s2-satellite-receiver/ CNX-Software review of WeTek Play]
* [http://androidpc.es/blog/2014/09/01/analisis-wetek-play-tv-box-con-sintonizador-de-satelite-doble/ AndroidPC.es review of WeTek Play]
* [http://www.dobreprogramy.pl/wojtekadams/WeTek-Play-odkryj-nowy-sens-rozrywki,59532.html Dobreprogramy.pl review of WeTek Play]

[[Category:WeTek|*]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Linux]]
[[Category:Amlogic]]

Archive:WeTek

2020-06-12T17:27:25Z

Davu:

'''WeTek''' is an manufacturer of ARM-based media player set-top boxes that can run {{Kodi}} on Android or Linux, with the hardware and firmware images developed by WeTek Electronics Limited themselves as well as developers from the [[Archive:OpenELEC]] community.

WeTek devices all sell with Kodi as their main media player. They have some device models with support for integrated TV-tuners (which can be replaced) and some models without support for integrated TV-tuners.

* [[WeTek Play]] was the first model released in late 2014 which is still being sold directly from WeTek as their mid-level model pre-loaded with Android. WeTek Play is also being sold by the [[Archive:OpenELEC]] team pre-loaded with their popular embedded Linux distrobution for Kodi.
* [[WeTek Core]] was released in late 2015 and is their current entry-level model, as while technically more powerful [[WeTek Play]] does not support for integrated TV-tuners.

WeTek have also announced plans to release at least two new upcoming media player, with one expecting to be a middle level model and one high-end level model in succession sometime during 2016.
* '''WeTek Hub''' is an upcoming model without intregrated TV-tuner capability.
* '''WeTek Play2''' is an upcoming model with intregrated TV-tuner capability for DVB-C/T/T2 and ATSC tuners.
* '''WeTek Play2S''' is an upcoming model with intregrated TV-tuner capability for DVB-S/S2 tuners.

WeTek devices can today be considered one of the main reference hardware target for the Kodi for Android development, (filling the role which [[Pivos]] previously held). [[WeTek Play]] and [[WeTek Core]] performs roughly at the level the first and second-generation (2) [[Raspberry Pi]] respectivly, but other than coming with a proper remote control and media player case, support Android OS with DRM out-of-the-box so can use popular payed-subscription Android streaming apps like Netflix and Hulo.

== See also ==
* [[WeTek Play]] was the first model released in late 2014, and have support for integrated TV-tuners.
* [[WeTek Core]] was released in late 2015, does not support for integrated TV-tuners.
* [[Android hardware]] - Other Android platform which {{Kodi}} supports hardware video decoding on.
* [[Android]] - Android operating system information in regards to {{Kodi}} usage.

==Links==
* http://www.wetek.com WeTek official website at wetek.com
* http://www.wetekforums.com WeTek community support forums at wetekforums.com

[[Category:WeTek|*]]
[[Category:ARM]]

Archive:WeTek Play

2020-06-12T17:27:11Z

Davu:

{{mininav|[[Devices]]|[[Android]] }}
{{device notice}}

{{Infobox information appliance
| image = [[File:product1.png|250px]]
| name = WeTek Play
| manufacturer = [[WeTek|WeTek Electronics Limited]]
| releasedate = November 2014
| os = WeTek OS (based on [[Android]] 4.2.2 "Jelly Bean"), Google GMS licensed
| soc = [[AMLogic]] AML8726-MX
| cpu = [[AMLogic]] AML8726-MX Dual-Core ARM Cortex A9 CPU @ 1.5 GHz
| graphics = Mali-400MP2 GPU
| display = 1080p
| storage = 4 GB (NAND Flash) internal + MicroSD/SDHC Memory Slot (upto 32GB)
| memory = 1 GB (DDR3) RAM
| connectivity = HDMI, Plug & Play DVB-S2, DVB-C, DVB-T/T2, ATSC, A/V, optical S/PDIF audio out, 5 x USB 2.0 host ports (3 external, 2 internal), Bluetooth 4.0, 10/100 Ethernet, 802.11 b/g/n WiFi, RS-232, DC-power
}}

{{forum link2|1=Read this page and still need help? Check out these forums: [http://forum.kodi.tv/forumdisplay.php?fid=164 Android] & [http://forum.kodi.tv/forumdisplay.php?fid=52 Linux].}}
<section begin="intro" />'''WeTek Play''' (also sold as an '''WeTek OpenELEC''' edition) is an ARM-based media player device that can currently run either {{Kodi}} on [[Android]] or on [[Linux]], both using official first-party firmware images provided by WeTek and OpenELEC development teams which comes with {{Kodi}} pre-installed. WeTek Play is also one of the first {{Kodi}} based set-top box devices that have support for integrated ATSC and DVB TV-tuners, which are currently fully functional via plug-and-play under Android and Linux in combination with [[Tvheadend PVR|Tvheadend PVR backend]] or [[VDR|VDR PVR backend]] and its matching [[PVR|PVR client addon]] for {{Kodi}}.
<section end="intro" />
__TOC__
{{-}}

== Overview ==
WeTek Play is shipped from factory with XBMC 13.2 Gotham version pre-installed in WeTek Android. Device come pre-rooted, so users can easily update it manually to {{Kodi}} or simply by updating WeTek Android which comes with {{Kodi}} included. Beside support of {{Kodi}} on Android, WeTek Play support booting of Linux {{Kodi}} from NAND and Micro SD, so users can preserve Android at NAND Flash.

{{youtube|qUrz8KfgAC4}}

== Ports ==

[[File:backDevice.png|500px|thumb|center|Ports on the back of the WeTek Play]]

==== Back ====
# Tuner inputs
# 2 x USB 2.0 ports
# A/V output
# Ethernet port
# HDMI port
# Optical S/PDIF port
# RS232 port (Serial cable shipped with WeTek Play)
# DCI in

[[File:right-side.png|500px|thumb|center|Ports on the side of the WeTek Play]]

==== Side ====
# USB 2.0 port
# Micro SD card slot

== Installing {{Kodi}} ==
* XBMC 13.2 Gotham is already included in WeTek Play Android OS.

=== Android ===
WeTek Play users should download and use the official {{Kodi}} for Android (ARM) builds from kodi.tv

* Download '''http://kodi.tv/download/'''

=== Linux ===

===== WeTek OpenELEC / Kodi Installer=====
WeTek OpenELEC / Kodi Installer allow you to install [[Archive:OpenELEC]]:
* Download [http://update.wetekos.com:8080/download/OpenELEC/installer/WeTekOpenELECInstaller.exe WeTek OpenELEC / Kodi Installer]
[[File:WeTek Play - OpenELEC installer.jpg|400px]]

===== Linux {{Kodi}} and OpenELEC installation to Micro SD card =====
WeTek Play come with pre-installed WeTek Android on NAND Flash. In case that you want to leave Android on NAND, you can always boot Linux {{Kodi}} and [[Archive:OpenELEC]] from Micro SD card

{{youtube|jmTZkxgxrrE}}

===== Linux {{Kodi}} and OpenELEC installation to NAND Flash =====
In case that You want to have only Linux {{Kodi}} or [[Archive:OpenELEC]] in WeTek Play, you can install it directly to NAND Flash. Procedure is same as installing or updating Android with .zip file

* Download [http://update.wetekos.com:8080/download/OpenELEC/NAND/ WeTek OpenELEC / Kodi NAND install package]

# Download .zip for NAND installation
# Extract downloaded .zip archive
# Copy 3 files: recovery.img , .zip and .aml file to microSD card
# Power off WeTek Play, insert microSD card in device, push UPGRADE button which is located at bottom of device (you can use provided WeTek upgrade toothpick to insert it in hole and to push button), Power ON WeTek Play and keep pressed UPGRADE button for 7 seconds, then release it and update process should start.
# After installation is done, WeTek Play will automatically reboot and it will boot directly on [[Archive:OpenELEC]] with Kodi 14.1

{{youtube|USTCmnM-7KE}}

== Live TV in Kodi ==

===== Setting up VDR PVR Backend on WeTek Play =====

{{youtube|VyssoWm4QjU}}

===== Setting up tvheadend PVR Backend with Satellite DVB-S/S2 tuner on WeTek Play =====

{{youtube|IK2krP-oC-E}}

===== Setting up tvheadend PVR Backend with Satellite DVB-S/S2 tuner and DiSEqC 1.0 and 1.1 =====

{{youtube|0nOyj0WmOgA}}

===== Setting up tvheadend PVR Backend with Cable DVB-C tuner on WeTek Play =====

{{youtube|cvRB7oVg2r0}}

===== Setting up tvheadend PVR Backend with Terrestrial DVB-T tuner on WeTek Play =====

{{youtube|Gm_J4J_XnIA}}

== See also ==
* [[WeTek]]
**[[WeTek Core]]
* [[Android hardware]]
* [[Android]]

==Links==
* http://wetek.com - WeTek Electronics website
* [http://forum.kodi.tv/showthread.php?tid=213747 WeTek Play thread at Kodi Forum]
* http://www.wetekforums.com WeTek Play help forums from WeTekForums.com
* http://goo.gl/qD1wlj WeTek Play video review and unboxing
* http://goo.gl/g0p4pk WeTek Play Video tutorials at YouTube
* [http://www.cnx-software.com/2014/08/16/review-of-wetek-play-android-dvb-s2-satellite-receiver/ CNX-Software review of WeTek Play]
* [http://androidpc.es/blog/2014/09/01/analisis-wetek-play-tv-box-con-sintonizador-de-satelite-doble/ AndroidPC.es review of WeTek Play]
* [http://www.dobreprogramy.pl/wojtekadams/WeTek-Play-odkryj-nowy-sens-rozrywki,59532.html Dobreprogramy.pl review of WeTek Play]

[[Category:WeTek|WeTek]]
[[Category:ARM]]
[[Category:Hardware]]
[[Category:Linux]]
[[Category:Amlogic]]

Archive:WeTek Play

2020-06-12T17:26:38Z

Davu:

Profiles

2020-04-05T16:39:30Z

Davu:

__TOC__
{{-}}
<section begin=intro />Profiles allow users to save all of settings as a profile and change them at the touch of a button. It also allows you to grant access to specific folders and network shares based on the profile being used. This is ideal for systems that have multiple users. It works much the same as setting up individual users on your home computer.<section end=intro />

{{note|While profiles do allow to share the same Kodi instance with multiple users, they are not a security feature. The web interface, for example, may still allow to change the active profile without entering a password.}}

These individual profiles allow you to customize the environment for multiple users, allowing for such functionality as:
* Customized view settings such as skins for each user
* The ability to lock folders, such as network shares on a per-user basis
* Separate media [[Databases|libraries]] for each user
* Unique RSS feeds for each user
* Unique [[Keymap|keymapping]] for each user
* Unique network settings
All options stored in the [[userdata folder]] can be customized per profile, allowing for an amazing amount of flexibility.

{{-}}

== Adding a profile ==

In order to add a profile, follow the steps below

<gallery mode="packed" widths=500px heights=283px>
File:Estuary_Profiles_Adding_Profile_1.jpg| '''Step 1:''' Select "Add profile"
File:Estuary_Profiles_Adding_Profile_2.jpg| '''Step 2:''' Enter a name for the profile
File:Estuary_Profiles_Adding_Profile_3.jpg| '''Step 3:''' Select a directory for your profile at which your personalized settings will be stored.<br />'''OK''' will choose the 'default' folder which will be stored under the [[Userdata|userdata]]-folder and will have the same name as the profile name. <br />'''New folder''' will give you the option to specify a self-created folder for your profile which you need to select after a name for it was given. The folder for the profile will then be found under: userdata -> profiles -> <created folder name>
File:Estuary_Profiles_Adding_Profile_4.jpg| '''Step 4:''' Select specific profile settions which are explained below
File:Estuary_Profiles_Adding_Profile_5.jpg| '''Step 5:''' Choose to copy settings from the defaul user ot start with default settings
File:Estuary_Profiles_Adding_Profile_6.jpg| '''Step 6:''' Choose to copy media sources from the default user or start fresh.
</gallery>

=== Specific profile settings ===

; Profile Name
: The name of the profile you entered above

; Profile picture
: Browse to some icon you would like to select as a profile picture

; Profile directory
: The path to the profile directory you might have created above

; Lock prefences
: Allows you to lock many of your preferences. This is detailed below.

; Media Info
:Allows you to have separate information saved for your media, i.e. IMdB, AllMusic, etc. The options are
::* '''Separate''' - Profiles have separate media info with full control
::* '''Shares with Default''' - Shares media info with the default user with full control
::* '''Shares with Default (Read Only)''' - Shares media info with the default user, and is locked by the master code
::* '''Separate (Locked)''' - Profile has separate media info, but you can only change it by enabling master mode.

; Media sources
:Allows you to have separate media sources for the profiles. The options are
::* '''Separate''' - Profiles have separate media sources with full control
::* '''Shares with Default''' - Shares media sources with the default user with full control
::* '''Shares with Default (Read Only)''' - Shares media sources with the default user, and is locked by the master code
::* '''Separate (Locked)''' - Profiles have separate media sources, but you can only change them by enabling master mode.
{{-}}
<br>

== Deleting a profile ==

In order to delete an unused profile, simply navigate to {{button|Settings}}->{{button|Profile Settings}}->{{button|Profiles}}, then navigate to the profile you want to delete and bring up the context menu using either {{button|guide}} on a remote or {{button|c}} on a normal keyboard. Then select {{button|Delete}} like shown in the screenshot below:
<br>

[[File:Profles-delete_profile-v17.jpg|500px]]<br />

{{-}}

== Switching profiles ==

Switching profiles from a currently running Kodi instance can be done in different ways:

You are able to switch a profile while navigating to the profiles-section, selecting the specific profile you want to use, bring up the context menu using either {{button|guide}} on a remote or {{button|c}} on a normal keyboard and select {{button|Load}} like shown in the screenshot below:<br />
<br />

[[File:Profiles-load_profile-v17.jpg|500px]]<br />
<br />

The other way is to log-off from the current Kodi session and log-in to another profile:<br />
<br />
<gallery mode="packed" widths=500px heights=283px>
File:Profiles-switch_profile-v17.jpg| '''Step 1:''' Log off from the current profile
File:Profiles-switch_profile2-v17.jpg| ''' Step 2:''' Log in to another profile
</gallery>

Another way of switching profiles is to bind ''load profile'' to a key in [[Keymaps|keymaps.xml]] by using the [[List_of_built-in_functions|built-in function]] LoadProfile. If you only have two profiles you can use the same key to switch back and forth. e.g. LoadProfile bound to {{keypress|y}}<br />

Switch from User1 to User2 (Users1's keymap.xml): <y>LoadProfile(User2)<y/><br />
Switch from User2 to User1 (Users2's keymap.xml): <y>LoadProfile(User1)<y/><br />

Keymap.xml example:
<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<y>LoadProfile(User2)</y>
</keyboard>
</global>
</keymap>
</syntaxhighlight>
{{-}}

== profiles.xml and profiles folder ==

It is important to mention that this section exists so that users have some documentation to refer to in the event of profile related issues occur like profile corruption. This '''does not''' constitute a invitation to novice users to start messing around with said files/folders and cause inadvertent problems that would not otherwise exist.

{{notice|'''Do not edit the any of the xml files''' in question unless '''indicated by a Kodi developer''' or for '''backup''' purposes only|WARNING}}

=== profiles.xml ===

A ''profile.xml'' file exists after the very first installation of Kodi at its userdata-folder and unless you have created additional profiles it won't have any other information as for the '''Master user''' (Kodis default user). If you create other/additional profiles, that file will be populated with additional informations about the created profile.

The example below shows a profile.xml file containing the '''Master user''' and the user '''Test''' as an additional profile. In that case it will show that the '''Master user''' uses a lockcode which '''Test''' doesn't use. As you can see the given password is shown in plain text. So please be aware that a locked profile doesn't provide any kind of security if other users have access to the underlying file system.

For the lock preferences and the Master lock, please visit: [[Settings/Interface/Master_lock|Settings -> Interface settings -> Master lock]]

{| class="mw-collapsible mw-collapsed wikitable"
|-
! Example profiles.xml file
|-
|
<syntaxhighlight lang=xml enclose="div">
<profiles>
<lastloaded>0</lastloaded>
<useloginscreen>false</useloginscreen>
<nextIdProfile>2</nextIdProfile>
<profile>
<id>0</id>
<name>Master user</name>
<directory pathversion="1">special://masterprofile/</directory>
<thumbnail pathversion="1" />
<hasdatabases>true</hasdatabases>
<canwritedatabases>true</canwritedatabases>
<hassources>true</hassources>
<canwritesources>true</canwritesources>
<lockaddonmanager>false</lockaddonmanager>
<locksettings>false</locksettings>
<lockfiles>false</lockfiles>
<lockmusic>false</lockmusic>
<lockvideo>false</lockvideo>
<lockpictures>false</lockpictures>
<lockprograms>false</lockprograms>
<lockmode>1</lockmode>
<lockcode>c4ca4238a0b923820dcc509a6f75849b</lockcode>
<lastdate />
</profile>
<profile>
<id>1</id>
<name>TEST</name>
<directory pathversion="1">profiles/Test/</directory>
<thumbnail pathversion="1" />
<hasdatabases>true</hasdatabases>
<canwritedatabases>true</canwritedatabases>
<hassources>true</hassources>
<canwritesources>true</canwritesources>
<lockaddonmanager>false</lockaddonmanager>
<locksettings>false</locksettings>
<lockfiles>false</lockfiles>
<lockmusic>false</lockmusic>
<lockvideo>false</lockvideo>
<lockpictures>false</lockpictures>
<lockprograms>false</lockprograms>
<lockmode>0</lockmode>
<lockcode>-</lockcode>
<lastdate />
</profile>
</profiles>
</syntaxhighlight>
|}

=== Profiles folder contents ===

Any additional user(s) will have their own folder under '''userdata -> profiles -> <profile-name>''' which contains all informations about add-on data, databases, keymaps, thumbnails and such seperately from the ''Master user''. If you have selected "Copy default" at the steps above, the settings or media sources will be copied from the default Kodi user.

By default (no sources set neither on the master user nor on an additional profile) an additional profile folder contains similar folders as the userdata folder. For an explanation about the files and folders which are located under the <profile_name>-folder, please see: [[Userdata#UserData_folder_contents|Userdata folder contents]]

== Troubleshooting ==
<br />
'''Q: I installed skins and add-ons on the 'Master User' but I can't install it on the additional profile. Why?'''

A: Already installed skins or add-ons are marked as "disabled" under: {{button|Add-ons -> My add-ons -> <specific add-on section>}} and don't need to be installed again. After you enabled a specific add-on or a skin, those add-ons are available again and skins could be used from the {{button|Settings -> Interface settins -> Skin}} menu.

'''Q: After I created a profile, the Kodi screen stays black if I try to load it for the first time. Why?'''

A: That was a bug and it's already fixed in Kodi 18 alpha versions. After you have restarted Kodi Krypton, Kodi should behave normal and should display the GUI as expected.

=== Missing texts/different skins not loading while using profiles ===

{{note|This will be obsolete after the release of Kodi 18.7.}}

That's a known issue and there's a workaround for that:

- create a [[Autoexec.py|autoexec.py]] file at your [[Userdata|userdata]] folder and under each {{button|<profile-name>}}-folder under {{button|userdata -> profiles -> <profile-name>}} (the path to that folder differs from the OS in use)<br />
- fill each autoexec.py with the following content:

<syntaxhighlight lang=python>
import xbmc
xbmc.executebuiltin('ReloadSkin()')
</syntaxhighlight>

That will cause a skin reload at every profile switch. Depending on your hardware in use you mostly won't notice it and the texts will be visible again and/or different skins for different profiles will load fine. For some hardware, like the RPi, it will be noticeable and also might take a little while.

== See also ==
* [[Settings/Interface/Master_lock]]
* [[Media sources#Locking]]

{{Krypton updated}}

[[Category:Manual]]
[[Category:Settings]]
[[Category:General topics]]

Advancedsettings.xml

2020-04-02T05:23:16Z

Davu:

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

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

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

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

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang=xml>
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang=xml>
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang=xml>
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang=xml>
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default).
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang=xml enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

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

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

Default: Off



== Video library settings ==

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

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

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

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

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a ''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''

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

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

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

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

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

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

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[TV Shows (Video Library)|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

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

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

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

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''.

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

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

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

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

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

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

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

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

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[Regular Expression (RegEx) Tutorial|RegEx]]''" or "''[[Regular Expression (RegEx) Tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

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

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

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

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

==== Extra artwork ====

New for Kodi v18.
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.

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


<tvshowextraart>
<arttype>characterart</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</tvshowextraart>

<tvseasonextraart>
<arttype>landscape</arttype>
</tvseasonextraart>

<episodeextraart>
<arttype>fanart</arttype>
</episodeextraart>

<movieextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</movieextraart>

<moviesetextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
<arttype>keyart</arttype>
</moviesetextraart>

<musicvideoextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>landscape</arttype>
</musicvideoextraart>
</videolibrary>
</syntaxhighlight>

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

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

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

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

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

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

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

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

=== fanart ===
{{anchor|.3Cfanart.3E}}
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)
*Used for '''music only'''
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.

Example:
<syntaxhighlight lang=xml enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
<section begin="musicthumbs" />A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang=xml enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight><section end="musicthumbs" />

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<allitemsonbottom>true</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 


<useartistsortname>false</useartistsortname> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

==== Music library extra artwork ====

New for Kodi v18.
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.

The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "thumb" for artists and albums, and "fanart" for artists.

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


<artistextraart>
<arttype>banner</arttype>
<arttype>clearlogo</arttype>
<arttype>clearart</arttype>
<arttype>landscape</arttype>
</artistextraart>

<albumextraart>
<arttype>discart</arttype>
<arttype>spine</arttype>
<arttype>back</arttype>
</albumextraart>
</musiclibrary>
</syntaxhighlight>

== Photos settings ==

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

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

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

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

<syntaxhighlight lang=xml enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
</network>
</syntaxhighlight>

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

=== cache ===
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang=xml enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

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

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

== File system settings ==

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

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

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

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed. See [[HOW-TO:Controller deadzone]].

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

== Removed tags ==
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[action ID]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang=xml enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

= References =
<references />

{{Updated|17}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced settings]]
[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

List of Built In Controls

2019-11-25T11:35:03Z

Davu:

<section begin="main content" />
== .xml files ==

=== AddonBrowser.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Enable auto-updating of the installed add-on's
|-
|6 ||radiobutton ||Enable add-on notifications
|-
|7 ||radiobutton ||Enable language filter
|-
|8 ||radiobutton ||Hide broken addons
|-
|9 ||button ||Check for repo updates
|}

=== DialogAddonInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Install the selected add-on
|-
|7 ||button ||Disable the selected add-on
|-
|8 ||button ||Update the selected add-on
|-
|9 ||button ||Show the settings of the selected add-on
|-
|10 ||button ||Show the dependencies of the selected add-on
|-
|12 ||button ||Run the selected add-on
|-
|13 ||radiobutton ||Auto-update
|-
|50 ||container ||List of available screenshots
|}

=== DialogAddonSettings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|3 ||grouplist ||Grouplist template
|-
|5 ||grouplist ||Grouplist template
|-
|7 ||button ||Button template
|-
|8 ||radiobutton ||Radiobutton template
|-
|9 ||spincontrolex ||Spincontrolex template
|-
|10 ||togglebutton ||Togglebutton template
|-
|11 ||image ||Default separator image
|-
|12 ||edit ||Edit template
|-
|13 ||sliderex ||Slider template
|-
|14 ||label ||Label template
|-
|28 ||button ||OK button
|-
|29 ||button ||Cancel button
|-
|30 ||button ||<unused button>
|}

=== DialogAudioDSPManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|20 ||container ||List with available options
|-
|21 ||container ||List with active options
|-
|22 ||radiobutton ||Continuous save button
|-
|23 ||button ||Apply button
|-
|24 ||button ||Clear button
|-
|9000 ||container ||List with available modes
|}

=== DialogBusy.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||progress ||Progress bar
|}

=== DialogButtonMenu.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3100 ||label ||Label of the focused button
|}

=== DialogConfirm.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|9 ||textbox ||Message
|-
|10 ||button ||No button
|-
|11 ||button ||Yes button
|-
|12 ||button ||(for future use)
|-
|20 ||progress ||Progress bar
|}

=== DialogContextMenu.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|999 ||image ||Background image of the context menu (center part) (deprecated)
|-
|998 ||image ||Background image of the context menu (bottom part) (deprecated)
|-
|997 ||image ||Background image of the context menu (top part) (deprecated)
|-
|996 ||grouplist || Grouplist template
|-
|999 ||image ||Background image of the context menu
|-
|1000 ||button ||Button template
|}

=== DialogExtendedProgressBar.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|30 ||label ||Heading label
|-
|31 ||label ||Line 1
|-
|32 ||progress ||Scan progress bar
|}

=== DialogGameControllers.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3 ||grouplist ||List of controller types
|-
|5 ||grouplist ||List of feature types
|-
|7 ||button ||Button template
|-
|8 ||label ||Settings category label template
|-
|9 ||image ||Settings separator image template
|-
|10 ||button ||Button template
|-
|17 ||button ||Help button
|-
|18 ||button ||OK button
|-
|19 ||button ||Reset button
|-
|20 ||button ||Get more... button
|-
|21 ||button ||Ignore input button
|-
|22 ||button ||Get all button
|-
|31 ||gamecontroller ||Gamecontroller image template
|-
|32 ||textbox ||Controller description
|}

=== DialogFavourites.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|450 ||container ||List of available favourites
|}

=== DialogKeyboard.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|8 ||button ||Backspace button
|-
|100 – 111 ||button ||Digits 0 – 9
|-
|120 – 171 ||button ||Characters A – Z
|-
|300 ||button ||Done Button
|-
|301 ||button ||Cancel button
|-
|302 ||radiobutton ||Shift button
|-
|303 ||radiobutton ||Caps-Lock button
|-
|304 ||radiobutton ||Switch to symbols
|-
|305 ||button ||Navigate left button
|-
|306 ||button ||Navigate right button
|-
|307 ||button ||Enter IP address button
|-
|309 ||button ||Layout button
|-
|311 ||label ||Heading label
|-
|312 ||edit ||Label displaying the text being entered
|-
|313 ||label ||Label displaying the text being entered (when keyboard layout is Chinese)
|-
|314 ||label ||Label displaying the available choices (when keyboard layout is Chinese)
|}

=== DialogMediaSource.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|10 ||container ||List of added media sources
|-
|11 ||button ||Browse for location button
|-
|12 ||edit ||Button for entering the name for the selected source
|-
|13 ||button ||Add new source button
|-
|14 ||button ||Delete source button
|-
|18 ||button ||OK button
|-
|19 ||button ||Cancel button (unused)
|}

=== DialogMusicInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Refresh artist information / Refresh album information
|-
|7 ||button ||User rating
|-
|10 ||button ||Get artist thumbnail / Get album thumbnail
|-
|11 ||button ||Connect to the Last.fm radio channel for this artist
|-
|12 ||button ||Get artist fanart image
|-
|13 ||button ||Get song thumbnail
|-
|50 ||container || Discography of the selected artist / tracks on the selected album / contributors on the selected song
|}

=== DialogNotification.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|400 ||image ||Default Icon
|-
|401 ||label ||Heading text
|-
|402 ||label ||Message text
|}

=== DialogNumeric.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|4 ||label ||Label displaying the digits being entered
|-
|10 – 19 ||button ||Digits 0 – 9
|-
|20 ||button ||Navigate left button
|-
|21 ||button ||Enter Button
|-
|22 ||button ||Navigate right button
|-
|23 ||button ||Backspace button
|}

=== DialogPictureInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|5 ||container ||List of the available exif information of the image currently being displayed
|}

=== DialogPVRChannelManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||button ||OK button
|-
|5 ||button ||Apply button
|-
|6 ||button ||Cancel button
|-
|7 ||radiobutton ||Activate channel button
|-
|6 ||button ||Cancel button
|-
|8 ||edit ||Channel name
|-
|9 ||button ||Channel logo
|-
|11 ||spincontrolex ||Select group
|-
|12 ||radiobutton ||Activate EPG
|-
|13 ||spincontrolex ||Select EPG source button
|-
|30 ||button ||Switch to group management
|-
|31 ||button ||New channel
|-
|34 ||button ||Toggle radio / tv channels
|-
|20 ||container ||Channel list
|}

=== DialogPVRChannelsOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Channels list
|}

=== DialogPVRGroupManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Ungrouped channels
|-
|12 ||container ||Grouped channels
|-
|13 ||container ||Group list
|-
|25 ||radiobutton ||Hide / Unhide button
|-
|26 ||button ||Add button
|-
|27 ||button ||Rename button
|-
|28 ||button ||Delete button
|-
|29 ||button ||OK button
|-
|34 ||togglebutton ||Switch between TV / Radio
|}

=== DialogPVRChannelGuide.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Guide list
|}

=== DialogPVRGuideSearch.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|9 ||edit ||Search string
|-
|10 ||radiobutton ||Include description
|-
|11 ||radiobutton ||Case sensitive
|-
|12 ||spincontrolex ||Minimal duration
|-
|13 ||spincontrolex ||Maximal duration
|-
|14 ||edit ||Start date
|-
|15 ||edit ||End date
|-
|16 ||edit ||Start time
|-
|17 ||edit ||End Time
|-
|18 ||spincontrolex ||Genre
|-
|19 ||radiobutton ||Avoid repeats
|-
|20 ||radiobutton ||Unknown genres
|-
|21 ||spincontrolex ||Groups
|-
|22 ||radiobutton ||FTA
|-
|23 ||spincontrolex ||Channels
|-
|24 ||radiobutton ||Ignore timers
|-
|25 ||button ||Cancel button
|-
|26 ||button ||Search button
|-
|27 ||radiobutton ||Ignore recordings
|-
|28 ||button ||Defaults button
|}

=== DialogPVRInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||button ||Similar button
|-
|5 ||button ||Switch to channel button
|-
|6 ||button ||Record button
|-
|7 ||button ||OK button
|-
|8 ||button ||Play button
|-
|9 ||button ||Add timer button
|}

=== DialogSeekBar.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|401 ||slider ||Marker representing the current seek position
|-
|402 ||label ||Time label displaying current seek position
|}

=== DialogSelect.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|2 ||label ||Number of items in the list
|-
|3 ||container ||List of available options
|-
|5 ||button ||Manual/Get More... button
|-
|6 ||container ||List of available add-ons
|-
|7 ||button ||Cancel button
|-
|11 ||container ||List with game video thumbnails
|-
|12 ||textbox ||Description of the currently-selected video filter
|}

=== DialogSettings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Header label
|-
|5 ||grouplist ||Grouplist template
|-
|7 ||button ||button template
|-
|8 ||radiobutton ||radiobutton template
|-
|9 ||spincontrolex ||spincontrolex template
|-
|11 ||image ||image template
|-
|12 ||edit ||edit template
|-
|13 ||sliderex ||sliderex template
|-
|14 ||label ||label template
|-
|28 ||button ||ok button
|-
|29 ||button ||cancel button
|-
|30 ||button ||clear/settings button
|}

=== DialogSlider.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||label ||Heading label
|-
|11 ||slider ||Slider
|-
|12 ||label ||Label representing the slider value
|}

=== DialogSubtitles.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|100 ||label ||Name of subtitle service
|-
|110 ||image ||Logo of subtitle service
|-
|120 ||container ||List of available subtitles
|-
|130 ||label ||Local subtitle available
|-
|140 ||label ||Number of available subtitles
|-
|150 ||container ||List of available subtitle services
|-
|160 ||button ||Manual search buttom
|}

=== DialogTextViewer.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|5 ||textbox ||Text area for add-on output
|}

=== DialogVideoInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3 ||image ||Video thumb
|-
|4 ||textbox ||Text area for displaying the video plot
|-
|5 ||button ||Toggle between video review and cast members (Deprecated)
|-
|6 ||button ||Refresh video information
|-
|7 ||button ||User rating
|-
|8 ||button ||Play video
|-
|9 ||button ||Resume video
|-
|10 ||button ||Get video Fanart, Poster, Banner, or Thumb
|-
|11 ||button ||Play movie trailer
|-
|13 ||button ||Show all movies by the director of the selected movie
|-
|50 ||container ||List of cast members of the currently selected movie
|}

=== EventLog.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|20 ||button ||Clear button
|-
|21 ||button ||Level button
|-
|22 ||radiobutton ||Only show current level radiobutton
|-
|50 ||container ||Container with event loglines
|}

=== FileBrowser.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|450 ||container ||Directory list
|-
|451 ||container ||List of available thumbnails
|-
|411 ||label ||Heading label
|-
|412 ||label ||Path of the selected item
|-
|413 ||button ||OK button
|-
|414 ||button ||Cancel button
|-
|415 ||button ||Create folder
|-
|416 ||radiobutton ||Flip Image horizontally
|}

=== FileManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|12 ||label ||Number of items in directory list 1
|-
|13 ||label ||Number of items in directory list 2
|-
|20 ||container ||Directory list 1
|-
|21 ||container ||Directory list 2
|-
|101 ||label ||Path of the currently selected directory in list 1
|-
|102 ||label ||Path of the currently selected directory in list 2
|}

=== GameOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1101 ||label ||Help text
|-
|1102 ||gamecontroller ||Controller layout
|}

=== LoginScreen.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|3 ||label ||Number of the currently selected profile
|-
|52 ||container ||List of the available profiles
|}

=== MusicOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|500 ||button ||Select visualization
|-
|501 ||button ||Lock visualization to the current preset
|}

=== MusicVisualisation.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||visualisation ||Background Visualization
|}

=== MyMusicNav.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Switch to file mode
|-
|8 ||edit ||Search for a string anywhere in the Kodi music database
|-
|12 ||label ||Number of items in the list
|-
|15 ||label ||Filter label
|-
|16 ||radiobutton ||Start party mode (randomly play songs from your entire music collection)
|-
|17 ||button ||Manually enter artist and album name to lookup the artist and album information on the internet
|-
|18 ||label ||Warning to the user to turn off library mode when no scanned media is found
|-
|19 ||radiobutton / edit||Filter the media files to only show items that include the specified string in the name
|-
|20 ||button ||Update library
|}

=== MyMusicPlaylistEditor.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Load the playlist
|-
|7 ||button ||Save the playlist
|-
|8 ||button ||Clear the playlist
|-
|12 ||label ||Number of items in the current directory or library list
|-
|XX ||container ||List allowing you to browse your directories and music library
|-
|100 ||container ||List of songs in the playlist
|-
|101 ||label ||Number of items in the playlist
|}

=== MyPics.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|6 ||button ||Start a picture slideshow
|-
|7 ||button ||Start a recursive picture slideshow
|-
|9 ||radiobutton ||Randomize the picture slideshow
|-
|12 ||label ||Number of items in the list
|}

=== MyPlaylist.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|12 ||label ||Number of items in the playlist
|-
|20 ||radiobutton ||Shuffle the playlist
|-
|21 ||button ||Save the playlist
|-
|22 ||button ||Clear the playlist
|-
|23 ||button ||Play the playlist
|-
|24 ||button ||Play the next item in the playlist
|-
|25 ||button ||Play the previous item in the playlist
|-
|26 ||button ||Put the playlist on repeat
|}

=== MyPrograms.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|12 ||label ||Number of items in the list
|}

=== MyPVRChannels.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|6 ||radiobutton ||Show hidden channels
|-
|28 ||button ||Channel groups button
|-
|29 ||label ||Channel groups name
|-
|31 ||radiobutton ||Filter
|}

=== MyPVRGuide.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|10 ||epggrid ||EPG Guide Timeline
|-
|11 ||container ||Channel groups selector
|-
|28 ||button ||Channel groups button
|-
|29 ||label ||View name (Now / Next / Timeline)
|-
|30 ||label ||Channel groups name
|}

=== MyPVRRecordings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Group items by folder structure
|-
|7 ||radiobutton ||Show deleted recordings
|-
|10 ||button ||Show only watched, unwatched or all recordings
|-
|28 ||button ||Channelgroups button
|-
|29 ||label ||'Deleted' (When show deleted recordings is enabled, otherwise empty)
|}

=== MyPVRSearch.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|28 ||button ||Channel groups button
|}

=== MyPVRTimers.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|8 ||radiobutton ||Hide disabled timers
|-
|28 ||button ||Channel groups button
|}

=== MyVideoNav.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||button ||Switch to file mode
|-
|6 ||button ||Play DVD (used the play physical DVD discs)
|-
|8 ||button ||Search for a string anywhere in the Kodi video database
|-
|10 ||button ||Show only watched, unwatched or all videos
|-
|12 ||label ||Number of items in the list
|-
|14 ||button ||Show only unwatched or all videos
|-
|11 ||button ||Unlock shares
|-
|15 ||label ||Filter label
|-
|16 ||button ||Start party mode (randomly play musicvideos from your collection)
|-
|18 ||label ||Warning to the user to turn off library mode when no scanned media is found
|-
|19 ||radiobutton / edit ||Filter the media files to only show items that include the specified string in the name
|-
|20 ||button ||Update library
|}

=== MyWeather.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Refresh the weather information
|-
|3 ||spincontrolex ||Change weather location
|-
|11 ||label ||Shows the time of last weather update
|-
|31 ||label ||Current day label
|-
|32 ||label ||Today's high temperature value
|-
|33 ||label ||Today's low temperature value
|-
|34 ||label ||Today's weather condition
|-
|35 ||image ||Today's weather icon
|-
|223 ||label ||Localized “Temperature” string
|-
|224 ||label ||Localized “Feels like” string
|-
|225 ||label ||Localized “UV index” string
|-
|226 ||label ||Localized “Wind” string
|-
|227 ||label ||Localized “Dew point” string
|-
|228 ||label ||Localized “Humidity” string
|}

=== Pointer.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||image ||Pointer no focus image
|-
|2 ||image ||Pointer focus image
|-
|3 ||image ||Pointer drag image
|-
|4 ||image ||Pointer click image
|}

=== SettingsCategory.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Label displaying the current settings category
|-
|3 ||grouplist ||Grouplist template for the menu
|-
|5 ||grouplist ||Grouplist template for the settings section
|-
|6 ||textbox ||Settings description
|-
|7 ||button ||Button template
|-
|8 ||radiobutton ||Radiobutton template
|-
|9 ||spincontrolex ||Spincontrolex template
|-
|10 ||button ||Button template for the menu
|-
|11 ||image ||Default separator image
|-
|12 ||edit ||Edit control template
|-
|13 ||sliderex ||Sliderex control template
|-
|14 ||label ||label template
|-
|20 ||button ||Setting level button
|}

=== SettingsProfile.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||container ||List of available profiles
|-
|4 ||button ||Enable the loginscreen
|-
|5 ||button ||Auto login
|}

=== SettingsScreenCalibration.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Coordinates label
|-
|3 ||label ||Help information
|-
|8 ||mover ||Top left mover
|-
|9 ||mover ||Right bottom mover
|-
|10 ||mover ||Subtitle position mover
|-
|11 ||resize ||Pixel aspect ratio box
|-
|20 ||videowindow ||currently playing video
|}

=== SlideShow.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||label ||Error loading image message
|-
|13 ||[any] ||These controls are visible when the slideshow is paused
|}

=== SettingsSystemInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 – 11 ||label ||Line 2 – Line 11
|-
|30 ||textbox ||privacy-policy text
|-
|40 ||label ||System information category label
|-
|52 ||label ||Kodi build label
|-
|53 ||label || Kodi build date label
|-
|94 ||button ||Show storage information
|-
|95 ||button ||Show summary information
|-
|96 ||button ||Show network information
|-
|97 ||button ||Show video information
|-
|98 ||button ||Show hardware information
|-
|99 ||button ||Show PVR information
|-
|100 ||button ||Show privacy-policy
|}

=== SmartPlaylistEditor.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|10 ||container ||List of playlist rules
|-
|12 ||button ||Name of the playlist
|-
|13 ||button ||Add a rule
|-
|14 ||button ||Remove a rule
|-
|15 ||button ||Edit a rule
|-
|16 ||button ||Match rules option (match all rules / match one or more rules)
|-
|17 ||button ||Limit rules option (number of results: 10, 25, 50, 100, etc... items)
|-
|18 ||button ||Sort rules option (order the results by: title, genre, random, etc...)
|-
|19 ||button ||Sort direction option (ascending / descending)
|-
|20 ||button ||OK button
|-
|21 ||button ||Cancel button
|-
|22 ||button ||Set Playlist type (movies, episodes, mixed, etc...)
|-
|23 ||button ||Group by
|-
|24 ||radiobutton ||Mixed
|}

=== SmartPlaylistRule.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|15 ||button ||Select field (director, duration, video resolution, etc...)
|-
|16 ||button ||Select operator (is, is not, less than, etc...)
|-
|17 ||edit ||Enter a value the rule should match
|-
|18 ||button ||OK button
|-
|19 ||button ||Cancel button
|-
|20 ||button ||Browse button
|}

=== VideoFullScreen.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Numpad seek label
|-
|10 ||label ||Line 1
|-
|11 ||label ||Line 2
|-
|12 ||label ||Line 3
|}

=== VideoOSDBookmarks.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Add a video bookmark
|-
|3 ||button ||Clear all bookmarks
|-
|4 ||button ||Use the currently selected video bookmark as the episode thumbnail
|-
|11 ||container ||List of available bookmarks
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

List of boolean conditions

2019-10-02T10:15:06Z

Davu:

{{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>.

=== 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.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| {{nowrap|v19 Addition}}
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| {{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.<br />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.<br />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.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| {{nowrap|v19 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.IsPlaybable</code>
| returns True when the selected programme can be played (PVR)
| v19 addition
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasArchive</code>
| returns True when the selected channel has a server-side back buffer (PVR)
| v19 addition
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| returns True if the item has a reminder set (PVR)
| v19 addition
|-
| <code>ListItem.HasReminderRule</code>
| returns True if the item was scheduled by a reminder timer rule (PVR)
| v19 addition
|-
| <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.
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16 addition
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17 addition
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17 addition
|-
| <code>ListItem.TimerIsActive</code>
| 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
|-
| <code>ListItem.IsNew</code>
| [PVR] will return true if the item is a premiere (for example, a Live TV show that will be first aired).
| v19 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.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17 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
|-
| Player.HasGame
| Returns true if the player is playing a game
| v18
|-
| Player.HasResolutions
| Returns true when multiple resolutions are available
| v18
|-
| Player.FrameAdvance
| Returns true if player is in frame advance mode
| v18
|}

==== 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>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|}

==== 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).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== 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.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| {{nowrap|v17 Addition}}
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| {{nowrap|v18 Addition}}
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| {{nowrap|v18 Addition}}
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| {{nowrap|v19 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 <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="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.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. 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.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. 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.AddonIsEnabeled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19 addition
|-
| <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 <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18 Addition
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, eg when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.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.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| {{nowrap|v18 Addition}}
|-
| <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}}
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|}

=== 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]]

List of built-in functions

2019-09-27T16:08:49Z

Davu:

{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} | [[Built-in scripting]] }}
<section begin="main content" />
Skins can use built-in functions with the <onclick> or <onfocus> tag. Scripts can call built-in functions with <code>xbmc.executebuiltin(function, block)</code>.

The latest up-to-date list of built-in functions can be found in the source code files in [https://github.com/xbmc/xbmc/tree/master/xbmc/interfaces/builtins].

In addition to the following list, for most <onclick> and <onfocus> button actions in the skin you can also use the functions from [[Keyboard.xml]].

<poem>
'''Example:'''
<onclick>VolumeUp</onclick>
<onclick>VolumeDown</onclick>
</poem>

'''You can use parameters with all media windows, as can be seen here:'''
* [[Opening Windows and Dialogs]]

== List of functions ==
<section begin="functions" />

=== Add-on built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>Addon.Default.OpenSettings(extensionpoint)</code>
| Open a settings dialog for the default addon of the given type (extensionpoint)
|
|-
| <code>Addon.Default.Set(extensionpoint)</code>
| Open a select dialog to allow choosing the default addon of the given type (extensionpoint)
|
|-
| <code>Addon.OpenSettings(id)</code>
| Open a settings dialog for the addon of the given id
|
|-
| <code>EnableAddon(id)</code>
| Enables the specified plugin/script
| v19 addition
|-
| <code>InstallAddon(id)</code>
| Will install the addon with the given id.
|
|-
| <code>InstallFromZip</code>
| Opens the "Install from zip"-dialog if "Unknown sources" is enabled. Prompts the warning message if not.
|
|-
| <code>RunAddon(id)</code>
| Runs the specified plugin/script
|
|-
| <code>RunAppleScript(script[,args]*)</code>
| Run the specified AppleScript command
|
|-
| <code>RunPlugin(plugin)</code>
| Runs the plugin. Full path must be specified. Does not work for folder plugins
|
|-
| <code>RunScript(script[,args]*)</code>
| Runs the python script. You must specify the full path to the script. One way to specify the full path is through the [[Special protocol|special protocol]]. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv
|
|-
| <code>StopScript(id)</code>
| Stop the script by ID or path, if running
| {{nowrap|v12 Addition}}
|-
| <code>UpdateAddonRepos</code>
| Triggers a forced update of enabled add-on repositories.
|
|-
| <code>UpdateLocalAddons</code>
| Triggers a scan of local add-on directories.
|
|-
|}

=== Android built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>StartAndroidActivity(package,[intent,dataType,dataURI])</code>
| Launch an Android native app with the given package name. Optional parms (in order): intent, dataType, dataURI. example: <nowiki>StartAndroidActivity(com.android.chrome,android.intent.action.VIEW,,http://kodi.tv/)</nowiki>
| {{nowrap|v13 Addition}}
|-
|}

=== Application built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>Extract(archive_url[, destination])</code>
| Extracts a specified archive to an optionally specified 'absolute' path.
|
|-
| <code>Mute</code>
| Mutes (or unmutes) the volume.
|
|-
| <code>NotifyAll(sender, data [, json])</code>
| Notify all connected clients
| {{nowrap|v13 Addition}}
|-
| <code>SetVolume(percent[,showvolumebar])</code>
| Sets the volume to the percentage specified. Optionally, show the Volume Dialog in Kodi when setting the volume.
|
|-
| <code>ToggleDebug</code>
| Enables/disables debug mode
| {{nowrap|v12 Addition}}
|-
| <code>ToggleDPMS</code>
| Toggle DPMS (VESA Display Power Management Signaling) mode manually
|
|-
| <code>WakeOnLan(mac)</code>
| Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).
|
|-
|}

=== CEC built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CECActivateSource</code>
| Wake up playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>CECStandby</code>
| Put playing device on standby via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
| <code>CECToggleState</code>
| Toggle state of playing device via a CEC peripheral
| {{nowrap|v13 Addition}}
|-
|}

=== GUI built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>Action(action[,window])</code>
| Executes an action (same as in keymap) for the given window or the active window if the parameter window is omitted. The parameter window can either be the window's id, or in the case of a standard window, the window's name. See [[Action IDs]] for a list of available actions.
|
|-
| <code>ActivateWindow(window[,dir,return])</code>
| Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. See [[Window IDs]] for a list of window names, and their respective ids. If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder Kodi should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that Kodi should use this folder as the "root" of the level, and thus the "parent directory" action from within this folder will return the user to where they were prior to the window activating.
|
|-
| <code>ActivateWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v12 Addition}}
|-
| <code>AlarmClock(name,command,time[,silent,loop])</code>
| Pops up a dialog asking for the length of time (mm:ss) for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the built-in command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires.
|
|-
| <code>CancelAlarm(name[,silent])</code>
| Cancel a running alarm. Set silent to true to hide the alarm notification.
|
|-
| <code>ClearProperty(key[,id])</code>
| Clears a window property for the current focused window/dialog(key), or the specified window (key,id).
|
|-
| <code>Dialog.Close(dialog[,force])</code>
| Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.
|
|-
| <code>NextChannelGroup</code>
| Navigate to the next PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|-
| <code>NextStereoMode</code>
| Changes the stereo mode of the GUI to the next available mode.
| {{nowrap|v13 Addition}}
|-
| <code>Notification(header,message[,time,image])</code>
| Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.
|
|-
| <code>PreviousChannelGroup</code>
| Navigate to the previous PVR channel group (in DialogPVRChannelsOSD.xml)
| {{nowrap|v13 Addition}}
|-
| <code>PreviousStereoMode</code>
| Changes the stereo mode of the GUI to the previous available mode.
| {{nowrap|v13 Addition}}
|-
| <code>RefreshRSS</code>
| Reload RSS feeds from RSSFeeds.xml
|
|-
| <code>ReplaceWindow(window,dir)</code>
| Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.
|
|-
| <code>ReplaceWindowAndFocus(id1, id2,item1, id3,item2)</code>
| Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).
| {{nowrap|v13 Addition}}
|-
| <code>Resolution</code>
| Change Kodi's Resolution.
|
|-
| <code>SetGUILanguage(value)</code>
| Set GUI Language, 'value' is the language file to use. SetGUILanguage(resource.language.de_de)
| {{nowrap|v13 Addition}}
|-
| <code>SetProperty(key,value[,id])</code>
| Sets a window property for the current window (key,value), or the specified window (key,value,id).
|
|-
| <code>SetStereoMode</code>
| Changes the stereo mode of the GUI. Params can be: toggle, next, previous, select, tomono or any of the supported stereomodes (off, split_vertical, split_horizontal, row_interleaved, hardware_based, anaglyph_cyan_red, anaglyph_green_magenta, monoscopic)
| {{nowrap|v13 Addition}}
|-
| <code>settingslevelchange</code>
| Toggles the visible settings (in SettingsCategory.xml) between 'basic', 'standard', 'advanced and 'expert'
| {{nowrap|v13 Addition}}
|-
| <code>TakeScreenshot([filenameandpath,sync])</code>
| Takes a Screenshot. You can optionally specify the filename (including the path). Note: only .png files are supported. Add "sync" parameter to run synchronously (slow).
|
|-
| <code>ToggleDirtyRegionVisualization</code>
| makes dirty regions visible for debugging proposes.
| {{nowrap|v16 Addition}}
|-
| <code>ToggleStereoMode</code>
| Toggle the stereoscopic mode of the GUI (on/off).
| {{nowrap|v13 Addition}}
|-
|}

=== GUI container built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>Container.NextSortMethod</code>
| Change to the next sort method.
|
|-
| <code>Container.NextViewMode</code>
| Select the next view mode.
|
|-
| <code>Container.PreviousSortMethod</code>
| Change to the previous sort method.
|
|-
| <code>Container.PreviousViewMode</code>
| Select the previous view mode.
|
|-
| <code>Container.Refresh</code>
| Refresh current listing.
|
|-
| <code>Container.SetSortMethod(id)</code>
| Change to the specified sort method. (For list of ID's see List of sort methods below)
|
|-
| <code>Container.SetViewMode(id)</code>
| Set the current view mode (list, icons etc.) to the given container id.
|
|-
| <code>Container.SetSortDirection</code>
| Toggle the sort direction.
|
|-
| <code>Container.Update</code>
| Update current listing. Send Container.Update(path,replace) to reset the path history.
|
|-
|}

=== GUI control built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>Control.Message(id,message,[windowid])</code>
| Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.
|
|-
| <code>Control.Move(id,offset)</code>
| Will make a Container with the "id" specified in the command move focus by "offset".
|
|-
| <code>Control.SetFocus(id,position[,absolute])</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Set absolute to focus the first listitem of a container instead of the first visible listitem. Alias SetFocus(id,position)
|
|-
| <code>PageDown</code>
| Send a page down event to the pagecontrol with given id.
|
|-
| <code>PageUp</code>
| Send a page up event to the pagecontrol with given id.
|
|-
| <code>SendClick(windowid,id)</code>
| Sends a click to a control in a given window (or active window if omitted).
|
|-
| <code>SetFocus(id,position[,absolute])</code>
| Will make a list with the "id" specified in the command gain focus at "position" number in its list. Set absolute to focus the first listitem of a container instead of the first visible listitem. Alias Control.SetFocus(id,position)
|
|-
|}

=== Library built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>CleanLibrary(database)</code>
| This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either "video" or "music" as a parameter to begin cleaning the corresponding database.
|
|-
| <code>exportlibrary(music,false,filepath)</code>
| The music library will be exported to a single file stored at filepath location.
|
|-
| <code>exportlibrary(video,true,thumbs,overwrite,actorthumbs)</code>
| The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).
|
|-
| <code>UpdateLibrary(database,[path])</code>
| Takes either "video" or "music" as a parameter to begin updating the corresponding database. For "video" you can additionally specify a specific path to be scanned.
|
|-
| <code>VideoLibrary.Search</code>
| Brings up a search dialog which will search the library
|
|-
|}

=== Optical container built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>EjectTray()</code>
| Either opens or closes the DVD tray, depending on its current state
|
|-
| <code>RipCD</code>
| Will rip the inserted CD from the DVD-ROM drive.
|
|-
|}

=== Picture built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>RecursiveSlideShow(dir)</code>
| Run a slideshow from the specified directory, including all subdirs
|
|-
| <code>ShowPicture(picture)</code>
| Show a picture by its file path/url.
| {{nowrap|v13 Addition}}
|-
| <code>SlideShow(dir[,recursive][,[not]random][,pause][,beginslide="/path/to/start/slide.jpg"])</code>
| Starts a slideshow of pictures in the folder dir. Optional parameters are 'recursive', 'random' or 'notrandom', 'pause' and 'beginslide="/path/to/some/image.jpg"' parameters. The "recursive" parameter starts a recursive slideshow, adding images from sub-folders. The "random" and "notrandom" parameters override the Randomize setting found in the pictures media window. The "pause" parameter will start the slideshow paused. "beginslide" will start the slideshow with the specified image.
|
|-
|}

=== Player built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PlayDisc(param)</code>
| Will play the inserted CD or DVD media from the DVD-ROM drive.
|
|-
| <code>PlayerControl(command)</code>
| Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, FrameAdvance(#), TempoUp, TempoDown, Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file) or Reset.
Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter. Reset only applies to games and will reset the currently playing game.
|
|-
| <code>PlayerResolutionSelect</code>
| Select a different resolution
| v18
|-
| <code>Playlist.Clear</code>
| Clear the current playlist
|
|-
| <code>Playlist.PlayOffset</code>
| Start playing from a particular offset in the playlist
|
|-
| <code>PlayMedia(media[,isdir][,1],[playoffset=xx],[resume],[noresume])</code>
| Plays the media. This can be a playlist, music, or video file, directory, plugin or a url. The optional parameter ",isdir" can be used for playing a directory. ",1" will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from. Set "resume" to force resuming. Set "noresume" to force not resuming.
|
|-
| <code>PlayWith()</code>
| Play the selected item with the specified player core.
|
|-
| <code>Seek(seconds)</code>
| Seeks to the specified relative amount of seconds within the current playing media. A negative value will seek backward and a positive value forward.
| {{nowrap|v15 Addition}}
|-
|}

=== Profile built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>LoadProfile(profilename,[prompt])</code>
| Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.
|
|-
| <code>Mastermode</code>
| Runs Kodi in master mode
|
|-
| <code>System.LogOff</code>
| Log off current user.
|
|-
|}

=== PVR built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>PVR.SearchMissingChannelIcons</code>
| Will start a search for missing channel icons
| {{nowrap|v16 Addition}}
|-
| <code>PVR.ToggleRecordPlayingChannel</code>
| Will toggle recording on playing channel, if any
| v18
|-
| <code>PVR.SeekPercentage</code>
| Performs a seek to the given percentage in timeshift buffer, if timeshifting is supported
|
|}

=== Skin built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>ReloadSkin()</code>
| Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)
|
|-
| <code>Skin.Reset(setting)</code>
| Resets the skin setting ?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>Skin.SelectBool(header, label1|setting1, label2|setting2)</code>
| Pops up select dialog to select between multiple skin setting options. Skin.SelectBool(424, 31411|RecentWidget, 31412|RandomWidget, 31413|InProgressWidget)
|
|-
| <code>Skin.SetAddon(string,type)</code>
| Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are xbmc.addon.video, xbmc.addon.audio, xbmc.addon.image, xbmc.addon.executable and kodi.gameclient.
|
|-
| <code>Skin.SetBool(setting)</code>
| Sets the skin setting ?setting? to true, for use with the conditional visibility tags containing Skin.HasSetting(setting). The settings are saved per-skin in settings.xml just like all the other Kodi settings.
|
|-
| <code>Skin.SetFile(string,mask,folderpath)</code>
| Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the info tag Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using "<nowiki>|</nowiki>" (minus quotes). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetImage(string[,value,path])</code>
| Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly. the path option allows you to open the file browser in the specified folder.
|
|-
| <code>Skin.SetNumeric(numeric[,value])</code>
| Pops up a keyboard dialog and allows the user to input a numerical.
|
|-
| <code>Skin.SetPath(string[,folderpath])</code>
| Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the info tag Skin.String(string). If the folderpath parameter is set the file browser will start in that folder.
|
|-
| <code>Skin.SetString(string[,value])</code>
| Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the info tag Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.
|
|-
| <code>Skin.Theme(1)</code>
| Cycles the skin theme. Skin.Theme(-1) will go backwards.
|
|-
| <code>Skin.ToggleDebug</code>
| Toggles skin debug info on/off
|
|-
| <code>Skin.ToggleSetting(setting)</code>
| Toggles the skin setting ?setting? for use with conditional visibility tags containing Skin.HasSetting(setting).
|
|-
| <code>UnloadSkin()</code>
| Unloads the current skin
|
|-
|}

=== System built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>ActivateScreensaver</code>
| Starts the screensaver
| {{nowrap|v13 Addition}}
|-
| <code>Hibernate</code>
| Hibernate (S4) the System
|
|-
| <code>InhibitIdleShutdown(true/false)</code>
| Prevent the system to shutdown on idle.
| {{nowrap|v12 Addition}}
|-
| <code>Minimize</code>
| Minimizes Kodi
|
|-
| <code>Powerdown</code>
| Powerdown system
|
|-
| <code>Quit</code>
| Quits Kodi
|
|-
| <code>Reboot</code>
| Cold reboots the system (power cycle)
|
|-
| <code>Reset</code>
| Reset the system (same as reboot)
|
|-
| <code>RestartApp</code>
| Restarts Kodi (only implemented under Windows and Linux)
|
|-
| <code>ShutDown</code>
| Trigger default Shutdown action defined in System Settings
|
|-
| <code>Suspend</code>
| Suspends (S3 / S1 depending on bios setting) the System
|
|-
| <code>System.Exec(exec)</code>
| Execute shell commands. The full path to the script has to be placed inside the parentheses.
|
|-
| <code>System.ExecWait(exec)</code>
| Execute shell commands and freezes Kodi until shell is closed. As well as for "System.Exec(exec)", the full path to the script has to be placed inside the parentheses.
|
|-
|}

=== Weather built-in's ===

{| class="prettytable sort sortable" style="width: 100%;"
! style="width: 29%"| Function
! style="width: 66%"| Description
! style="width: 5%"| Version
|-
| <code>Weather.LocationNext</code>
| Switch to next weather location
|
|-
| <code>Weather.LocationPrevious</code>
| Switch to previous weather location
|
|-
| <code>Weather.LocationSet</code>
| Switch to given weather location (parameter can be 1-3)
|
|-
| <code>Weather.Refresh</code>
| Force weather data refresh
|
|}
<section end="functions" />
<section end="main content" />

== Removed functions ==
* <code>LastFM.Love</code> - Removed in v13 Gotham
* <code>LastFM.Ban</code> - Removed in v13 Gotham
* <code>LCD.Suspend</code> - Removed in v13 Gotham
* <code>LCD.Resume</code> - Removed in v13 Gotham
* <code>AllowIdleShutdown</code>
* <code>Help</code>
* <code>LIRC.Send(command)</code>
* <code>LIRC.Start</code>
* <code>LIRC.Stop</code>
* <code>StartPVRManager</code>
* <code>StereoModeToMono</code>
* <code>StopPVRManager</code>

== List of sort methods ==
These ID's can be used with the Container.SetSortMethod(id) function as listed [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/SortUtils.cpp#L529-L577 here]:
{| class="prettytable"
! ID
! Description
|-
| <code>1</code>
| Name
|-
| <code>2</code>
| Date
|-
| <code>3</code>
| Size
|-
| <code>4</code>
| File
|-
| <code>5</code>
| Path
|-
| <code>6</code>
| DriveType
|-
| <code>7</code>
| Title
|-
| <code>8</code>
| TrackNumber
|-
| <code>9</code>
| Time
|-
| <code>10</code>
| Artist
|-
| <code>11</code>
| ArtistThenYear
|-
| <code>12</code>
| Album
|-
| <code>13</code>
| AlbumType
|-
| <code>14</code>
| Genre
|-
| <code>15</code>
| Country
|-
| <code>16</code>
| Year
|-
| <code>17</code>
| Rating
|-
| <code>18</code>
| UserRating
|-
| <code>19</code>
| Votes
|-
| <code>20</code>
| Top250
|-
| <code>21</code>
| ProgramCount
|-
| <code>22</code>
| PlaylistOrder
|-
| <code>23</code>
| EpisodeNumber
|-
| <code>24</code>
| Season
|-
| <code>25</code>
| NumberOfEpisodes
|-
| <code>26</code>
| NumberOfWatchedEpisodes
|-
| <code>27</code>
| TvShowStatus
|-
| <code>28</code>
| TvShowTitle
|-
| <code>29</code>
| SortTitle
|-
| <code>30</code>
| ProductionCode
|-
| <code>31</code>
| MPAA
|-
| <code>32</code>
| VideoResolution
|-
| <code>33</code>
| VideoCodec
|-
| <code>34</code>
| VideoAspectRatio
|-
| <code>35</code>
| AudioChannels
|-
| <code>36</code>
| AudioCodec
|-
| <code>37</code>
| AudioLanguage
|-
| <code>38</code>
| SubtitleLanguage
|-
| <code>39</code>
| Studio
|-
| <code>40</code>
| DateAdded
|-
| <code>41</code>
| LastPlayed
|-
| <code>42</code>
| Playcount
|-
| <code>43</code>
| Listeners
|-
| <code>44</code>
| Bitrate
|-
| <code>45</code>
| Random
|-
| <code>46</code>
| Channel
|-
| <code>47</code>
| ChannelNumber
|-
| <code>48</code>
| DateTaken
|-
| <code>49</code>
| Relevance
|-
| <code>50</code>
| InstallDate
|-
| <code>51</code>
| LastUpdated
|-
| <code>52</code>
| LastUsed
|}
{{updated|18}}

== See also ==
* [[Action IDs]]

[[Category:Python]]
[[Category:Add-on development]]
[[Category:Skin development]]

List of boolean conditions

2019-09-27T16:04:52Z

Davu:

{{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>.

=== 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.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| {{nowrap|v19 Addition}}
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| {{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.<br />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.<br />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.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| {{nowrap|v19 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.IsPlaybable</code>
| returns True when the selected programme can be played (PVR)
| v19 addition
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasArchive</code>
| returns True when the selected channel has a server-side back buffer (PVR)
| v19 addition
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| returns True if the item has a reminder set (PVR)
| v19 addition
|-
| <code>ListItem.HasReminderRule</code>
| returns True if the item was scheduled by a reminder timer rule (PVR)
| v19 addition
|-
| <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.
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16 addition
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17 addition
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17 addition
|-
| <code>ListItem.TimerIsActive</code>
| 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.PauseEnabled</code>
| Returns true if the currently playing stream can be paused.
|
|-
| <code>Player.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17 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
|-
| Player.HasGame
| Returns true if the player is playing a game
| v18
|-
| Player.HasResolutions
| Returns true when multiple resolutions are available
| v18
|-
| Player.FrameAdvance
| Returns true if player is in frame advance mode
| v18
|}

==== 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>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|}

==== 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).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== 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.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| {{nowrap|v17 Addition}}
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| {{nowrap|v18 Addition}}
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| {{nowrap|v18 Addition}}
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| {{nowrap|v19 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 <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="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.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. 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.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. 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.AddonIsEnabeled(id)</code>
| Returns true if the specified addon is enabled on the system
| v19 addition
|-
| <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 <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18 Addition
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, eg when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.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.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| {{nowrap|v18 Addition}}
|-
| <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}}
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|}

=== 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]]

InfoLabels

2019-09-02T06:55:20Z

Davu:

{{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]

=== 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).NumAllItems
| Number of all items in the container or grouplist with given id including parent folder item.
| v18
|-
| Container(id).NumNonFolderItems
| Number of items in the container or grouplist with given id excluding all folder items.
| v18
|-
| 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 absolute 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 the 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 at position 'id' in a Container. the id is an offset to the first *visible* item of the container. ''( 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.
|
|}

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== 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.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| 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.Property(Album_Rating)
| Shows the scraped rating of the currently selected Album
|
|-
| ListItem.Property(Album_UserRating)
| Shows the user rating 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.FileNameNoExtension
| Returns the filename without its extension.
| v19
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| 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.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, 8K [Note: v18 addition]). 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.
| v18
|-
| 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.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (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
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|-
| ListItem.CurrentItem
| will return the current index of the item in a container starting at 1.
| v19
|}

=== 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.Volume
| Returns the volume level in dB
|
|-
| Player.PlaySpeed
| Current playspeed. (range:0.8 to 1.5)
|
|-
| 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
|
|-
| Player.CutList
| this infolabel can be used with the [[Ranges control]], as EDL and chapter markers
| v19
|-
| Player.Chapters
| this infolabel can be used with the [[Ranges control]], as EDL and chapter markers
| v19
|}

==== 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.Property(Artist_Sortname)
| Sortname of the currently playing Artist
| v18
|-
| MusicPlayer.Property(Artist_Type)
| Type of the currently playing Artist - person, group, orchestra, choir etc.
| v18
|-
| MusicPlayer.Property(Artist_Gender)
| Gender of the currently playing Artist - male, female, other
| v18
|-
| MusicPlayer.Property(Artist_Disambiguation)
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| 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.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.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 'On' or 'Off'
|
|-
| 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.EpgEventDuration[(format)]
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventElapsedTime[(format)]
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventRemainingTime[(format)]
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventFinishTime[(format)]
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventSeekTime[(format)]
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventProgress
| Returns the position of currently played title on TV as integer
|
|-
| PVR.TimeShiftStart[(format)]
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftEnd[(format)]
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftCur[(format)]
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| PVR.TimeShiftOffset[(format)]
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| 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}}
|-
| PVR.ChannelNumberInput
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| PVR.TimeshiftProgressDuration
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressDuration(format)
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressStartTime
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressStartTime(format)
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressEndTime
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressEndTime(format)
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressPlayPos
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgStart
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgEnd
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferStart
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferEnd
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|}

=== 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 <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| 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 <span class="nobr">DVD-ROM</span> 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.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.Progressbar
| The percentage of the currently active progress.
|
|-
| 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 ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Fanart.Image
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| 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 default icon.
|
|-
| ListItem.ActualIcon
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| 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.EPGEventIcon
| Returns the icon of the EPG programme (if available).
| v18
|-
| ListItem.Property(Fanart_Image)
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| MusicPlayer.Cover
| Cover of currently playing album
|
|-
| MusicPlayer.Property(Fanart_Image)
| Fanart image of the currently playing artist
|
|-
| Player.Icon
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| 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.
|
|-
| Pvr.EPGEventIcon
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| 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 <span class="nobr">user-customisable</span> 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. Note: Deprecated, use ListItem.Art(poster) instead.
|
|-
| Weather.ConditionsIcon
| 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]]

Ranges Control

2019-09-02T06:53:03Z

Davu: Created page with "The ranges control is used for showing multiple range UI elements on the same control. It is used in Kodi, for example, to show the intervals of a cutlist (EDL) or chapters in..."

The ranges control is used for showing multiple range UI elements on the same control. It is used in Kodi, for example, to show the intervals of a cutlist (EDL) or chapters in the video seekbar. You can choose the position, size and look and feel of the control.

===Example===

<syntaxhighlight lang="XML" enclose="div">
<control type="ranges">
<left>0</left>
<top>70</top>
<width>100%</width>
<height>8</height>
<texturebg border="3" colordiffuse="00FFFFFF">colors/white50.png</texturebg>
<lefttexture>colors/white.png</lefttexture>
<midtexture colordiffuse="FFFF0000">colors/white.png</midtexture>
<righttexture>colors/white.png</righttexture>
<info>Player.Cutlist</info>
</control>
</syntaxhighlight>

===Available tags===

=== Available tags ===
In addition to the '''[[Default Control Tags]]''' the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case'''-'''sensitive.

{| class="prettytable"
! Tag
! Description
|-
| texturebg
| The background texture for the range control.
|-
| lefttexture
| The texture used in the left hand side of the range
|-
| midtexture
| The texture used for the mid section of the range
|-
| righttexture
| The texture used in the right hand side of the range
|-
| info
| Specifies the information the range control holds. It expects an infolabel that returns a string in CSV format: e.g. "start1,end1,start2,end2,...". Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token. Examples of currently supported infolabels are <code>Player.CutList</code> and <code>Player.Chapters</code> which can be found at the specific infolabels-section: [[InfoLabels#Player_labels | Player labels]]
|}

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

InfoLabels

2019-09-02T06:35:47Z

Davu:

{{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]

=== 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).NumAllItems
| Number of all items in the container or grouplist with given id including parent folder item.
| v18
|-
| Container(id).NumNonFolderItems
| Number of items in the container or grouplist with given id excluding all folder items.
| v18
|-
| 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 absolute 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 the 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 at position 'id' in a Container. the id is an offset to the first *visible* item of the container. ''( 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.
|
|}

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== 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.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| 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.Property(Album_Rating)
| Shows the scraped rating of the currently selected Album
|
|-
| ListItem.Property(Album_UserRating)
| Shows the user rating 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.FileNameNoExtension
| Returns the filename without its extension.
| v19
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| 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.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, 8K [Note: v18 addition]). 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.
| v18
|-
| 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.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (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
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|-
| ListItem.CurrentItem
| will return the current index of the item in a container starting at 1.
| v19
|}

=== 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.Volume
| Returns the volume level in dB
|
|-
| Player.PlaySpeed
| Current playspeed. (range:0.8 to 1.5)
|
|-
| 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
|
|-
| Player.CutList
| this infolabel can be used with the ranges control, as EDL and chapter markers
| v19
|-
| Player.Chapters
| this infolabel can be used with the ranges control, as EDL and chapter markers
| v19
|}

==== 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.Property(Artist_Sortname)
| Sortname of the currently playing Artist
| v18
|-
| MusicPlayer.Property(Artist_Type)
| Type of the currently playing Artist - person, group, orchestra, choir etc.
| v18
|-
| MusicPlayer.Property(Artist_Gender)
| Gender of the currently playing Artist - male, female, other
| v18
|-
| MusicPlayer.Property(Artist_Disambiguation)
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| 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.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.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 'On' or 'Off'
|
|-
| 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.EpgEventDuration[(format)]
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventElapsedTime[(format)]
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventRemainingTime[(format)]
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventFinishTime[(format)]
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventSeekTime[(format)]
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventProgress
| Returns the position of currently played title on TV as integer
|
|-
| PVR.TimeShiftStart[(format)]
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftEnd[(format)]
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftCur[(format)]
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| PVR.TimeShiftOffset[(format)]
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| 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}}
|-
| PVR.ChannelNumberInput
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| PVR.TimeshiftProgressDuration
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressDuration(format)
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressStartTime
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressStartTime(format)
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressEndTime
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressEndTime(format)
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressPlayPos
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgStart
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgEnd
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferStart
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferEnd
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|}

=== 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 <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| 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 <span class="nobr">DVD-ROM</span> 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.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.Progressbar
| The percentage of the currently active progress.
|
|-
| 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 ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Fanart.Image
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| 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 default icon.
|
|-
| ListItem.ActualIcon
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| 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.EPGEventIcon
| Returns the icon of the EPG programme (if available).
| v18
|-
| ListItem.Property(Fanart_Image)
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| MusicPlayer.Cover
| Cover of currently playing album
|
|-
| MusicPlayer.Property(Fanart_Image)
| Fanart image of the currently playing artist
|
|-
| Player.Icon
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| 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.
|
|-
| Pvr.EPGEventIcon
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| 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 <span class="nobr">user-customisable</span> 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. Note: Deprecated, use ListItem.Art(poster) instead.
|
|-
| Weather.ConditionsIcon
| 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]]

List of boolean conditions

2019-09-02T06:28:51Z

Davu:

{{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>.

=== 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.<br />Example: Integer.IsEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsEven([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is even.<br />Example: Integer.IsEven(ListItem.CurrentItem)
| {{nowrap|v19 Addition}}
|-
| <code>Integer.IsGreater([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than to the supplied number.<br />Example: Integer.IsGreater(ListItem.Year,2000)
| {{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.<br />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.<br />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.<br />Example: Integer.IsLessOrEqual(ListItem.Year,2000)
| {{nowrap|v17 Addition}}
|-
| <code>Integer.IsOdd([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is odd.<br />Example: Integer.IsOdd(ListItem.CurrentItem)
| {{nowrap|v19 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.IsPlaybable</code>
| returns True when the selected programme can be played (PVR)
| v19 addition
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|
|-
| <code>ListItem.IsCollection</code>
| Returns true when the current ListItem is a movie set
|
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|
|-
| <code>ListItem.HasArchive</code>
| returns True when the selected channel has a server-side back buffer (PVR)
| v19 addition
|-
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR)
|
|-
| <code>ListItem.HasReminder</code>
| returns True if the item has a reminder set (PVR)
| v19 addition
|-
| <code>ListItem.HasReminderRule</code>
| returns True if the item was scheduled by a reminder timer rule (PVR)
| v19 addition
|-
| <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.
|
|-
| <code>ListItem.HasTimerSchedule</code>
| Whether the item is part of a repeating timer schedule (PVR).
| v16 addition
|-
| <code>ListItem.TimerHasError</code>
| Whether the item has a timer and it won't be recorded because of an error (PVR).
| v17 addition
|-
| <code>ListItem.TimerHasConflict</code>
| Whether the item has a timer and it won't be recorded because of a conflict (PVR).
| v17 addition
|-
| <code>ListItem.TimerIsActive</code>
| 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.Caching</code>
| Returns true if the player is current <span class="nobr">re-caching</span> data (internet based video playback).
|
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true for the first 2.5 seconds after a seek.
|
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|
|-
| <code>Player.SeekEnabled</code>
| Returns true if player can seek
|
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|
|-
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream.
|
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|
|-
| <code>Player.Process(videohwdecoder)</code>
| Returns true if the currently playing video is decoded in hardware
| v17 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
|-
| Player.HasGame
| Returns true if the player is playing a game
| v18
|-
| Player.HasResolutions
| Returns true when multiple resolutions are available
| v18
|-
| Player.FrameAdvance
| Returns true if player is in frame advance mode
| v18
|}

==== 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>MusicPlayer.Content(parameter)</code>
| Returns true if the current audio you are playing matches the specified content. The following values are accepted: files, livetv
|
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|
|}

==== 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).
|
|-
| <code>VideoPlayer.HasTeletext</code>
| Returns true when teletext is available.
|
|}

=== 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.HasTVChannels</code>
| Returns true if there are tv channels available
|
|-
| <code>Pvr.HasRadioChannels</code>
| Returns true if there are radio channels available
|
|-
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched.
|
|-
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to.
|
|-
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched.
|
|-
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme.
|
|-
| <code>Pvr.IsTimeShift</code>
| Returns true when the playback is timeshifted.
|
|-
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted
|
|-
| <code>Pvr.RadioNextRecordingChannelIcon</code>
| Icon of the next recording radio channel
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.IsRecordingTV</code>
| Returns true when the system is recording a tv programme.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasTVTimer</code>
| Returns true if at least one tv timer is active.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasNonRecordingTVTimer</code>
| Returns true if there are tv timers present who currently not do recording
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.IsRecordingRadio</code>
| Returns true when the system is recording a radio programme.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasRadioTimer</code>
| Returns true if at least one radio timer is active.
| {{nowrap|v17 Addition}}
|-
| <code>Pvr.HasNonRecordingRadioTimer</code>
| Returns true if there are radio timers present who currently not do recording
| {{nowrap|v17 Addition}}
|
|-
| <code>Pvr.CanRecordPlayingChannel</code>
| Returns true if the player can record the current internet stream.
| {{nowrap|v18 Addition}}
|-
| <code>Pvr.IsRecordingPlayingChannel</code>
| Returns true if the player is recording the current internet stream.
| {{nowrap|v18 Addition}}
|-
| <code>Pvr.IsPlayingActiveRecording</code>
| Returns true when Kodi is currently playing a recording that is in progress.
| {{nowrap|v19 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 <span class="nobr">skin-specified</span> setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is <span class="nobr">non-empty</span>.
|
|-
| <code>Skin.String(string1,string2)</code>
| Same as String.IsEqual(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|
|}

=== SlideShow ===
{| class="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.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.IsEqual([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] is equal to the given string.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.StartsWith([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] starts with the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. 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.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
| {{nowrap|v17 Addition}}
|-
| <code>String.Contains([[InfoLabels|info]],substring)</code>
| Returns true if the [[InfoLabels|info]] contains the given substring.<br />Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. 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 <span class="nobr">DVD-ROM</span> drive.
|
|-
| <code>System.HasMediaAudioCD</code>
| Returns true if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
| v18 Addition
|-
| <code>System.IdleTime(time)</code>
| Returns true if Kodi has had no input for ?time? amount of seconds.
|
|-
| <code>System.IsStandalone</code>
| Returns true if Kodi is running in standalone mode.
|
|-
| <code>System.IsFullscreen</code>
| Returns true if Kodi is running fullscreen.
|
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|
|-
| <code>System.HasActiveModalDialog</code>
| Returns true true when a modal dialog is active, disregarding any animations (Leia (v18) and newer versions)
| v18
|-
| <code>System.HasVisibleModalDialog</code>
| Returns true if a modal dialog is visible, eg when the animations are finished (Leia (v18) and newer versions)
| v18
|-
| <code>System.Time(startTime,endTime)</code>
| Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
|
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|
|-
| <code>System.Platform.Linux</code>
| Returns true if Kodi is running on a linux/unix based computer.
|
|-
| <code>System.Platform.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.Android</code>
| Returns true if Kodi is running on an android device.
|
|-
| <code>System.Platform.UWP</code>
| Returns true if Kodi is running on Universal Windows Platform (UWP).
| {{nowrap|v18 Addition}}
|-
| <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}}
|-
| <code>System.GetBool(boolean)</code>
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| <code>System.HasLocks</code>
| Returns true if the profile has lock preferences configured
|
|-
| <code>System.IsMaster</code>
| Returns true if the profile has entered the master mode
|
|}

=== 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]]

InfoLabels

2019-07-13T09:13:55Z

Davu:

{{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]

=== 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).NumAllItems
| Number of all items in the container or grouplist with given id including parent folder item.
| v18
|-
| Container(id).NumNonFolderItems
| Number of items in the container or grouplist with given id excluding all folder items.
| v18
|-
| 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 absolute 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 the 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 at position 'id' in a Container. the id is an offset to the first *visible* item of the container. ''( 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.
|
|}

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== 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.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| 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.Property(Album_Rating)
| Shows the scraped rating of the currently selected Album
|
|-
| ListItem.Property(Album_UserRating)
| Shows the user rating 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.FileNameNoExtension
| Returns the filename without its extension.
| v19
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| 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.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, 8K [Note: v18 addition]). 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.
| v18
|-
| 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.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (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
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|}

=== 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.Volume
| Returns the volume level in dB
|
|-
| 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.Property(Artist_Sortname)
| Sortname of the currently playing Artist
| v18
|-
| MusicPlayer.Property(Artist_Type)
| Type of the currently playing Artist - person, group, orchestra, choir etc.
| v18
|-
| MusicPlayer.Property(Artist_Gender)
| Gender of the currently playing Artist - male, female, other
| v18
|-
| MusicPlayer.Property(Artist_Disambiguation)
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| 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.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.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 'On' or 'Off'
|
|-
| 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.EpgEventDuration[(format)]
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventElapsedTime[(format)]
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventRemainingTime[(format)]
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventFinishTime[(format)]
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventSeekTime[(format)]
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventProgress
| Returns the position of currently played title on TV as integer
|
|-
| PVR.TimeShiftStart[(format)]
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftEnd[(format)]
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftCur[(format)]
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| PVR.TimeShiftOffset[(format)]
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| 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}}
|-
| PVR.ChannelNumberInput
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| PVR.TimeshiftProgressDuration
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressDuration(format)
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressStartTime
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressStartTime(format)
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressEndTime
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressEndTime(format)
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressPlayPos
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgStart
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgEnd
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferStart
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferEnd
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|}

=== 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 <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| 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 <span class="nobr">DVD-ROM</span> 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.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.Progressbar
| The percentage of the currently active progress.
|
|-
| 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 ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Fanart.Image
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| 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 default icon.
|
|-
| ListItem.ActualIcon
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| 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.EPGEventIcon
| Returns the icon of the EPG programme (if available).
| v18
|-
| ListItem.Property(Fanart_Image)
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| MusicPlayer.Cover
| Cover of currently playing album
|
|-
| MusicPlayer.Property(Fanart_Image)
| Fanart image of the currently playing artist
|
|-
| Player.Icon
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| 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.
|
|-
| Pvr.EPGEventIcon
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| 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 <span class="nobr">user-customisable</span> 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. Note: Deprecated, use ListItem.Art(poster) instead.
|
|-
| Weather.ConditionsIcon
| 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]]

Opening Windows and Dialogs

2019-07-07T10:43:50Z

Davu:

{{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 ||library://music/
|-
|   || 
|-
|Genres ||musicdb://genres/
|-
|Artists ||musicdb://artists/
|-
|Albums ||musicdb://albums/
|-
|Song ||musicdb://songs/
|-
|Top100 ||musicdb://top100/
|-
|Top100Songs ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://compilations/
|-
|Years ||musicdb://years/
|-
|Singles ||musicdb://singles/
|-
|   || 
|-
|Files ||sources://music/
|-
|Playlists ||special://musicplaylists/
|-
|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/
|}

== PVR ==
There are different PVR windows, one for every PVR content type (channels, recordings, timers, timer rules, search) not a single PVR window with sub sections denoting the different content types.

Currently, most PVR windows cannot be activated using user supplied paths. Support for more windows may be added in the future.

Example: <pre>ActivateWindow(TVRecordings,pvr://recordings/tv/active/FooDirectory/)</pre> will open the TV recordings window prepoulated with the recordings contained in directory FooDirectory.

{| class="prettytable"
! Window Name !! Path !! Notes !! Kodi version
|-
|TVChannels || pvr://channels/tv/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific tv channel group || Kodi 19
|-
|TVGuide || pvr://channels/tv/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific tv channel group || Kodi 19
|-
|TVRecordings ||pvr://recordings/tv/active/<DIRECTORY>/ || Replace <DIRECTORY> with the name of the recording directory to display
|-
|TVTimers || || ||
|-
|TVTimerRules || || ||
|-
|TVSearch || || ||
|-
|RadioChannels || pvr://channels/radio/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific radio channel group || Kodi 19
|-
|RadioGuide || pvr://channels/radio/<GROUPNAME> || Replace <GROUPNAME> with the name of the specific radio channel group || Kodi 19
|-
|RadioRecordings ||pvr://recordings/radio/active/<DIRECTORY>/ ||Replace <DIRECTORY> with the name of the recording directory to display
|-
|RadioTimers || || ||
|-
|RadioTimerRules || || ||
|-
|RadioSearch || || ||
|}

== Notes ==
<references />

[[Category:Skin development]]
[[Category:Add-on development]]
[[Category:Python]]

Profiles

2019-07-07T08:40:21Z

Davu:

__TOC__
{{-}}
<section begin=intro />Profiles allow users to save all of settings as a profile and change them at the touch of a button. It also allows you to grant access to specific folders and network shares based on the profile being used. This is ideal for systems that have multiple users. It works much the same as setting up individual users on your home computer.<section end=intro />

These individual profiles allow you to customize the environment for multiple users, allowing for such functionality as:
* Customized view settings such as skins for each user
* The ability to lock folders, such as network shares on a per-user basis
* Separate media [[Databases|libraries]] for each user
* Unique RSS feeds for each user
* Unique [[Keymap|keymapping]] for each user
* Unique network settings
All options stored in the [[userdata folder]] can be customized per profile, allowing for an amazing amount of flexibility.

{{-}}

== Adding a profile ==

In order to add a profile, follow the steps below

<gallery mode="packed" widths=500px heights=283px>
File:Estuary_Profiles_Adding_Profile_1.jpg| '''Step 1:''' Select "Add profile"
File:Estuary_Profiles_Adding_Profile_2.jpg| '''Step 2:''' Enter a name for the profile
File:Estuary_Profiles_Adding_Profile_3.jpg| '''Step 3:''' Select a directory for your profile at which your personalized settings will be stored.<br />'''OK''' will choose the 'default' folder which will be stored under the [[Userdata|userdata]]-folder and will have the same name as the profile name. <br />'''New folder''' will give you the option to specify a self-created folder for your profile which you need to select after a name for it was given. The folder for the profile will then be found under: userdata -> profiles -> <created folder name>
File:Estuary_Profiles_Adding_Profile_4.jpg| '''Step 4:''' Select specific profile settions which are explained below
File:Estuary_Profiles_Adding_Profile_5.jpg| '''Step 5:''' Choose to copy settings from the defaul user ot start with default settings
File:Estuary_Profiles_Adding_Profile_6.jpg| '''Step 6:''' Choose to copy media sources from the default user or start fresh.
</gallery>

=== Specific profile settings ===

; Profile Name
: The name of the profile you entered above

; Profile picture
: Browse to some icon you would like to select as a profile picture

; Profile directory
: The path to the profile directory you might have created above

; Lock prefences
: Allows you to lock many of your preferences. This is detailed below.

; Media Info
:Allows you to have separate information saved for your media, i.e. IMdB, AllMusic, etc. The options are
::* '''Separate''' - Profiles have separate media info with full control
::* '''Shares with Default''' - Shares media info with the default user with full control
::* '''Shares with Default (Read Only)''' - Shares media info with the default user, and is locked by the master code
::* '''Separate (Locked)''' - Profile has separate media info, but you can only change it by enabling master mode.

; Media sources
:Allows you to have separate media sources for the profiles. The options are
::* '''Separate''' - Profiles have separate media sources with full control
::* '''Shares with Default''' - Shares media sources with the default user with full control
::* '''Shares with Default (Read Only)''' - Shares media sources with the default user, and is locked by the master code
::* '''Separate (Locked)''' - Profiles have separate media sources, but you can only change them by enabling master mode.
{{-}}
<br>

== Deleting a profile ==

In order to delete an unused profile, simply navigate to {{button|Settings}}->{{button|Profile Settings}}->{{button|Profiles}}, then navigate to the profile you want to delete and bring up the context menu using either {{button|guide}} on a remote or {{button|c}} on a normal keyboard. Then select {{button|Delete}} like shown in the screenshot below:
<br>

[[File:Profles-delete_profile-v17.jpg|500px]]<br />

{{-}}

== Switching profiles ==

Switching profiles from a currently running Kodi instance can be done in different ways:

You are able to switch a profile while navigating to the profiles-section, selecting the specific profile you want to use, bring up the context menu using either {{button|guide}} on a remote or {{button|c}} on a normal keyboard and select {{button|Load}} like shown in the screenshot below:<br />
<br />

[[File:Profiles-load_profile-v17.jpg|500px]]<br />
<br />

The other way is to log-off from the current Kodi session and log-in to another profile:<br />
<br />
<gallery mode="packed" widths=500px heights=283px>
File:Profiles-switch_profile-v17.jpg| '''Step 1:''' Log off from the current profile
File:Profiles-switch_profile2-v17.jpg| ''' Step 2:''' Log in to another profile
</gallery>

Another way of switching profiles is to bind ''load profile'' to a key in [[Keymaps|keymaps.xml]] by using the [[List_of_built-in_functions|built-in function]] LoadProfile. If you only have two profiles you can use the same key to switch back and forth. e.g. LoadProfile bound to {{keypress|y}}<br />

Switch from User1 to User2 (Users1's keymap.xml): <y>LoadProfile(User2)<y/><br />
Switch from User2 to User1 (Users2's keymap.xml): <y>LoadProfile(User1)<y/><br />

Keymap.xml example:
<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<y>LoadProfile(User2)</y>
</keyboard>
</global>
</keymap>
</syntaxhighlight>
{{-}}

== profiles.xml and profiles folder ==

It is important to mention that this section exists so that users have some documentation to refer to in the event of profile related issues occur like profile corruption. This '''does not''' constitute a invitation to novice users to start messing around with said files/folders and cause inadvertent problems that would not otherwise exist.

{{notice|'''Do not edit the any of the xml files''' in question unless '''indicated by a Kodi developer''' or for '''backup''' purposes only|WARNING}}

=== profiles.xml ===

A ''profile.xml'' file exists after the very first installation of Kodi at its userdata-folder and unless you have created additional profiles it won't have any other information as for the '''Master user''' (Kodis default user). If you create other/additional profiles, that file will be populated with additional informations about the created profile.

The example below shows a profile.xml file containing the '''Master user''' and the user '''Test''' as an additional profile. In that case it will show that the '''Master user''' uses a lockcode which '''Test''' doesn't use. As you can see the given password is shown in plain text. So please be aware that a locked profile doesn't provide any kind of security if other users have access to the underlying file system.

For the lock preferences and the Master lock, please visit: [[Settings/Interface/Master_lock|Settings -> Interface settings -> Master lock]]

{| class="mw-collapsible mw-collapsed wikitable"
|-
! Example profiles.xml file
|-
|
<syntaxhighlight lang=xml enclose="div">
<profiles>
<lastloaded>0</lastloaded>
<useloginscreen>false</useloginscreen>
<nextIdProfile>2</nextIdProfile>
<profile>
<id>0</id>
<name>Master user</name>
<directory pathversion="1">special://masterprofile/</directory>
<thumbnail pathversion="1" />
<hasdatabases>true</hasdatabases>
<canwritedatabases>true</canwritedatabases>
<hassources>true</hassources>
<canwritesources>true</canwritesources>
<lockaddonmanager>false</lockaddonmanager>
<locksettings>false</locksettings>
<lockfiles>false</lockfiles>
<lockmusic>false</lockmusic>
<lockvideo>false</lockvideo>
<lockpictures>false</lockpictures>
<lockprograms>false</lockprograms>
<lockmode>1</lockmode>
<lockcode>c4ca4238a0b923820dcc509a6f75849b</lockcode>
<lastdate />
</profile>
<profile>
<id>1</id>
<name>TEST</name>
<directory pathversion="1">profiles/Test/</directory>
<thumbnail pathversion="1" />
<hasdatabases>true</hasdatabases>
<canwritedatabases>true</canwritedatabases>
<hassources>true</hassources>
<canwritesources>true</canwritesources>
<lockaddonmanager>false</lockaddonmanager>
<locksettings>false</locksettings>
<lockfiles>false</lockfiles>
<lockmusic>false</lockmusic>
<lockvideo>false</lockvideo>
<lockpictures>false</lockpictures>
<lockprograms>false</lockprograms>
<lockmode>0</lockmode>
<lockcode>-</lockcode>
<lastdate />
</profile>
</profiles>
</syntaxhighlight>
|}

=== Profiles folder contents ===

Any additional user(s) will have their own folder under '''userdata -> profiles -> <profile-name>''' which contains all informations about add-on data, databases, keymaps, thumbnails and such seperately from the ''Master user''. If you have selected "Copy default" at the steps above, the settings or media sources will be copied from the default Kodi user.

By default (no sources set neither on the master user nor on an additional profile) an additional profile folder contains similar folders as the userdata folder. For an explanation about the files and folders which are located under the <profile_name>-folder, please see: [[Userdata#UserData_folder_contents|Userdata folder contents]]

== Troubleshooting ==
<br />
'''Q: I installed skins and add-ons on the 'Master User' but I can't install it on the additional profile. Why?'''

A: Already installed skins or add-ons are marked as "disabled" under: {{button|Add-ons -> My add-ons -> <specific add-on section>}} and don't need to be installed again. After you enabled a specific add-on or a skin, those add-ons are available again and skins could be used from the {{button|Settings -> Interface settins -> Skin}} menu.

'''Q: After I created a profile, the Kodi screen stays black if I try to load it for the first time. Why?'''

A: That was a bug and it's already fixed in Kodi 18 alpha versions. After you have restarted Kodi Krypton, Kodi should behave normal and should display the GUI as expected.

=== Missing texts/different skins not loading while using profiles ===

That's a known issue and there's a workaround for that:

- create a [[Autoexec.py|autoexec.py]] file at your [[Userdata|userdata]] folder and under each {{button|<profile-name>}}-folder under {{button|userdata -> profiles -> <profile-name>}} (the path to that folder differs from the OS in use)<br />
- fill each autoexec.py with the following content:

<syntaxhighlight lang=python>
import xbmc
xbmc.executebuiltin('ReloadSkin()')
</syntaxhighlight>

That will cause a skin reload at every profile switch. Depending on your hardware in use you mostly won't notice it and the texts will be visible again and/or different skins for different profiles will load fine. For some hardware, like the RPi, it will be noticeable and also might take a little while.

== See also ==
* [[Settings/Interface/Master_lock]]
* [[Media sources#Locking]]

{{Krypton updated}}

[[Category:Manual]]
[[Category:Settings]]
[[Category:General topics]]

List of Built In Controls

2019-06-03T13:39:11Z

Davu:

<section begin="main content" />
== .xml files ==

=== AddonBrowser.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Enable auto-updating of the installed add-on's
|-
|6 ||radiobutton ||Enable add-on notifications
|-
|7 ||radiobutton ||Enable language filter
|-
|8 ||radiobutton ||Hide broken addons
|-
|9 ||button ||Check for repo updates
|}

=== DialogAddonInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Install the selected add-on
|-
|7 ||button ||Disable the selected add-on
|-
|8 ||button ||Update the selected add-on
|-
|9 ||button ||Show the settings of the selected add-on
|-
|10 ||button ||Show the dependencies of the selected add-on
|-
|12 ||button ||Run the selected add-on
|-
|13 ||radiobutton ||Auto-update
|-
|50 ||container ||List of available screenshots
|}

=== DialogAddonSettings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|3 ||grouplist ||Grouplist template
|-
|5 ||grouplist ||Grouplist template
|-
|7 ||button ||Button template
|-
|8 ||radiobutton ||Radiobutton template
|-
|9 ||spincontrolex ||Spincontrolex template
|-
|10 ||button ||Button template
|-
|11 ||image ||Default separator image
|-
|12 ||edit ||Edit template
|-
|13 ||sliderex ||Slider template
|-
|14 ||label ||Label template
|-
|28 ||button ||OK button
|-
|29 ||button ||Cancel button
|-
|30 ||button ||<unused button>
|}

=== DialogAudioDSPManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|20 ||container ||List with available options
|-
|21 ||container ||List with active options
|-
|22 ||radiobutton ||Continuous save button
|-
|23 ||button ||Apply button
|-
|24 ||button ||Clear button
|-
|9000 ||container ||List with available modes
|}

=== DialogBusy.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||progress ||Progress bar
|}

=== DialogButtonMenu.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3100 ||label ||Label of the focused button
|}

=== DialogConfirm.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|9 ||textbox ||Message
|-
|10 ||button ||No button
|-
|11 ||button ||Yes button
|-
|12 ||button ||(for future use)
|-
|20 ||progress ||Progress bar
|}

=== DialogContextMenu.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|999 ||image ||Background image of the context menu (center part) (deprecated)
|-
|998 ||image ||Background image of the context menu (bottom part) (deprecated)
|-
|997 ||image ||Background image of the context menu (top part) (deprecated)
|-
|996 ||grouplist || Grouplist template
|-
|999 ||image ||Background image of the context menu
|-
|1000 ||button ||Button template
|}

=== DialogExtendedProgressBar.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|30 ||label ||Heading label
|-
|31 ||label ||Line 1
|-
|32 ||progress ||Scan progress bar
|}

=== DialogGameControllers.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3 ||grouplist ||List of controller types
|-
|5 ||grouplist ||List of feature types
|-
|7 ||button ||Button template
|-
|8 ||label ||Settings category label template
|-
|9 ||image ||Settings separator image template
|-
|10 ||button ||Button template
|-
|17 ||button ||Help button
|-
|18 ||button ||OK button
|-
|19 ||button ||Reset button
|-
|20 ||button ||Get more... button
|-
|21 ||button ||Ignore input button
|-
|22 ||button ||Get all button
|-
|31 ||gamecontroller ||Gamecontroller image template
|-
|32 ||textbox ||Controller description
|}

=== DialogFavourites.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|450 ||container ||List of available favourites
|}

=== DialogKeyboard.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|8 ||button ||Backspace button
|-
|100 – 111 ||button ||Digits 0 – 9
|-
|120 – 171 ||button ||Characters A – Z
|-
|300 ||button ||Done Button
|-
|301 ||button ||Cancel button
|-
|302 ||radiobutton ||Shift button
|-
|303 ||radiobutton ||Caps-Lock button
|-
|304 ||radiobutton ||Switch to symbols
|-
|305 ||button ||Navigate left button
|-
|306 ||button ||Navigate right button
|-
|307 ||button ||Enter IP address button
|-
|309 ||button ||Layout button
|-
|311 ||label ||Heading label
|-
|312 ||edit ||Label displaying the text being entered
|-
|313 ||label ||Label displaying the text being entered (when keyboard layout is Chinese)
|-
|314 ||label ||Label displaying the available choices (when keyboard layout is Chinese)
|}

=== DialogMediaSource.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|10 ||container ||List of added media sources
|-
|11 ||button ||Browse for location button
|-
|12 ||edit ||Button for entering the name for the selected source
|-
|13 ||button ||Add new source button
|-
|14 ||button ||Delete source button
|-
|18 ||button ||OK button
|-
|19 ||button ||Cancel button (unused)
|}

=== DialogMusicInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Refresh artist information / Refresh album information
|-
|7 ||button ||User rating
|-
|10 ||button ||Get artist thumbnail / Get album thumbnail
|-
|11 ||button ||Connect to the Last.fm radio channel for this artist
|-
|12 ||button ||Get artist fanart image
|-
|13 ||button ||Get song thumbnail
|-
|50 ||container || Discography of the selected artist / tracks on the selected album / contributors on the selected song
|}

=== DialogNotification.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|400 ||image ||Default Icon
|-
|401 ||label ||Heading text
|-
|402 ||label ||Message text
|}

=== DialogNumeric.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|4 ||label ||Label displaying the digits being entered
|-
|10 – 19 ||button ||Digits 0 – 9
|-
|20 ||button ||Navigate left button
|-
|21 ||button ||Enter Button
|-
|22 ||button ||Navigate right button
|-
|23 ||button ||Backspace button
|}

=== DialogPictureInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|5 ||container ||List of the available exif information of the image currently being displayed
|}

=== DialogPVRChannelManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||button ||OK button
|-
|5 ||button ||Apply button
|-
|6 ||button ||Cancel button
|-
|7 ||radiobutton ||Activate channel button
|-
|6 ||button ||Cancel button
|-
|8 ||edit ||Channel name
|-
|9 ||button ||Channel logo
|-
|11 ||spincontrolex ||Select group
|-
|12 ||radiobutton ||Activate EPG
|-
|13 ||spincontrolex ||Select EPG source button
|-
|30 ||button ||Switch to group management
|-
|31 ||button ||New channel
|-
|34 ||button ||Toggle radio / tv channels
|-
|20 ||container ||Channel list
|}

=== DialogPVRChannelsOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Channels list
|}

=== DialogPVRGroupManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Ungrouped channels
|-
|12 ||container ||Grouped channels
|-
|13 ||container ||Group list
|-
|25 ||radiobutton ||Hide / Unhide button
|-
|26 ||button ||Add button
|-
|27 ||button ||Rename button
|-
|28 ||button ||Delete button
|-
|29 ||button ||OK button
|-
|34 ||togglebutton ||Switch between TV / Radio
|}

=== DialogPVRChannelGuide.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Guide list
|}

=== DialogPVRGuideSearch.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|9 ||edit ||Search string
|-
|10 ||radiobutton ||Include description
|-
|11 ||radiobutton ||Case sensitive
|-
|12 ||spincontrolex ||Minimal duration
|-
|13 ||spincontrolex ||Maximal duration
|-
|14 ||edit ||Start date
|-
|15 ||edit ||End date
|-
|16 ||edit ||Start time
|-
|17 ||edit ||End Time
|-
|18 ||spincontrolex ||Genre
|-
|19 ||radiobutton ||Avoid repeats
|-
|20 ||radiobutton ||Unknown genres
|-
|21 ||spincontrolex ||Groups
|-
|22 ||radiobutton ||FTA
|-
|23 ||spincontrolex ||Channels
|-
|24 ||radiobutton ||Ignore timers
|-
|25 ||button ||Cancel button
|-
|26 ||button ||Search button
|-
|27 ||radiobutton ||Ignore recordings
|-
|28 ||button ||Defaults button
|}

=== DialogPVRInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||button ||Similar button
|-
|5 ||button ||Switch to channel button
|-
|6 ||button ||Record button
|-
|7 ||button ||OK button
|-
|8 ||button ||Play button
|-
|9 ||button ||Add timer button
|}

=== DialogSeekBar.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|401 ||slider ||Marker representing the current seek position
|-
|402 ||label ||Time label displaying current seek position
|}

=== DialogSelect.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|2 ||label ||Number of items in the list
|-
|3 ||container ||List of available options
|-
|5 ||button ||Manual/Get More... button
|-
|6 ||container ||List of available add-ons
|-
|7 ||button ||Cancel button
|-
|11 ||container ||List with game video thumbnails
|-
|12 ||textbox ||Description of the currently-selected video filter
|}

=== DialogSettings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Header label
|-
|5 ||grouplist ||Grouplist template
|-
|7 ||button ||button template
|-
|8 ||radiobutton ||radiobutton template
|-
|9 ||spincontrolex ||spincontrolex template
|-
|11 ||image ||image template
|-
|12 ||edit ||edit template
|-
|13 ||sliderex ||sliderex template
|-
|14 ||label ||label template
|-
|28 ||button ||ok button
|-
|29 ||button ||cancel button
|-
|30 ||button ||clear/settings button
|}

=== DialogSlider.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||label ||Heading label
|-
|11 ||slider ||Slider
|-
|12 ||label ||Label representing the slider value
|}

=== DialogSubtitles.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|100 ||label ||Name of subtitle service
|-
|110 ||image ||Logo of subtitle service
|-
|120 ||container ||List of available subtitles
|-
|130 ||label ||Local subtitle available
|-
|140 ||label ||Number of available subtitles
|-
|150 ||container ||List of available subtitle services
|-
|160 ||button ||Manual search buttom
|}

=== DialogTextViewer.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|5 ||textbox ||Text area for add-on output
|}

=== DialogVideoInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3 ||image ||Video thumb
|-
|4 ||textbox ||Text area for displaying the video plot
|-
|5 ||button ||Toggle between video review and cast members (Deprecated)
|-
|6 ||button ||Refresh video information
|-
|7 ||button ||User rating
|-
|8 ||button ||Play video
|-
|9 ||button ||Resume video
|-
|10 ||button ||Get video Fanart, Poster, Banner, or Thumb
|-
|11 ||button ||Play movie trailer
|-
|13 ||button ||Show all movies by the director of the selected movie
|-
|50 ||container ||List of cast members of the currently selected movie
|}

=== EventLog.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|20 ||button ||Clear button
|-
|21 ||button ||Level button
|-
|22 ||radiobutton ||Only show current level radiobutton
|-
|570 ||container ||Container with event loglines
|}

=== FileBrowser.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|450 ||container ||Directory list
|-
|451 ||container ||List of available thumbnails
|-
|411 ||label ||Heading label
|-
|412 ||label ||Path of the selected item
|-
|413 ||button ||OK button
|-
|414 ||button ||Cancel button
|-
|415 ||button ||Create folder
|-
|416 ||radiobutton ||Flip Image horizontally
|}

=== FileManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|12 ||label ||Number of items in directory list 1
|-
|13 ||label ||Number of items in directory list 2
|-
|20 ||container ||Directory list 1
|-
|21 ||container ||Directory list 2
|-
|101 ||label ||Path of the currently selected directory in list 1
|-
|102 ||label ||Path of the currently selected directory in list 2
|}

=== GameOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1101 ||label ||Help text
|-
|1102 ||gamecontroller ||Controller layout
|}

=== LoginScreen.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|3 ||label ||Number of the currently selected profile
|-
|52 ||container ||List of the available profiles
|}

=== MusicOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|500 ||button ||Select visualization
|-
|501 ||button ||Lock visualization to the current preset
|}

=== MusicVisualisation.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||visualisation ||Background Visualization
|}

=== MyMusicNav.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Switch to file mode
|-
|8 ||edit ||Search for a string anywhere in the Kodi music database
|-
|12 ||label ||Number of items in the list
|-
|15 ||label ||Filter label
|-
|16 ||radiobutton ||Start party mode (randomly play songs from your entire music collection)
|-
|17 ||button ||Manually enter artist and album name to lookup the artist and album information on the internet
|-
|18 ||label ||Warning to the user to turn off library mode when no scanned media is found
|-
|19 ||radiobutton / edit||Filter the media files to only show items that include the specified string in the name
|-
|20 ||button ||Update library
|}

=== MyMusicPlaylistEditor.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Load the playlist
|-
|7 ||button ||Save the playlist
|-
|8 ||button ||Clear the playlist
|-
|12 ||label ||Number of items in the current directory or library list
|-
|XX ||container ||List allowing you to browse your directories and music library
|-
|100 ||container ||List of songs in the playlist
|-
|101 ||label ||Number of items in the playlist
|}

=== MyPics.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|6 ||button ||Start a picture slideshow
|-
|7 ||button ||Start a recursive picture slideshow
|-
|9 ||radiobutton ||Randomize the picture slideshow
|-
|12 ||label ||Number of items in the list
|}

=== MyPlaylist.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|12 ||label ||Number of items in the playlist
|-
|20 ||radiobutton ||Shuffle the playlist
|-
|21 ||button ||Save the playlist
|-
|22 ||button ||Clear the playlist
|-
|23 ||button ||Play the playlist
|-
|24 ||button ||Play the next item in the playlist
|-
|25 ||button ||Play the previous item in the playlist
|-
|26 ||button ||Put the playlist on repeat
|}

=== MyPrograms.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|12 ||label ||Number of items in the list
|}

=== MyPVRChannels.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|6 ||radiobutton ||Show hidden channels
|-
|28 ||button ||Channel groups button
|-
|29 ||label ||Channel groups name
|-
|31 ||radiobutton ||Filter
|}

=== MyPVRGuide.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|10 ||epggrid ||EPG Guide Timeline
|-
|11 ||container ||Channel groups selector
|-
|28 ||button ||Channel groups button
|-
|29 ||label ||View name (Now / Next / Timeline)
|-
|30 ||label ||Channel groups name
|}

=== MyPVRRecordings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Group items by folder structure
|-
|7 ||radiobutton ||Show deleted recordings
|-
|10 ||button ||Show only watched, unwatched or all recordings
|-
|28 ||button ||Channelgroups button
|-
|29 ||label ||'Deleted' (When show deleted recordings is enabled, otherwise empty)
|}

=== MyPVRSearch.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|28 ||button ||Channel groups button
|}

=== MyPVRTimers.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|8 ||radiobutton ||Hide disabled timers
|-
|28 ||button ||Channel groups button
|}

=== MyVideoNav.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||button ||Switch to file mode
|-
|6 ||button ||Play DVD (used the play physical DVD discs)
|-
|8 ||button ||Search for a string anywhere in the Kodi video database
|-
|10 ||button ||Show only watched, unwatched or all videos
|-
|12 ||label ||Number of items in the list
|-
|14 ||button ||Show only unwatched or all videos
|-
|11 ||button ||Unlock shares
|-
|15 ||label ||Filter label
|-
|16 ||button ||Start party mode (randomly play musicvideos from your collection)
|-
|18 ||label ||Warning to the user to turn off library mode when no scanned media is found
|-
|19 ||radiobutton / edit ||Filter the media files to only show items that include the specified string in the name
|-
|20 ||button ||Update library
|}

=== MyWeather.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Refresh the weather information
|-
|3 ||spincontrolex ||Change weather location
|-
|11 ||label ||Shows the time of last weather update
|-
|31 ||label ||Current day label
|-
|32 ||label ||Today's high temperature value
|-
|33 ||label ||Today's low temperature value
|-
|34 ||label ||Today's weather condition
|-
|35 ||image ||Today's weather icon
|-
|223 ||label ||Localized “Temperature” string
|-
|224 ||label ||Localized “Feels like” string
|-
|225 ||label ||Localized “UV index” string
|-
|226 ||label ||Localized “Wind” string
|-
|227 ||label ||Localized “Dew point” string
|-
|228 ||label ||Localized “Humidity” string
|}

=== Pointer.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||image ||Pointer no focus image
|-
|2 ||image ||Pointer focus image
|-
|3 ||image ||Pointer drag image
|-
|4 ||image ||Pointer click image
|}

=== SettingsCategory.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Label displaying the current settings category
|-
|3 ||grouplist ||Grouplist template for the menu
|-
|5 ||grouplist ||Grouplist template for the settings section
|-
|6 ||textbox ||Settings description
|-
|7 ||button ||Button template
|-
|8 ||radiobutton ||Radiobutton template
|-
|9 ||spincontrolex ||Spincontrolex template
|-
|10 ||button ||Button template for the menu
|-
|11 ||image ||Default separator image
|-
|12 ||edit ||Edit control template
|-
|13 ||sliderex ||Sliderex control template
|-
|14 ||label ||label template
|-
|20 ||button ||Setting level button
|}

=== SettingsProfile.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||container ||List of available profiles
|-
|4 ||button ||Enable the loginscreen
|-
|5 ||button ||Auto login
|}

=== SettingsScreenCalibration.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Coordinates label
|-
|3 ||label ||Help information
|-
|8 ||mover ||Top left mover
|-
|9 ||mover ||Right bottom mover
|-
|10 ||mover ||Subtitle position mover
|-
|11 ||resize ||Pixel aspect ratio box
|-
|20 ||videowindow ||currently playing video
|}

=== SlideShow.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||label ||Error loading image message
|-
|13 ||[any] ||These controls are visible when the slideshow is paused
|}

=== SettingsSystemInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 – 11 ||label ||Line 2 – Line 11
|-
|30 ||textbox ||privacy-policy text
|-
|40 ||label ||System information category label
|-
|52 ||label ||Kodi build label
|-
|53 ||label || Kodi build date label
|-
|94 ||button ||Show storage information
|-
|95 ||button ||Show summary information
|-
|96 ||button ||Show network information
|-
|97 ||button ||Show video information
|-
|98 ||button ||Show hardware information
|-
|99 ||button ||Show PVR information
|-
|99 ||button ||Show privacy-policy
|}

=== SmartPlaylistEditor.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|10 ||container ||List of playlist rules
|-
|12 ||button ||Name of the playlist
|-
|13 ||button ||Add a rule
|-
|14 ||button ||Remove a rule
|-
|15 ||button ||Edit a rule
|-
|16 ||button ||Match rules option (match all rules / match one or more rules)
|-
|17 ||button ||Limit rules option (number of results: 10, 25, 50, 100, etc... items)
|-
|18 ||button ||Sort rules option (order the results by: title, genre, random, etc...)
|-
|19 ||button ||Sort direction option (ascending / descending)
|-
|20 ||button ||OK button
|-
|21 ||button ||Cancel button
|-
|22 ||button ||Set Playlist type (movies, episodes, mixed, etc...)
|-
|23 ||button ||Group by
|-
|24 ||radiobutton ||Mixed
|}

=== SmartPlaylistRule.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|15 ||button ||Select field (director, duration, video resolution, etc...)
|-
|16 ||button ||Select operator (is, is not, less than, etc...)
|-
|17 ||edit ||Enter a value the rule should match
|-
|18 ||button ||OK button
|-
|19 ||button ||Cancel button
|-
|20 ||button ||Browse button
|}

=== VideoFullScreen.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Numpad seek label
|-
|10 ||label ||Line 1
|-
|11 ||label ||Line 2
|-
|12 ||label ||Line 3
|}

=== VideoOSDBookmarks.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Add a video bookmark
|-
|3 ||button ||Clear all bookmarks
|-
|4 ||button ||Use the currently selected video bookmark as the episode thumbnail
|-
|11 ||container ||List of available bookmarks
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

InfoLabels

2019-05-21T04:15:54Z

Davu:

{{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]

=== 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).NumAllItems
| Number of all items in the container or grouplist with given id including parent folder item.
| v18
|-
| Container(id).NumNonFolderItems
| Number of items in the container or grouplist with given id excluding all folder items.
| v18
|-
| 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 absolute 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 the 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 at position 'id' in a Container. the id is an offset to the first *visible* item of the container. ''( 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.
|
|}

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== 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.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| 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.Property(Album_Rating)
| Shows the scraped rating of the currently selected Album
|
|-
| ListItem.Property(Album_UserRating)
| Shows the user rating 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.FileNameNoExtension
| Returns the filename without its extension.
| v19
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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, for use in dialogvideoinfo.xml.
|
|-
| 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[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| 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.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, 8K [Note: v18 addition]). 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.
| v18
|-
| 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.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (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
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|}

=== 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.Volume
| Returns the volume level in dB
|
|-
| 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.Property(Artist_Sortname)
| Sortname of the currently playing Artist
| v18
|-
| MusicPlayer.Property(Artist_Type)
| Type of the currently playing Artist - person, group, orchestra, choir etc.
| v18
|-
| MusicPlayer.Property(Artist_Gender)
| Gender of the currently playing Artist - male, female, other
| v18
|-
| MusicPlayer.Property(Artist_Disambiguation)
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| 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.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.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 'On' or 'Off'
|
|-
| 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.EpgEventDuration[(format)]
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventElapsedTime[(format)]
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| PVR.EpgEventRemainingTime[(format)]
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventFinishTime[(format)]
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventSeekTime[(format)]
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| PVR.EpgEventProgress
| Returns the position of currently played title on TV as integer
|
|-
| PVR.TimeShiftStart[(format)]
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftEnd[(format)]
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| PVR.TimeShiftCur[(format)]
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| PVR.TimeShiftOffset[(format)]
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| 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}}
|-
| PVR.ChannelNumberInput
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| PVR.TimeshiftProgressDuration
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressDuration(format)
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressStartTime
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressStartTime(format)
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressEndTime
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| PVR.TimeshiftProgressEndTime(format)
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| PVR.TimeshiftProgressPlayPos
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgStart
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressEpgEnd
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferStart
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| PVR.TimeshiftProgressBufferEnd
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|}

=== 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 <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| 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 <span class="nobr">DVD-ROM</span> 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.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 ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Fanart.Image
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| 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 default icon.
|
|-
| ListItem.ActualIcon
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| 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.EPGEventIcon
| Returns the icon of the EPG programme (if available).
| v18
|-
| ListItem.Property(Fanart_Image)
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| MusicPlayer.Cover
| Cover of currently playing album
|
|-
| MusicPlayer.Property(Fanart_Image)
| Fanart image of the currently playing artist
|
|-
| Player.Icon
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| 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.
|
|-
| Pvr.EPGEventIcon
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| 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 <span class="nobr">user-customisable</span> 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. Note: Deprecated, use ListItem.Art(poster) instead.
|
|-
| Weather.ConditionsIcon
| 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]]

Action IDs

2019-04-05T11:07:19Z

Davu:

<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>Next</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>Previous</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)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <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 (On Screen Display) 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>PlayNext</code> || Queue the item to the next position in 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
|-
| <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>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <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)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <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).
|-
| <code>SetRatring</code> || For use in the MusicOSD.xml window. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton 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]]

{{Isengard updated}}

[[Category:Remotes]]
[[Category:Skin development]]

User:Davu/Flatpak

2019-02-22T05:39:58Z

Davu:

{{bigger|Flatpak}}

<section begin="Intro-flatpak" />
Flatpak is a tool for software development, package management and software actualisation for desktop applications on Linux based systems. Therefore it provides a sandboxed environment at which users or developers execute applications completely isolated from the rest of the system.

Kodi is also available as a Flatpak package. This Wiki will explain how to install Flatpak and how to install the Kodi Flatpak package.
<section end="Intro-flatpak />

=Installing Kodi via Flatpak=

Some Linux distributions have Flatpak available by defaul, for others you have to install specific packages fist. Please look at sections below what is necessary for the Linux distro you are using.

==Ubuntu==

===Installing Flatpak and add the Flathub repo===

For Ubuntu versions higher than 16.10, Flatpak is provided by the Ubuntu repositories and is installed via:
sudo apt install flatpak

In case you want the newest Flatpak version or are using Ubuntu 16.04 (or earlier) users have to use an additional repository to be able to install Flatpak. The commands below will show how to do that.

sudo apt-add-repository ppa:alexlarsson/flatpak
sudo apt update
sudo apt install flatpak

The first command installs the repository, the 2nd command updates all existing repositories, the 3rd command installs the Flatpak package.

Kodi itself is available at "Flathub" which is a repostory for Flatpaks. To use that, you need to install the repository via:

flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

You will be asked for your password. Please enter it to make the repository available.

In case you want to use the Ubuntu Software Center to install Flatpak, you need to install one additional package:

sudo apt install gnome-software-plugin-flatpak

After that you are able to use the Software Center instead of using the command line.

===Installing the Kodi Flatpak package===

There are two ways to install the Kodi Flatpack package. You can either use the Ubuntu Software Center or the command line. Both ways are explained below.

====Via the Ubuntu Software Center====

If you have installed the specific gnome software center plugin (see instructions above), simply open the Ubuntu Software Center, search for "Kodi" and install the package. That's it. The galery below will show some screenshots.

<add screenshots>

====Via the command line====

From the command line, you need to execute the following command to install the Kodi Flatpak package:

sudo flatpak install flathub tv.kodi.Kodi

You will be asked for a required runtime and if additional packages are ok to be installed. Answer both questions with "y".

===Kodi Userdata folder and other data===

The location of the well known userdata folder and all other data is located under:

~/.var/app/tv.kodi.Kodi/data

'''Logfile location: ''' ~/.var/app/tv.kodi.Kodi/data/temp/kodi.log <br />
'''Userdata folder: ''' ~/var/app/tv.kodi.Kodi/data/userdata

==Fedora==

Fedora has Flatpak installed by default.

==Arch Linux==

Profiles

2019-02-21T18:50:54Z

Davu:

__TOC__
{{-}}
<section begin=intro />Profiles allow users to save all of settings as a profile and change them at the touch of a button. It also allows you to grant access to specific folders and network shares based on the profile being used. This is ideal for systems that have multiple users. It works much the same as setting up individual users on your home computer.<section end=intro />

These individual profiles allow you to customize the environment for multiple users, allowing for such functionality as:
* Customized view settings such as skins for each user
* The ability to lock folders, such as network shares on a per-user basis
* Separate media [[Databases|libraries]] for each user
* Unique RSS feeds for each user
* Unique [[Keymap|keymapping]] for each user
* Unique network settings
All options stored in the [[userdata folder]] can be customized per profile, allowing for an amazing amount of flexibility.

{{-}}

== Adding a profile ==

In order to add a profile, follow the steps below

<gallery mode="packed" widths=500px heights=283px>
File:Estuary_Profiles_Adding_Profile_1.jpg| '''Step 1:''' Select "Add profile"
File:Estuary_Profiles_Adding_Profile_2.jpg| '''Step 2:''' Enter a name for the profile
File:Estuary_Profiles_Adding_Profile_3.jpg| '''Step 3:''' Select a directory for your profile at which your personalized settings will be stored.<br />'''OK''' will choose the 'default' folder which will be stored under the [[Userdata|userdata]]-folder and will have the same name as the profile name. <br />'''New folder''' will give you the option to specify a self-created folder for your profile which you need to select after a name for it was given. The folder for the profile will then be found under: userdata -> profiles -> <created folder name>
File:Estuary_Profiles_Adding_Profile_4.jpg| '''Step 4:''' Select specific profile settions which are explained below
File:Estuary_Profiles_Adding_Profile_5.jpg| '''Step 5:''' Choose to copy settings from the defaul user ot start with default settings
File:Estuary_Profiles_Adding_Profile_6.jpg| '''Step 6:''' Choose to copy media sources from the default user or start fresh.
</gallery>

=== Specific profile settings ===

; Profile Name
: The name of the profile you entered above

; Profile picture
: Browse to some icon you would like to select as a profile picture

; Profile directory
: The path to the profile directory you might have created above

; Lock prefences
: Allows you to lock many of your preferences. This is detailed below.

; Media Info
:Allows you to have separate information saved for your media, i.e. IMdB, AllMusic, etc. The options are
::* '''Separate''' - Profiles have separate media info with full control
::* '''Shares with Default''' - Shares media info with the default user with full control
::* '''Shares with Default (Read Only)''' - Shares media info with the default user, and is locked by the master code
::* '''Separate (Locked)''' - Profile has separate media info, but you can only change it by enabling master mode.

; Media sources
:Allows you to have separate media sources for the profiles. The options are
::* '''Separate''' - Profiles have separate media sources with full control
::* '''Shares with Default''' - Shares media sources with the default user with full control
::* '''Shares with Default (Read Only)''' - Shares media sources with the default user, and is locked by the master code
::* '''Separate (Locked)''' - Profiles have separate media sources, but you can only change them by enabling master mode.
{{-}}
<br>

== Deleting a profile ==

In order to delete an unused profile, simply navigate to {{button|Settings}}->{{button|Profile Settings}}->{{button|Profiles}}, then navigate to the profile you want to delete and bring up the context menu using either {{button|guide}} on a remote or {{button|c}} on a normal keyboard. Then select {{button|Delete}} like shown in the screenshot below:
<br>

[[File:Profles-delete_profile-v17.jpg|500px]]<br />

{{-}}

== Switching profiles ==

Switching profiles from a currently running Kodi instance can be done in different ways:

You are able to switch a profile while navigating to the profiles-section, selecting the specific profile you want to use, bring up the context menu using either {{button|guide}} on a remote or {{button|c}} on a normal keyboard and select {{button|Load}} like shown in the screenshot below:<br />
<br />

[[File:Profiles-load_profile-v17.jpg|500px]]<br />
<br />

The other way is to log-off from the current Kodi session and log-in to another profile:<br />
<br />
<gallery mode="packed" widths=500px heights=283px>
File:Profiles-switch_profile-v17.jpg| '''Step 1:''' Log off from the current profile
File:Profiles-switch_profile2-v17.jpg| ''' Step 2:''' Log in to another profile
</gallery>

Another way of switching profiles is to bind ''load profile'' to a key in [[Keymaps|keymaps.xml]] by using the [[List_of_built-in_functions|built-in function]] LoadProfile. If you only have two profiles you can use the same key to switch back and forth. e.g. LoadProfile bound to {{keypress|y}}<br />

Switch from User1 to User2 (Users1's keymap.xml): <y>LoadProfile(User2)<y/><br />
Switch from User2 to User1 (Users2's keymap.xml): <y>LoadProfile(User1)<y/><br />

Keymap.xml example:
<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<y>LoadProfile(User2)</y>
</keyboard>
</global>
</keymap>
</syntaxhighlight>
{{-}}

== profiles.xml and profiles folder ==

It is important to mention that this section exists so that users have some documentation to refer to in the event of profile related issues occur like profile corruption. This '''does not''' constitute a invitation to novice users to start messing around with said files/folders and cause inadvertent problems that would not otherwise exist.

{{notice|'''Do not edit the any of the xml files''' in question unless '''indicated by a Kodi developer''' or for '''backup''' purposes only|WARNING}}

=== profiles.xml ===

A ''profile.xml'' file exists after the very first installation of Kodi at its userdata-folder and unless you have created additional profiles it won't have any other information as for the '''Master user''' (Kodis default user). If you create other/additional profiles, that file will be populated with additional informations about the created profile.

The example below shows a profile.xml file containing the '''Master user''' and the user '''Test''' as an additional profile. In that case it will show that the '''Master user''' uses a lockcode which '''Test''' doesn't use. As you can see the given password is shown in plain text. So please be aware that a locked profile doesn't provide any kind of security if other users have access to the underlying file system.

For the lock preferences and the Master lock, please visit: [[Settings/Interface/Master_lock|Settings -> Interface settings -> Master lock]]

{| class="mw-collapsible mw-collapsed wikitable"
|-
! Example profiles.xml file
|-
|
<syntaxhighlight lang=xml enclose="div">
<profiles>
<lastloaded>0</lastloaded>
<useloginscreen>false</useloginscreen>
<nextIdProfile>2</nextIdProfile>
<profile>
<id>0</id>
<name>Master user</name>
<directory pathversion="1">special://masterprofile/</directory>
<thumbnail pathversion="1" />
<hasdatabases>true</hasdatabases>
<canwritedatabases>true</canwritedatabases>
<hassources>true</hassources>
<canwritesources>true</canwritesources>
<lockaddonmanager>false</lockaddonmanager>
<locksettings>false</locksettings>
<lockfiles>false</lockfiles>
<lockmusic>false</lockmusic>
<lockvideo>false</lockvideo>
<lockpictures>false</lockpictures>
<lockprograms>false</lockprograms>
<lockmode>1</lockmode>
<lockcode>c4ca4238a0b923820dcc509a6f75849b</lockcode>
<lastdate />
</profile>
<profile>
<id>1</id>
<name>TEST</name>
<directory pathversion="1">profiles/Test/</directory>
<thumbnail pathversion="1" />
<hasdatabases>true</hasdatabases>
<canwritedatabases>true</canwritedatabases>
<hassources>true</hassources>
<canwritesources>true</canwritesources>
<lockaddonmanager>false</lockaddonmanager>
<locksettings>false</locksettings>
<lockfiles>false</lockfiles>
<lockmusic>false</lockmusic>
<lockvideo>false</lockvideo>
<lockpictures>false</lockpictures>
<lockprograms>false</lockprograms>
<lockmode>0</lockmode>
<lockcode>-</lockcode>
<lastdate />
</profile>
</profiles>
</syntaxhighlight>
|}

=== Profiles folder contents ===

Any additional user(s) will have their own folder under '''userdata -> profiles -> <profile-name>''' which contains all informations about add-on data, databases, keymaps, thumbnails and such seperately from the ''Master user''. If you have selected "Copy default" at the steps above, the settings or media sources will be copied from the default Kodi user.

By default (no sources set neither on the master user nor on an additional profile) an additional profile folder contains similar folders as the userdata folder. For an explanation about the files and folders which are located under the <profile_name>-folder, please see: [[Userdata#UserData_folder_contents|Userdata folder contents]]

== Troubleshooting ==
<br />
'''Q: I installed skins and add-ons on the 'Master User' but I can't install it on the additional profile. Why?'''

A: Already installed skins or add-ons are marked as "disabled" under: {{button|Add-ons -> My add-ons -> <specific add-on section>}} and don't need to be installed again. After you enabled a specific add-on or a skin, those add-ons are available again and skins could be used from the {{button|Settings -> Interface settins -> Skin}} menu.

'''Q: After I created a profile, the Kodi screen stays black if I try to load it for the first time. Why?'''

A: That was a bug and it's already fixed in Kodi 18 alpha versions. After you have restarted Kodi Krypton, Kodi should behave normal and should display the GUI as expected.

=== Missing texts/different skins not loading while using profiles ===

That's a known issue and there's a workaround for that:

- create a [[Autoexec.py|autoexec.py]] file at your [[Userdata|userdata]] folder and under each {{button|<profile-name>}}-folder under {{button|userdata -> profiles -> <profile-name>}} (the path to that folder differs from the OS in use)<br />
- fill each autoexec.py with the following content:

<syntaxhighlight lang=python>
import xbmc
xbmc.executebuiltin('ReloadSkin)')
</syntaxhighlight>

That will cause a skin reload at every profile switch. Depending on your hardware in use you mostly won't notice it and the texts will be visible again and/or different skins for different profiles will load fine. For some hardware, like the RPi, it will be noticeable and also might take a little while.

== See also ==
* [[Settings/Interface/Master_lock]]
* [[Media sources#Locking]]

{{Krypton updated}}

[[Category:Manual]]
[[Category:Settings]]
[[Category:General topics]]

User talk:DarkSphere00

2019-02-11T14:04:26Z

Davu: Welcome!

'''Welcome to ''Official Kodi Wiki''!'''
We hope you will contribute much and well.
You will probably want to read the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents help pages].
Again, welcome and have fun! [[User:Davu|Davu]] ([[User talk:Davu|talk]]) 14:04, 11 February 2019 (UTC)

User talk:Muddysteel

2019-02-07T05:36:35Z

Davu: Welcome!

Official:Forum rules/Banned add-ons

2019-02-07T05:32:29Z

Davu: muted "universal scrapers"

{{mininav| [[Forum rules]]}}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of [[Team Kodi]] or the [[XBMC Foundation]].

'''{{big|{{red|This list is only an example. Due to the dynamic nature of Piracy streams and the add-ons that access them, it is impossible to list all Builds/Repositories/Add-ons that violate the [[forum rules#Piracy Policy|forum rules]]}}}}'''

While Team Kodi does not regulate what users install or use, we offer no support when your install includes add-ons that violate the forum rules. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Kodi Forks ==
* QODI
* Streamsmart
* TVMC

== Wizards ==
All Wizards and addon installers

== Builds ==
Any build featuring or offering one or more of the repositories or add-ons listed below
* VPN
* <4k Colors>
* alluneed
* Buildstube
* Buildstuben
* Bucks
* EzzerMac
* FTMC TTM
* FMC
* Grind house
* Kodianer
* One Nation
* Skydarks
* Supremebuilds 
* Xenon

== Repository blacklist ==
* 13Clowns 
* Adryan Lists 
* Aenemapy 
* Aftershock 
* <Agent> 
* <AH> 
* AJ Builds 
* Alfa 
* AllEyezOnMe 
* Androidbboy 
* Ares 
* Atomic 
* Atom Reborn 
* Bamf 
* Beau B 
* BC Repo 
* Blamo 
* BlissTV <!- ID: repository.blisstv -->
* Brettus 
* Bubbles 
* Bookmark Lite 
* Canal Nereo 
* Canvas 
* Catoal 
* Cazlo 
* Cellar Door TV 
* Cerebro 
* Colossus 
* Cosmic Saints 
* Cyphers Locker 
* Dandy Media 
* Deliverance 
* Diablo 
* Diamond 
* Diamondback 
* Dimitrology 
* Duckpool 
* Durex 
* Eggman (Overeasy) 
* Eleazar 
* Elementum 
* Elysium 
* Exodus 
* Exodus Redux 
* <Flawless> 
* Fido 
* FilmKodi 
* FireTVGuru 
* FireStick Plusman 
* Fusion 
* Gaia 
* <Galaxy> 
* GenTec 
* GenieTV 
* Goodfellas 
* GB160 
* Goliath 
* Griffin 
* HalowTV 
* Hellhounds 
* House of el 
* Iceballs 
* Illuminati 
* Incursion 
* Infiniflix 
* J1nx
* Jesus box tv 
* Juggernaut 
* K3l3vra 
* <kb> 
* Kdil
* Kinkin 
* Kirks Build
* Kod1
* Kodi Addons Club
* Koditips 
* Kodibae 
* Kodil 
* Kodi Israel 
* Kodi Rae Repository 
* KodiTips 
* KoDIYhelp 
* Kodi UKTV 
* LastShip 
* Lazarus 
* <Lambda> 
* Lazy Kodi
* Legion 
* Lockdown 
* Loki 
* Looking Glass 
* Magicality 
* Man Cave 
* Maniac 
* MasterZD 
* Maverick 
* Megatron 
* Merlin 
* Metal Kettle 
* Misfit Mod Light
* Mobie
* Movie shark
* MoviesHD 
* MrandMrsSmith 
* MrBlamo
* MrFreeworld 
* Mr Stealth 
* Mucky Ducks 
* MTL FREETV
* Nixgates 
* No-issue
* Noobs and nerds 
* <Notsure> 
* Number 1 Guru 
* Oblivion 
* Oculus 
* Onealliance 
* OneNation 
* Openeleq 
* Origin 
* Orion 
* OroroTV 
* Pandoras Box 
* Phoenix Reborn 
* Pipcan 
* Players Klub 
* Playon Monkey 
* Plexus 
* Premiumize 
* Pulsar 
* <Pulse> 
* PureRepo 
* Quasar 
* raeenterprises 
* Razer 
* Red Hood 
* Renegades 
* Retromania 
* Ring of Saturn 
* Rising Tides 
* Rockcrusher 
* Sanctuary 
* Sandman 
* Sarcasm 
* Sasta TV 
* Scarecrew 
* Sdarot 
* Season Dream 
* Seren
* Simply caz 
* Skydarks 
* SpinzTV 
* Sports Access 
* Smash repo 
* Smash Wizard 
* Smoothstreams 
* Stealth 
* Stefano 
* Steptoes 
* StreamArmy 
* Stream Hub 
* SubZero 
* SuicideTV 
* Super Repo 
* Supremacy 
* Sweetwork 
* T2K 
* Targetin Wizard
* Tantrum TV 
* TDW1980 
* Team DNA 
* The Mania Services 
* Team Nutz
* The Loop 
* The Real Urban Kingz 
* The Unjudged
* The Vibe 
* The wiz
* <Titan> 
* Tk Norris 
* Total Installer 
* TOTALXBMC
* Tsunami OG 
* TVADDONS 
* TV King 
* Twilight0 
* Ufo 
* Underdog 
* UK Turk 
* UK Turks 
* Ukodil 
* Unity
* <Universal Scrapers> 
* uRepo 
* Vader Streams 
* VIP Secret TV 
* <Vista> 
* VS247 
* Where the monsters live
* White Devil 
* WikiXBMC
* Willows 
* Wolfpack 
* Wookie 
* Wrestling on Demand 
* XBMC HUB 
* Xfinity
* <Xstream> 
* Xunity
* XvBMC 
* Whitecream 
* Zero Tolerance 

== Add-on blacklist ==
* 123Movies 
* 13Clowns 
* 1Angels
* 1Channel 
* AceStreams
* Adryanlist 
* Aftershock 
* Alfa 
* AllDebrid
* All Eyez on Me
* All Movies Stream
* Alvin
* Amigos
* Animeram 
* Aragon 
* Area 51
* Ares 
* Arrakis 
* Aspis 
* At The Flix 
* Atomic 
* Atom Reborn 
* BaddAssMovies4U 
* Bandicoot
* Bassfox-official
* BBTS 
* BBTSIP
* Beast
* Bennu 
* Binky TV 
* Blamo 
* Bob Unleashed 
* Brettus
* Bubbles 
* Canvas 
* Caretaker
* CartoonHD
* Cartoons8 
* cCloud 
* Cellar Door
* Cerebro 
* Chappa'ai 
* Cine 
* Cloudword
* Community Portal
* Configurator for Kodi
* Config wizard
* Cosmic Saints
* Covenant 
* Daffys 
* Deccan Delight
* Dexter TV 
* Diabolik 
* Diesel
* Ditto Rain
* Ditto HotRain
* DOCU-HUB 
* Dreamcatcher
* Duck Shit
* Durex 
* Eldorado 
* Elementum 
* Eliplex TV
* Elysium 
* Entertainment Hub
* Exodus 
* ExodusRedux 
* Fan Film
* F_50ci3ty
* F.T.V.
* F4M proxy 
* F4M tester 
* Falcon
* Falcon Project
* Falcon Ultra
* <Fantastic> 
* Film Kodi
* Film Dictator
* Final Gear
* Fine and Dandy 
* Fire TV Guru
* Flixnet
* Free Streams 
* <Fresh start> 
* Gaia
* <Galaxy>
* <Genesis> 
* Genesis Reborn 
* Genie TV
* Goliath
* Good fellas 
* GoMovies
* GoTV
* Gurzil 
* HalowIPTV
* Hard Nox
* Hot rain
* I4a TV
* I Watch Online
* Icarus 
* Ice Films 
* Incursion 
* Indian TV
* Indigo 
* Infiniflix 
* IPTV Stalker
* IPTV Simple Client 2
* Ironman 
* IStream
* IVue TV
* Iwannawatch 
* J1nxPack
* Jango Music
* Jeckyll Hyde
* Jesus Box
* JokerSports
* Jor-El 
* Kartina TV 
* Kidsflix
* Kiss Anime 
* Klugscheisser wizard
* KodiCat Wizard
* Kodiland
* KodiUK TV Wizard
* Kratos 
* Lastship
* Latest Dude
* Legendary 
* Leviathan
* Livehub 
* Live Streams Pro 
* Logan 
* Looking Glass
* Lucky IP TV 
* Magicality 
* Magyck PI
* Marvin
* MashUp
* Maverick 
* MD repo
* Mega Search
* Merlin
* Metallik 
* Metalliq 
* MK Sports
* Mobdina 
* Mobdro 
* Money Sports
* MotorReplays 
* Movie Hub
* Movie Hut
* Movie Night
* Movies Tape
* Movie25
* Movie4k 
* Movies XK
* MovieStorm
* Mp3streams
* MrKnow 
* Mucky Duck
* MuchMovies
* Mutts Nuts
* Navi-X
* Nemesis 
* Neptune Rising 
* Nextgen 
* NLView
* No Limits
* Nole Cinema
* OCW Reborn 
* One Alliance
* One Click Moviez 
* One Nation 
* Online Movies Pro
* Operation Robocop
* Ororo TV 
* Overeasy 
* P2P-Streams 
* Palantir 
* Paradox
* Paragon
* Phoenix
* phstreams 
* Picasso 
* Placenta 
* Players Klub
* Plexus 
* Popcorn Time
* Poseidon
* Prime Links
* Primewire
* Project Cypher
* Project Free TV
* Pro Sport; Pro-Sport; ProSport 
* Pulsar 
* Pyramid 
* Quantum
* Quasar 
* Rapid Bit
* RealDebrid
* Real Movies 
* Rebirth 
* Release Hub
* Renegades TV
* Rising Tides 
* RockCrusher
* RL series
* RobinHood Project
* Resistance 
* Royal We 
* SALTS 
* Sanctuary
* Sasta TV 
* Schism 
* Settv
* Selfless
* Sdarot.tv 
* Showbox 
* Silent Hunter
* Smooth streams 
* Soap Catchup
* Soulless
* Sparkle 
* Specto 
* Spinz TV
* Sports Access 
* Sport-A-Holic
* Sports Devil 
* Sportsmania
* Stallion
* Stream army 
* Stream Cinema 
* Stream hub 
* Stream on Demand
* Stream Storm TV
* Stream This TV
* Subzero 
* Super Streams
* SuperTV
* Supremacy 
* Swa-Desi
* Swiftstreamz 
* Tantrumtv 
* TARDIS 
* TATA.TO-TV
* TATA.TO-VIDEO
* TeeVee 
* TeamZT Kriptix
* Terrarium TV
* The Beast
* The Dog's Bollocks 
* <The Loop> 
* Tiggers
* T-Killa
* Toon Mania 
* TurkVod
* TVOnline 
* UK Turk Playlist 
* UK TV Now 
* Ultimate installer
* Ultimate IPTV
* Universal Scrapers 
* Uranus 
* Vader Streams 
* Vdubt25
* Velocity 
* Video Devil
* Vip secret
* Vortech TV
* Vstream 
* White cream
* White Devil
* Wolfpack
* Wookie Wizard
* Wraith
* Wrestling On Demand
* Xfinity Installer
* XMovies8
* <Xstream>
* Xunity 
* Yify Movies 
* Yoda 
* Zem TV 
* Zeta TV
* Zeus 

==So where do I get support?==
Every Add-on should contain the authors name, this is found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

[[File:add-on-context.JPG|400px]]
[[File:add-on-info.JPG|400px]]

{{top}}

__NOINDEX__
[[Category:Forum]]

Official:Forum rules/Banned add-ons

2019-02-06T08:08:28Z

Davu:

{{mininav| [[Forum rules]]}}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of [[Team Kodi]] or the [[XBMC Foundation]].

'''{{big|{{red|This list is only an example. Due to the dynamic nature of Piracy streams and the add-ons that access them, it is impossible to list all Builds/Repositories/Add-ons that violate the [[forum rules#Piracy Policy|forum rules]]}}}}'''

While Team Kodi does not regulate what users install or use, we offer no support when your install includes add-ons that violate the forum rules. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Kodi Forks ==
* QODI
* Streamsmart
* TVMC

== Wizards ==
All Wizards and addon installers

== Builds ==
Any build featuring or offering one or more of the repositories or add-ons listed below
* VPN
* <4k Colors>
* alluneed
* Buildstube
* Buildstuben
* Bucks
* EzzerMac
* FTMC TTM
* FMC
* Grind house
* Kodianer
* One Nation
* Skydarks
* Supremebuilds 
* Xenon

== Repository blacklist ==
* 13Clowns 
* Adryan Lists 
* Aenemapy 
* Aftershock 
* <Agent> 
* <AH> 
* AJ Builds 
* Alfa 
* AllEyezOnMe 
* Androidbboy 
* Ares 
* Atomic 
* Atom Reborn 
* Bamf 
* Beau B 
* BC Repo 
* Blamo 
* BlissTV <!- ID: repository.blisstv -->
* Brettus 
* Bubbles 
* Bookmark Lite 
* Canal Nereo 
* Canvas 
* Catoal 
* Cazlo 
* Cellar Door TV 
* Cerebro 
* Colossus 
* Cosmic Saints 
* Cyphers Locker 
* Dandy Media 
* Deliverance 
* Diablo 
* Diamond 
* Diamondback 
* Dimitrology 
* Duckpool 
* Durex 
* Eggman (Overeasy) 
* Eleazar 
* Elementum 
* Elysium 
* Exodus 
* Exodus Redux 
* <Flawless> 
* Fido 
* FilmKodi 
* FireTVGuru 
* FireStick Plusman 
* Fusion 
* Gaia 
* <Galaxy> 
* GenTec 
* GenieTV 
* Goodfellas 
* GB160 
* Goliath 
* Griffin 
* HalowTV 
* Hellhounds 
* House of el 
* Iceballs 
* Illuminati 
* Incursion 
* Infiniflix 
* J1nx
* Jesus box tv 
* Juggernaut 
* K3l3vra 
* <kb> 
* Kdil
* Kinkin 
* Kirks Build
* Kod1
* Kodi Addons Club
* Koditips 
* Kodibae 
* Kodil 
* Kodi Israel 
* Kodi Rae Repository 
* KodiTips 
* KoDIYhelp 
* Kodi UKTV 
* LastShip 
* Lazarus 
* <Lambda> 
* Lazy Kodi
* Legion 
* Lockdown 
* Loki 
* Looking Glass 
* Magicality 
* Man Cave 
* Maniac 
* MasterZD 
* Maverick 
* Megatron 
* Merlin 
* Metal Kettle 
* Misfit Mod Light
* Mobie
* Movie shark
* MoviesHD 
* MrandMrsSmith 
* MrBlamo
* MrFreeworld 
* Mr Stealth 
* Mucky Ducks 
* MTL FREETV
* Nixgates 
* No-issue
* Noobs and nerds 
* <Notsure> 
* Number 1 Guru 
* Oblivion 
* Oculus 
* Onealliance 
* OneNation 
* Openeleq 
* Origin 
* Orion 
* OroroTV 
* Pandoras Box 
* Phoenix Reborn 
* Pipcan 
* Players Klub 
* Playon Monkey 
* Plexus 
* Premiumize 
* Pulsar 
* <Pulse> 
* PureRepo 
* Quasar 
* raeenterprises 
* Razer 
* Red Hood 
* Renegades 
* Retromania 
* Ring of Saturn 
* Rising Tides 
* Rockcrusher 
* Sanctuary 
* Sandman 
* Sarcasm 
* Sasta TV 
* Scarecrew 
* Sdarot 
* Season Dream 
* Seren
* Simply caz 
* Skydarks 
* SpinzTV 
* Sports Access 
* Smash repo 
* Smash Wizard 
* Smoothstreams 
* Stealth 
* Stefano 
* Steptoes 
* StreamArmy 
* Stream Hub 
* SubZero 
* SuicideTV 
* Super Repo 
* Supremacy 
* Sweetwork 
* T2K 
* Targetin Wizard
* Tantrum TV 
* TDW1980 
* Team DNA 
* The Mania Services 
* Team Nutz
* The Loop 
* The Real Urban Kingz 
* The Unjudged
* The Vibe 
* The wiz
* <Titan> 
* Tk Norris 
* Total Installer 
* TOTALXBMC
* Tsunami OG 
* TVADDONS 
* TV King 
* Twilight0 
* Ufo 
* Underdog 
* UK Turk 
* UK Turks 
* Ukodil 
* Unity
* Universal Scrapers 
* uRepo 
* Vader Streams 
* VIP Secret TV 
* <Vista> 
* VS247 
* Where the monsters live
* White Devil 
* WikiXBMC
* Willows 
* Wolfpack 
* Wookie 
* Wrestling on Demand 
* XBMC HUB 
* Xfinity
* <Xstream> 
* Xunity
* XvBMC 
* Whitecream 
* Zero Tolerance 

== Add-on blacklist ==
* 123Movies 
* 13Clowns 
* 1Angels
* 1Channel 
* AceStreams
* Adryanlist 
* Aftershock 
* Alfa 
* AllDebrid
* All Eyez on Me
* All Movies Stream
* Alvin
* Amigos
* Animeram 
* Aragon 
* Area 51
* Ares 
* Arrakis 
* Aspis 
* At The Flix 
* Atomic 
* Atom Reborn 
* BaddAssMovies4U 
* Bandicoot
* Bassfox-official
* BBTS 
* BBTSIP
* Beast
* Bennu 
* Binky TV 
* Blamo 
* Bob Unleashed 
* Brettus
* Bubbles 
* Canvas 
* Caretaker
* CartoonHD
* Cartoons8 
* cCloud 
* Cellar Door
* Cerebro 
* Chappa'ai 
* Cine 
* Cloudword
* Community Portal
* Configurator for Kodi
* Config wizard
* Cosmic Saints
* Covenant 
* Daffys 
* Deccan Delight
* Dexter TV 
* Diabolik 
* Diesel
* Ditto Rain
* Ditto HotRain
* DOCU-HUB 
* Dreamcatcher
* Duck Shit
* Durex 
* Eldorado 
* Elementum 
* Eliplex TV
* Elysium 
* Entertainment Hub
* Exodus 
* ExodusRedux 
* Fan Film
* F_50ci3ty
* F.T.V.
* F4M proxy 
* F4M tester 
* Falcon
* Falcon Project
* Falcon Ultra
* <Fantastic> 
* Film Kodi
* Film Dictator
* Final Gear
* Fine and Dandy 
* Fire TV Guru
* Flixnet
* Free Streams 
* <Fresh start> 
* Gaia
* <Galaxy>
* <Genesis> 
* Genesis Reborn 
* Genie TV
* Goliath
* Good fellas 
* GoMovies
* GoTV
* Gurzil 
* HalowIPTV
* Hard Nox
* Hot rain
* I4a TV
* I Watch Online
* Icarus 
* Ice Films 
* Incursion 
* Indian TV
* Indigo 
* Infiniflix 
* IPTV Stalker
* IPTV Simple Client 2
* Ironman 
* IStream
* IVue TV
* Iwannawatch 
* J1nxPack
* Jango Music
* Jeckyll Hyde
* Jesus Box
* JokerSports
* Jor-El 
* Kartina TV 
* Kidsflix
* Kiss Anime 
* Klugscheisser wizard
* KodiCat Wizard
* Kodiland
* KodiUK TV Wizard
* Kratos 
* Lastship
* Latest Dude
* Legendary 
* Leviathan
* Livehub 
* Live Streams Pro 
* Logan 
* Looking Glass
* Lucky IP TV 
* Magicality 
* Magyck PI
* Marvin
* MashUp
* Maverick 
* MD repo
* Mega Search
* Merlin
* Metallik 
* Metalliq 
* MK Sports
* Mobdina 
* Mobdro 
* Money Sports
* MotorReplays 
* Movie Hub
* Movie Hut
* Movie Night
* Movies Tape
* Movie25
* Movie4k 
* Movies XK
* MovieStorm
* Mp3streams
* MrKnow 
* Mucky Duck
* MuchMovies
* Mutts Nuts
* Navi-X
* Nemesis 
* Neptune Rising 
* Nextgen 
* NLView
* No Limits
* Nole Cinema
* OCW Reborn 
* One Alliance
* One Click Moviez 
* One Nation 
* Online Movies Pro
* Operation Robocop
* Ororo TV 
* Overeasy 
* P2P-Streams 
* Palantir 
* Paradox
* Paragon
* Phoenix
* phstreams 
* Picasso 
* Placenta 
* Players Klub
* Plexus 
* Popcorn Time
* Poseidon
* Prime Links
* Primewire
* Project Cypher
* Project Free TV
* Pro Sport; Pro-Sport; ProSport 
* Pulsar 
* Pyramid 
* Quantum
* Quasar 
* Rapid Bit
* RealDebrid
* Real Movies 
* Rebirth 
* Release Hub
* Renegades TV
* Rising Tides 
* RockCrusher
* RL series
* RobinHood Project
* Resistance 
* Royal We 
* SALTS 
* Sanctuary
* Sasta TV 
* Schism 
* Settv
* Selfless
* Sdarot.tv 
* Showbox 
* Silent Hunter
* Smooth streams 
* Soap Catchup
* Soulless
* Sparkle 
* Specto 
* Spinz TV
* Sports Access 
* Sport-A-Holic
* Sports Devil 
* Sportsmania
* Stallion
* Stream army 
* Stream Cinema 
* Stream hub 
* Stream on Demand
* Stream Storm TV
* Stream This TV
* Subzero 
* Super Streams
* SuperTV
* Supremacy 
* Swa-Desi
* Swiftstreamz 
* Tantrumtv 
* TARDIS 
* TATA.TO-TV
* TATA.TO-VIDEO
* TeeVee 
* TeamZT Kriptix
* Terrarium TV
* The Beast
* The Dog's Bollocks 
* <The Loop> 
* Tiggers
* T-Killa
* Toon Mania 
* TurkVod
* TVOnline 
* UK Turk Playlist 
* UK TV Now 
* Ultimate installer
* Ultimate IPTV
* Universal Scrapers 
* Uranus 
* Vader Streams 
* Vdubt25
* Velocity 
* Video Devil
* Vip secret
* Vortech TV
* Vstream 
* White cream
* White Devil
* Wolfpack
* Wookie Wizard
* Wraith
* Wrestling On Demand
* Xfinity Installer
* XMovies8
* <Xstream>
* Xunity 
* Yify Movies 
* Yoda 
* Zem TV 
* Zeta TV
* Zeus 

==So where do I get support?==
Every Add-on should contain the authors name, this is found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

[[File:add-on-context.JPG|400px]]
[[File:add-on-info.JPG|400px]]

{{top}}

__NOINDEX__
[[Category:Forum]]

Settings/Live TV/Guide

2019-02-05T12:41:07Z

Davu:

{{bigger|This category contains the electronic programming guide (EPG) settings.}}
__TOC__

==General==
[[File:SettingsPVRGuide-leia.jpg|500px]]
=== Past days to display ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Number of past days to show in the guide and to import from backends.
|}

=== Future days to display ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Number of future days to show in the guide and to import from backends.
|}

=== Default select action ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select what will happen when an item is selected in the guide:
"Show context menu": Will trigger the context menu from where you can choose further actions

"Switch to channel": Will instantly tune to the related channel

"Show information": Will display a detailed information with plot and further options

"Record": Woll create a recording timer for the selected item
|}

=== Hide 'no information available' labels ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Hides "no information available" labels when no EPG data could be retrieved for a channel.
|}
{{-}}

==Updates==

[[File:PVR_Guide_2.jpg|500px]]

=== Update interval ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Time between guide data imports from backends. Defaults to 120 minutes.
|}

=== Prevent updates during playback ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Do not import Guide data while playing TV, to minimise CPU usage.
|}

=== Don't cache in local database ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Guide data is stored in a local database by default, to speed up EPG importing when Kodi is restarted. Enabling this option will prevent that.
|}

=== Clear data ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Delete the cached guide data and reimport it from the backend.
|}

{{updated|18}}

Template:Updated

2019-01-30T10:54:27Z

Davu:

{{#switch: {{{1}}}
| 13 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#fa8072|Page updated for v13}}</small> }}<includeonly>[[Category:Gotham]]</includeonly>
| 14 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#fa8072|Page updated for v14}}</small> }}<includeonly>[[Category:Helix]]</includeonly>
| 15 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#fa8072|Page updated for v15}}</small> }}<includeonly>[[Category:Isengard]]</includeonly>
| 16 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#fa8072|Page updated for v16}}</small> }}<includeonly>[[Category:Jarvis]]</includeonly>
| 17 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#fa8072|Page updated for v17}}</small> }}<includeonly>[[Category:Krypton]]</includeonly>
| 18 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#a0e75a|Page updated for v18}}</small> }}<includeonly>[[Category:Leia]]</includeonly>
| 19 = {{top icon|raw=<small>{{highlight|bordered=yes|color=#87ceeb|Page updated for v19}}</small> }}<includeonly>[[Category:Leia]]</includeonly>
}}<noinclude>{{doc}}</noinclude>

Releases

2019-01-30T10:48:35Z

Davu:

{{mininav| [[Kodi]] {{l2| [[Development]] }} }}

{{see also|Changelogs}}

== Release history ==

This is a release history with condensed changelogs for the most important added or removed notable new features, functions, and changed in each stable version of {{kodi}}.

{| class="prettytable"
|-
! colspan="2"| Legend
|-
| style="background:salmon;"| Red
| Old releases
|-
| style="background:#a0e75a;"| Green
| Current release
|-
| style="background:skyBlue;"| Blue
| Future releases
|}

{| class="prettytable"
|-
! Version
! Release date
! [[Codename]]
! Significant changes
! XBMC Live based on
|-
| style="white-space:nowrap; background:salmon;"| 1.0.0
| 29 June 2004
| {{n/a}}
|
* Total rewrite of the source code from [[Xbox Media Player|XBMP (Xbox Media Player)]]
|{{n/a}}
|-
| style="white-space:nowrap; background:salmon;"| 1.1.0
| 18 October 2004
| {{n/a}}
|
* ITU H.261, creative labs yuv (cyuv), supermac cinepak (cvid), quicktime, on2 vp4, 3ivx d4 / 3vi1 mpeg-4 video support
* Container support for nsa, raw audio in .mov, .ac3, .dts and dts-wav
* Zoom/stretch options: zoom, stretch 4x3 or 14x9 or 16x9, original size, custom
* Volume control
* Tags parsing and display for wma, m4a, mp4 and aac (mpeg-4 audio) audio-files
* International-language fonts for subtitles via ttf-fonts
* Audio CD Ripper, backup cdda's to hdd in wav, ogg or mp3 (lame) format
* Karaoke cdg-file and audio cue sheets (.cue) support
* iIunes music shares via DAAP (network stream from Apple iTunes)
* XBMC's xbmsp-client code updated to support "auto-discovery of xbmsp servers"
* Auto-temperature and fan-speed control options
* Network-configuration and setup via GUI
* Emergency recovery console (enables the ftp-server during fatal errors)
* Profiles for settings
* Mouse support and virtual-keyboard
* LCD-display output extended to also support xaddons lcd-mods and xecuter3 lcd
| {{n/a}}
|-
| style="white-space:nowrap; background:salmon;"| 2.0.0
| {{nowrap|29 September 2006}}
| {{n/a}}
|
* Reworked skinning engine.
* DVD-Video menu/navigation support (with ISO/IMG image parsing) through internally developed core
* RAR/ZIP archive parsing
* New audio/music-player (PAPlayer) with crossfade, gapless playback and ReplayGain support
* Karaoke CDG-file display
* Xored Trainer Engine (gaming-cheats) (not ported from Xbox)
* XLink Kai (online-gaming) front-end (depreciated)
* Added iTunes 6.x DAAP and UPnP-client
* Read-only support for FAT12/16/32 formatted USB Mass Storage Devices up to 4GB in size
* Brand new "skinnable" 3D visualizer.
| {{n/a}}
|-
| style="white-space:nowrap; background:salmon;"| 8.10
| 15 November 2008
| Atlantis
|
* Cross platform support adding support for Linux, Mac OS X, and Windows
* Brand new High Definition skin “PM3.HD”
* "XBMC Live" bootable CD with unified hard disk/USB flash disk installer
* The XBMC profile
* Integration of iTunes and iPhoto media (OS X exclusive).
| Ubuntu 8.10
|-
| style="white-space:nowrap; background:salmon;"| 9.04
| 6 May 2009
| Babylon
|
* PPC (PowerPC) support for Mac OS X (PowerPC G4 or later)
* VDPAU (Nvidia's Video Decode and Presentation API for Unix)
* New Karaoke features
* Officially dropped support for Xbox
* Updated codecs and major bug-fixes for DVD-Video playback core
* More Media Info Scrapers
* Improved FanArt support
* Revamped skinning engine
| Ubuntu 9.04
|-
| style="white-space:nowrap; background:salmon;"| 9.11
| 24 December 2009
| Camelot
|
* Revamped user interface via the new default skin “Confluence“
* DirectX support by default for the Windows platform
* A complete reorganization of the settings menus uniformed across skins
* Automatic video information extraction
* Out of the box support for new remotes
* Smoother video playback performance
* All scrapers updated
* Increased subtitle and Karaoke lyric support
* Support for CoreAudio API (OS X exclusive)
* AC3 and DTS digital audio pass-through to SP/DIF on Apple TV (thanks to CoreAudio)
| Ubuntu 9.10
|-
| style="white-space:nowrap; background:salmon;"| 10.0<br />10.1
| 18 December 2010<br />10 March 2011
| Dharma
|
* Unified Addon framework
* Addon Browser GUI for installation and management of third-party addons, skin, and scripts
* Team XBMC's official Addons Repository with Addon FanArt support
* Update Notifications
* Movie Sets (option to group movie collections)
* WebM/VP8 codec
* Gesture support to XBMC's GUI Engine
* Unencrypted Blu-ray Disc support
* Broadcom Crystal HD video acceleration support (All Platforms)
* Windows Touch API support (Windows 7 touch features and functions)
* DXVA 2.0 (DirectX Video Acceleration) (Windows Vista/7 exclusive)
* WASAPI (Windows Audio Session API) for raw bitstream output (Windows Vista/7 exclusive)
* High-Quality Bicubic and Lanczos Upscalers (Video Resamplers) as Direct3D HLSL (Windows Vista/7 exclusive) and OpenGL GLSL Shaders
* Direct3D port of the OpenGL Spectrum 3D Audio Visualization for DirectX (Windows Vista/7 exclusive)
* AVisual Studio 2010 Express edition and Visual Studio 2010 non-Express edition support (Windows Vista/7 exclusive)
* ARM processor architecture (Linux exclusive)
* VAAPI (Video Acceleration API) support (Linux exclusive)
* OpenMAX Video Acceleration support (Linux exclusive)
* NEON (ARM) Video Acceleration support (Linux exclusive)
* Apple VDADecoder Video Acceleration support (OS X exclusive requires Snow Leopard and NVIDIA 9400 or later)
* OpenGL ES 2.0 compliance
* JSON-RPC, JSON API
* RTMPE and RTMPTE
* Microhttpd Web Server replaces old GoAhead and Spyce code
* SSH file transfer protocol (sftp) via libssh
* MySQL database backend
| Ubuntu 10.04
|-
| style="white-space:nowrap; background:salmon;"| 11.0
| 24 March 2012
| Eden
|
{{main|XBMC v11 (Eden) changelog|Eden API changes}}
* iOS port for Apple TV 2G, iPhone, iPod Touch, and iPad
* [[Dirty regions]] rendering for texture support to skinning engine
* Efficiency improvements to reduce high cpu/gpu usage
* Default skin changed to a horizontal home layout
* New RenderCapture type to the Python script framework
* Combined Files and Library mode for videos
* Playback of ISO image files for Blu-ray Disc support
* Slingbox playback over the network support
* Peripheral manager controller under settings
* Consumer Electronics Control (CEC) support for HDMI
* Improved Apple VDADecoder Video Acceleration support
* Improved Touch / Gesture API and Mouse support
* Improved ARM processor architecture support
* Improved OpenMAX Video Decoding Acceleration support
* Improved OpenGL ES and EGL support
* Improved JSON-RPC API compliant with JSON-RPC 2.0 specs
* Improved VDPAU performance
* VDPAU HQ Upscaling support (require NVIDIA's capable GPU)
* H.264 accelerated video decoding via Apple's VideoToolBox API
* JPEG accelerated video decoding via Apple's VideoToolBox API
* Added basic DRC (Dynamic Range Compression) volume limiter
* [[AirPlay|AirPlay/AirTunes]] target support
* Extended Addons API adding extension points for Service Addons
* Ability for all addons to provide their own web interface
* Removed native weather forecast scraper, use weather add-ons instead
* Added support for multiple simultaneous HID device mappings
* FFmpeg upgraded (libavformat and libavcodec)
| Lubuntu 11.10
|-
| style="white-space:nowrap; background:salmon;"| 12.0<br />12.1<br />12.2<br />12.3
| 29 January 2013<br />18 March 2013<br />3 May 2013<br />{{nowrap|24 December 2013}}
| Frodo
|
{{main|XBMC v12 (Frodo) changelog|Frodo API changes}}
* Added unified [[PVR|Live TV and PVR frontend]] with a common EPG and DVR (Digital Video Recording) client GUI
* Added unified PVR backend framework and API for multiple [[PVR/Backend|PVR backend software]] from third-parties
* Initial [http://en.wikipedia.org/wiki/Android_%28operating_system%29 Android (operating system)] port with multi-architecture platform support
* Initial [http://en.wikipedia.org/wiki/Berkeley_Software_Distribution BSD (operating system)] port for FreeBSD, PC-BSD, and other similar BSD platforms
* Added unified "[[AudioEngine]]" audio abstraction framework with an API and platform sinks
* Added dedicated AMLPlayer video player for hardware accelerated video decoding on [[AMLogic devices|Amlogic]]
* Added dedicated OMXPlayer video player for hardware accelerated video decoding via OpenMAX IL API
* [http://en.wikipedia.org/wiki/ARM_architecture#Advanced_SIMD_.28NEON.29 NEON (Advanced SIMD instruction set)] CPU acceleration support for the ARM architecture
* Improved ARM processor architecture ([http://www.pivosgroup.com/xios.html Pivos XIOS DS] and [[Raspberry Pi]] as reference devices)
* Improved OpenGL ES and EGL support ([http://www.pivosgroup.com/xios.html Pivos XIOS DS] and [[Raspberry Pi]] as reference devices)
* Added ability to run a split display resolution for GUI and video playback on embedded platforms[http://github.com/xbmc/xbmc/pull/1467]
* Enabled [[Dirty regions|Dirty Regions]] rendering to redraw whole screen on single dirty region by default on all platforms[http://github.com/xbmc/xbmc/pull/1426][http://xbmc.org/theuni/2011/06/19/working-with-dirty-regions/]
* Added 64-bit build support Mac OS X to match the existing 64-bit support for Linux
* Improved [http://en.wikipedia.org/wiki/HDMI#CEC|HDMI CEC (Consumer Electronics Control)] support for [http://libcec.pulse-eight.com/ Pulse-Eight's LibCEC]
* Library customization that allows for custom video nodes
* Added [[Advanced Library Filtering]] for Movies, TV Shows, Music Videos, and Music views
* Improved [[Smart playlists|Smart Playlist]] for Advanced Library Filtering
* Added custom [[video library tags]] for Movies, TV Shows and Music Videos to simplify sets with scraping
* Added support for both banner and poster video art types simultaneously[http://github.com/xbmc/xbmc/pull/1575]
* Added storing of "Episode ID" for First Aired, DVD Episode Number, and Absolute Number sort order
* Added support for exporting video art as JPG or PNG rather than TBN file extension
* Switched to [http://en.wikipedia.org/wiki/TagLib TagLib] for reading metadata embedded into audio files
* Better library database handling for faster browsing
* Improved image and texture caching for GUI speedup
* Improved Touch / Gesture API support for touchscreen interfaces
* Added HLS (HTTP Live Streaming) and M3U8 (Extended M3U) playlist support
* Added WebSocket support for JSON-RPC and to Addons API[http://github.com/xbmc/xbmc/pull/511]
* Added image transformation handler for resizing images on-the-fly over JSON-RPC and WebServer API
* Added basic support for PVR / EPG extensions and notifications over the JSON-RPC API
* Added SmartPlaylist Extensions and Extended Filtering in JSON-RPC[http://github.com/xbmc/xbmc/pull/1258]
* Added support for screensavers written in Python programming language
* Added ability to [http://github.com/xbmc/xbmc/pull/901 extend XBMC's native Python API by writing C++ code generated] via [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 Groovy] and [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 SWIG]
* Blu-ray Disc HDMV menu support (but not BD-J / BD-Live menus)[http://github.com/xbmc/xbmc/pull/464]
* Improved deinterlacing "Weave" method for playback of interlaced video when upscaling
* Improved performance of the default Web Interface (complete rewrite of JavaScript loading)
* Improved AirPlay / AirTunes target support
* Improved the Audio-CD ripper that now works as a background task job
* Improved international language file translations system that are powered by Transifex[http://xbmc.org/blittan/2012/10/30/dear-addon-and-skin-developers/]
* Added a Test Suite based on [http://code.google.com/p/googletest/ Google C++ Testing Framework] to make regression testing easier
* Added support controlling external XBMC and third-party UPnP/DLNA instances over UPnP
* Upgraded [http://www.plutinosoft.com/platinum Plutinosoft's Platinum (libplatinum)] UPnP and DNLA libraries
* Upgraded [http://en.wikipedia.org/wiki/FFmpeg FFmpeg's libavcodec and libavformat] audio/video cedec and demuxer libraries
* Removed the old HTTP API in favour of the new JSON-RPC API
| Lubuntu 12.10
|-
| style="white-space:nowrap; background:salmon;"| 13.0<br />13.1<br />13.2
| 4 May 2014<br />5 June 2014<br />17 August 2014
| Gotham
|
{{main|XBMC v13 (Gotham) changelog|Gotham API changes}}
* Added much improved PVR / EPG and Live TV interface in XBMC's GUI skinning engine (already in use in Confluence)
* Added improved PVR / DVR timeshift support to pause Live TV (note that each PVR backend still need to support timeshifting)
* Added much improved PVR / EPG extensions and notifications support over the JSON-RPC API
* Improved PVR front-end with Live TV and EPG specific windows, plus PVR stuff in OSD and GUI settings in Confluence skin
* Added, updated, and improved PVR backend clients addons for many popular third-party external [[PVR backend]] platforms:
** [[PVR/Testing|PVR Demo Client]] dummy addon with fake backend from Team-XBMC for skin development and regression testing
** [[PVR/Backend/IPTV|IPTV (IPTV Simple Client)]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/Tvheadend|Tvheadend]] PVR Addon backend clients maintained and available from XBMC's community
** [[PVR/Backend/NextPVR|NextPVR (former GB-PVR)]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/Njoy|Njoy Digital (N7)]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/MediaPortal|MediaPortal]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/MythTV|MythTV]] PVR Addon backend client maintained and available from the XBMC's community
** [[PVR/Backend/VDR|VDR (Video Disk Recorder)]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/VUPlus|Vu+ / Enigma2 / Dreambox]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/ForTheRecord|Argus TV / ForTheRecord]] PVR Addon backend client maintained and available from XBMC's community
** [[Add-on:PVR.WMC|WMC (Windows Media Center)]] PVR Addon backend client maintained and available from XBMC's community
** [[DVBLink]] PVR Addon backend client maintained and available from XBMC's community
** [[PVR/Backend/DVBViewer|DVBViewer]] PVR Addon backend client maintained and available from XBMC's community
* Added option for allowing skins to query directories (e.g. plugins) to fill static content
* Added a Monitor class to receive JSON-RPC notifications directly through the Python bindings
* Added announce function and register addon for announcements to the Add-ons API
* Added new Built-In function to control state of attached HDMI CEC device via Add-ons API
* Added support for XBMC's Python interface to use native keyboard if possible (currently only iOS)
* Added support for addon binary reading and writing via a "buffer" class usable from addons
* Added WOL (Wake-on-LAN) with send magic packet function to the Add-ons API
* Improved the ability to [http://github.com/xbmc/xbmc/pull/901 extend XBMC's native Python API by writing C++ code generated] via [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 Groovy] and [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 SWIG]
* Improved Addons API for homebrew DIY RGB LED [http://en.wikipedia.org/wiki/Ambilight Ambilight] clone client software such as [[Add-on:XBMC Boblight|Boblight]]
* Added support for customizable menu structure for home and beyond
* Added Stereoscopic 3D rendering support (Side-by-Side, Top-Bottom, and Anaglyph) to XBMC's GUI skinning engine
* Added Stereoscopic 3D rendering support (Side-by-Side, Top-Bottom, and Anaglyph) for Subtitles when in 3D mode
* Added a simple Movie Set management to GUI for Edit/Clear Set and Add/Remove Set members
* Added option support for both banner and poster music art types simultaneously
* Added picture tags metadata info accessible for skins or addons developers
* Added further optimizations to XBMC's GUI engine for faster rendering on low resource embedded devices
* Improved touch and gesture support for all platforms, and also improved the default touch screen skin ([[Touched]])
* Added [http://github.com/xbmc/xbmc/pull/2040 ImageFactory implementation] with factory to abstract different image libraries and hardware acceleration
* Improved [[Dirty regions|Dirty Regions]] rendering on all platforms
* Refactored settings system to consist of XML files containing descriptions of every setting
* Added support for H.264 (including [[Hi10P]]) multi-threaded video decoding when software decoder on CPU is used
* Added support for Forced Subtitles ("forced flag") in external subtitle files
* Added support for video playback of SageTV recordings
* Added unified buffering capability to video and overlay renderers for all internal players
* Upgraded FFmpeg (libavcodec and libavformat) audio/video codec and demuxer libraries to [http://www.ffmpeg.org/download.html#release_1.2 FFmpeg 1.2 (rev e820e3a)]
* Added extensive MusicBrainz tags support to the Music Library and Database
* Added ability to queue list of items / add items to a playlist without playing them
* Improved and extended [[Smart playlists|Smart Playlists]] functionality
* Added support for scanning videos SFTP and SSH sources so can scrape metadata
* Added support for write-enabled WebDAV (delete/rename/write files and directories)
* Added "Add art" button to video artwork selection dialog
* Added support for "last played" sort option to the TV Show GUI
* Added support for OGG cover art extraction to TagLib
* Added option support for exporting music art as JPEG or PNG rather than TBN file extension
* Improved performance for SQL database queries for faster browsing
* Added theaudiodb.com music video scraper as new default for music videos
* Added new cross-platform event driven active state machine pattern [[AudioEngine#ActiveAE|ActiveAE]] sink as the default for XBMC's [[AudioEngine]]
* Added ALSA sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop and generic Linux based Embedded Systems
* Added PulseAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop
* Added OSS (Open Sound System) sink for [[AudioEngine#ActiveAE|ActiveAE]] for BSD, like FreeBSD, PC-BSD, and similar Unix based systems
* Added AUDIOTRACK sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Amlogic]]
* Added Pi Audio sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Raspberry Pi]]
* Added DirectSound sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Added WASAPI sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Added Darwin sink for [[AudioEngine#ActiveAE|ActiveAE]] for Mac OS X and iOS
* Added support for CoreAudio AudioEngine to OS notifications for device changes on Mac OS X and iOS
* Added support for "Play to" and controlling remote XBMC / DLNA instance over UPnP
* Added new "Fishbmc" audio visualization addon (only OpenGL versions for Linux and Mac OS X for now)
* Added GUI settings levels for Basic, Standard, Advanced, Expert (defaults to "Standard")
* Added support and GUI settings for SOCKS 4/4a/5 proxy types and remote DNS
* Added possibility to define help descriptions ("I" key) for every setting in GUI settings
* Added option to set auto login of a specific user profile via the GUI
* Added CPU / GPU frequency and temperature for all supported Linux platforms
* Added support to allow key IDs in keyboard.xml to be in hexadecimal format
* Upgraded DVD-Video navigation and playback libraries (libdvdnav, libdvdread, and libdvdcss)
* Upgraded SAMBA client to version 3.6.x adding full support for SMB 2.0 and SMB 2.1 protocols
* Added initial support for running libxbmc.so headless (without GUI) as a background service / deamon
* Added a generic and user-mappable cross-platform touch input system
* Improved [http://en.wikipedia.org/wiki/HDMI#CEC|HDMI CEC (Consumer Electronics Control)] support for [http://libcec.pulse-eight.com/ Pulse-Eight's LibCEC]
* Moved subtitle addon core handling to core and added native support for subtitle plugin services
* Updated community maintained translations to over 60+ languages to date for XBMC via [[Translation System|Transifex Translation System]]
* Added first full (and stable) XBMC for [[Android]] port with multi-architecture platform support (supports ARM, MIPS, and x86)
* Added built-in command for addons and skins to execute Android apps with optional params via applicationmanager
* Added support to allow landscape and reverse landscape orientation of XBMC GUI on Android
* Added MediaCodec API (Android 4.1 API level 16) software rendering implementation support to XBMC's DVDPlayer
* Added StageFright API (Android 4.0 API level 14) hardware rendering implementation support to XBMC
* Added OpenMAX Video Acceleration API support for OpenMAX AL API on Android via StageFright and MediaCodec
* Improved the dedicated AMLPlayer video player for hardware accelerated video decoding on [[AMLogic devices|Amlogic]]
* Added external player (external player launcher) support on Android
* Added native volume control for Android from within XBMC
* Improved [http://en.wikipedia.org/wiki/ARM_architecture#Advanced_SIMD_.28NEON.29 NEON (Advanced SIMD instruction set)] CPU acceleration support for ARM architecture
* Improved XBMC support for [http://en.wikipedia.org/wiki/Berkeley_Software_Distribution BSD (operating system)] on FreeBSD, PC-BSD, and other similar BSD platforms
* Improved VDPAU (NVIDIA) Hardware Acceleration Video Decoding support on BSD
* Improved VAAPI (Video Acceleration API) Hardware Acceleration Video Decoding support on BSD
* Added VA-API (libva) support for decoding videos with larger resolutions than 1080p (such as 4K resolution)
* Improved ARM processor architecture ([http://www.pivosgroup.com/xios.html Pivos XIOS DS] and [[Raspberry Pi]] as reference devices)
* Improved OpenGL ES and EGL support ([http://www.pivosgroup.com/xios.html Pivos XIOS DS] and [[Raspberry Pi]] as reference devices)
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration and its upscaling/deinterlacing capabilities
* Improved OpenMAX Video Acceleration API support for Linux (using Raspberry Pi as reference hardware)
* Added RenderCapture implementation to Linux for Raspberry Pi for Ambilight addons
* Added support for OpenMAX pipeline to handle JPEG decode/resize/convert/encode to texture on Raspberry Pi
* Added support for hardware assisted video decoding of MJPEG, VP6, VP8 and Ogg Theora on Raspberry Pi
* Added support for Fast Forward and Rewind video up 4x to OpenMAX (OMXPlayer) on Linux for Raspberry Pi
* Added support multi-channel PCM audio output over HDMI to OpenMAX (OMXPlayer) on Linux for Raspberry Pi
* Added screenshot implementation to Linux for Raspberry Pi that includes the video layer
* Added hot-plug support for Linux input devices, such as Bluetooth remotes and keyboards
* Improved AMD/Intel x86-64 64-bit (AMD64 / IA-64t CPU architectures) support under Linux
* Removed dependencies of SDL (Simple DirectMedia Layer) for windowing and event handling on X11
* Added support for native media control bar and play background music on iOS
* Added adaptions for developing XBMC on non-jailbroken iSO devices (for development only, not to release on App Store)
* Improved XBMC support for OS X 10.9 (Mavericks)
* Added support for copy and paste to and from clipboard with command key
* Added support for Pixel Shader based HQ (High Quality) scalers for DXVA renderer on Windows
* Added hybrid shutdown option on Windows 8 (which in turn enables quick boot)
* Removed Windows XP support (as from now XBMC for Windows requires at least Vista or later)
| Lubuntu 14.04
|-
| style="white-space:nowrap; background:salmon;"| 14.0<br />14.1<br />14.2
| 23 December 2014<br />1 February 2015<br />28 March 2015
| Helix
|
{{main| Kodi v14 (Helix) changelog |Helix API changes}}
* Renamed and rebranded to Kodi Media Center (from XBMC Media Center)
* Improved PVR, EPG, and OSD frontend GUI in Kodi and extended the PVR API to support more features and functions
* Improved PVR / EPG and Live TV interface in Kodi's GUI skinning engine (already in use in Confluence)
* Improved PVR / DVR timeshift support to pause Live TV (note that each PVR backend still need to support timeshifting)
* Improved PVR / EPG extensions and notifications support over the JSON-RPC API
* Updated and improved PVR backend clients addons for many popular third-party external PVR backend platforms:
* PVR Demo Client dummy addon with fake (method stub) backend for skin development and regression testing
* IPTV (IPTV Simple Client) PVR Addon backend client maintained and available from Kodi's community
* Tvheadend PVR Addon backend clients maintained and available from Kodi's community
* NextPVR (former GB-PVR) PVR Addon backend client maintained and available from Kodi's community
* Njoy Digital (N7) PVR Addon backend client maintained and available from Kodi's community
* MediaPortal PVR Addon backend client maintained and available from Kodi's community
* MythTV PVR Addon backend client maintained and available from the Kodi's community
* VDR (Video Disk Recorder) PVR Addon backend client maintained and available from Kodi's community
* Enigma2 / Vu+ / Dreambox PVR Addon backend client maintained and available from Kodi's community
* Argus TV / ForTheRecord PVR Addon backend client maintained and available from Kodi's community
* WMC (Windows Media Center) PVR Addon backend client maintained and available from Kodi's community
* DVBLink PVR Addon backend client maintained and available from Kodi's community
* DVBViewer PVR Addon backend client maintained and available from Kodi's community
* Added framework support for binary addons (inc. closed source proprietary addons) for audio encoder codecs
* Added support for audio encoder codecs via a binary addons and move Vorbis, LAME, Flac and WAV audio encoders to addons
* Added capability for Text-to-Speech screen readers addons for visual impaired
* Improved the ability to extend Kodi's native Python API by writing C++ code generated via Groovy and SWIG
* Improved Addons API for homebrew DIY RGB LED Ambilight clone client software such as Boblight
* Improved Stereoscopic 3D rendering support (Side-by-Side, Top-Bottom, and Anaglyph) to Kodi's GUI skinning engine
* Improved Stereoscopic 3D rendering support (Side-by-Side, Top-Bottom, and Anaglyph) for Subtitles when in 3D mode
* Added support for HEVC (High Efficiency Video Coding) a.k.a. H.265 software video decoding
* Improved support for H.264 (including Hi10P) multi-threaded video decoding when software decoder on CPU is used
* Upgraded FFmpeg (libavcodec and libavformat) audio/video codec libraries to release version FFmpeg 2.2)
* Removed FFmpeg from from the Kodi code tree, making it easier to compile/build separately
* Improved network and file system reading when scanning files and searching for subtitles
* Improved MusicBrainz tags support to the Music Library and Database
* Improved and extended Smart Playlists functionality
* Improved performance for SQL database queries for faster library browsing
* Updated music, movies, tv shows, and music video scrapers for Kodi from the community
* Added support for Planar Formats and PTS audio synchronization from player in ActiveAE
* Improved the default cross-platform event driven active state machine pattern ActiveAE (Kodi's AudioEngine)
* Improved ALSA sink for ActiveAE for Linux Desktop and generic Linux based Embedded Systems
* Improved PulseAudio sink for ActiveAE for Linux Desktop
* Improved OSS (Open Sound System) sink for ActiveAE for BSD, like FreeBSD and similar BSD Unix based systems
* Improved AUDIOTRACK sink for ActiveAE for Amlogic
* Improved Pi Audio sink for ActiveAE for Raspberry Pi
* Improved DirectSound sink for ActiveAE for Windows
* Improved WASAPI sink for ActiveAE for Windows
* Improved CoreAudio sink for ActiveAE for Mac OS X and iOS
* Improved Darwin sink for ActiveAE for Mac OS X and iOS
* Improved CEC (Consumer Electronics Control) support for Pulse-Eight's LibCEC
* Upgraded DVD-Video navigation and playback libraries (libdvdnav, libdvdread, and libdvdcss)
* Upgraded SAMBA client to version 3.6.x for improved support for SMB and CIFS protocols
* Updated community maintained translations to over 60+ languages to date for Kodi via Transifex Translation System
* Improved MediaCodec API video decoding implementations support for Android 4.1 (API level 16) and later
* Improved StageFright API video decoding implementations support for Android 4.0 (API level 14)
* Improved the dedicated AMLCodec hardware accelerated video decoding support for AMLogic devices
* Improved NEON (Advanced SIMD instruction set) CPU acceleration support for ARM architecture
* Improved Kodi support for BSD (operating system) on FreeBSD, PC-BSD, and other similar BSD platforms
* Added initial optional X11 support on EGL (EGL-X11) based systems on Linux, full-screen mode only
* Added native XvBA accelerated video decoding for AMD/ATI GPUs on Linux
* Improved ARM processor architecture (using WeTek Play and Raspberry Pi as reference devices)
* Improved OpenGL ES and EGL support (using WeTek Play and Raspberry Pi as reference devices)
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration (requires VDPAU compatible hardware and drivers)
* Improved OpenMAX Video Acceleration API support for Linux (using Raspberry Pi as reference hardware)
* Improved dedicated AMLCodec hardware accelerated video decoding support for Linux on AMLogic devices
* Improved AMD/Intel x86-64 64-bit (AMD64 / IA-64t CPU architectures) support under Linux
* Upgraded SDL (Simple DirectMedia Layer) from version 1.2 to 2.0 for improved input-support on Linux
* Removed dependencies of SDL (Simple DirectMedia Layer) for windowing and event handling on X11
* Improved Apple VDADecoder Video Acceleration support for iOS (on iPad, iPhone, and iPod iDevices)
* Improved Apple VDADecoder Video Acceleration support for (Mac) OS X
* Improved DXVA (DirectX Video Acceleration) support (requires DXVA compatible hardware and drivers)
* Upgraded Kodi for Windows and binary addons to compile with Microsoft Visual Studio 2013 by default

|
|-
| style="white-space:nowrap; background:salmon;"| 15.0<br />15.1<br />15.2
| 21 July 2015<br />16 August 2015<br />19 October 2015
| Isengard
|
{{main| Kodi v15 (Isengard) changelog |Isengard API changes}}
* Added possibility to use multiple PVR clients for different PVR backends at the same time
* Improved PVR, EPG, and OSD frontend GUI in Kodi and extended the PVR API to support more features and functions
* Improved PVR API and database adding many new EPG and Channel properties
* Improved PVR / DVR timeshift support to pause Live TV (note that each PVR backend still need to support timeshifting)
* Improved PVR / EPG extensions and notifications support over the JSON-RPC API
* Improved Closed Captions (CC) support for Live TV
* Improved the "GlobalSearch" (service addon) function by adding EPG search support
* Added, updated, and improved PVR backend clients addons for all popular third-party external [[PVR backend]] platforms:
** [[PVR/Testing|PVR Demo Client]] dummy addon with fake (method stub) backend for skin development and regression testing
** [[PVR/Backend/IPTV|IPTV (IPTV Simple Client)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:FilmOn PVR Client|FilmOn]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:PCTV Systems Client|PCTV Systems (Broadway)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Stalker Client|Stalker Middleware]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:VBox TV Gateway PVR Client|VBox TV Gateway]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/Tvheadend|Tvheadend]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/NextPVR|NextPVR (former GB-PVR)]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/Njoy|Njoy Digital (N7)]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/MediaPortal|MediaPortal]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/MythTV|MythTV]] PVR Addon backend client maintained and available from the Kodi's community
** [[PVR/Backend/VDR|VDR (Video Disk Recorder)]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/VUPlus|Enigma2 (Dreambox / Vu+ / DBox2)]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/ForTheRecord|Argus TV / ForTheRecord]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:PVR.WMC|WMC (Windows Media Center)]] PVR Addon backend client maintained and available from Kodi's community
** [[DVBLink]] PVR Addon backend client maintained and available from Kodi's community
** [[PVR/Backend/DVBViewer|DVBViewer]] PVR Addon backend client maintained and available from Kodi's community
* Removed internal MythTV VFS client code in favour of its external PVR Client Addons
* Removed internal VDR (VTP) VFS client code in favour of its external PVR Client Addons
* Removed internal Tvheadend (HTSP) VFS client code in favour of its external PVR Client Addons
* Removed internal TuxBox (Dreambox/DBox2/Vu+/Enigma1/2) VFS client code in favor of external PVR Client Addons
* Removed internal ReplayTV (DirectTV) VFS client code since its old and was no longer being maintained by anyone
* Removed internal SlingBox VFS client code since its old and is no longer being maintained by anyone
* Improved Addon Manager frontend GUI in Kodi, adding support for categorization, new manager layout and more
* Added initial integration for binary addons support and changing the Kodi build system around it
* Added framework support for binary addons for audio decoder and audio encoder codecs
* Extend Addons API to support binary addons for audio decoder and audio encoder codecs
* Added support for context-menu addons for skinners and addon developers
* Added option for addons scripts to check status of DPMS energy saving functions of underlying OS
* Improved the ability to [http://github.com/xbmc/xbmc/pull/901 extend Kodi's native Python API by writing C++ code generated] via [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 Groovy] and [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 SWIG]
* Improved Addons API for homebrew DIY RGB LED [[Ambient lighting]] (Ambilight clone) client software such as [[Add-on:XBMC Boblight|Boblight]]
* Improved addon management at Kodi version upgrade by immediately fetch updates from repository after upgrade
* Added support for context-menu addons for skinners and addon developers
* Added support Sound Addons for skins instead of including sound files within each skin.
* Improved PVR / EPG / Live TV and context menus interfaces in Kodi's GUI skinning engine (already used in Confluence)
* Added support for Language Addons, moving internal Language translation files into external Language Addons
* Added an accessibility settings section to provide one configuration area for the visually and hearing impaired
* Added further optimizations to Kodi's GUI engine for faster rendering on low resource embedded devices
* Added new icon types and missing icons to Confluence
* Added PVR and EPG support to the Re-Touched (touchscreen friendly) skin
* Improved [[Dirty regions|Dirty Regions]] rendering on all platforms
* Improved Stereoscopic 3D rendering support (Side-by-Side, Top-Bottom, and Anaglyph) to Kodi's GUI skinning engine
* Improved Stereoscopic 3D rendering support (Side-by-Side, Top-Bottom, and Anaglyph) for Subtitles when in 3D mode
* Improved navigation of video audio tracks and subtitle selection lists
* Improved touch and gesture support for all platforms, and also improved the default touch screen skin ([[Add-on:Re-Touched|Re-Touched]])
* Improved and expanded the internationalization options and regional configuration settings in the GUI
* Improved GUI settings configuration levels for Basic, Standard, Advanced, Expert (defaults to "Standard")
* Improved selection when installing new skins
* Update the default bold and regular Roboto TTF fonts from Google
* Updated keyboard layout for many languages
* Restructured settings windows and descriptions for almost every setting and configuration
* Removed legacy code to backwards compatibility for skins made pre-Frodo (XBMC 11.0)
* Added adaptive skipping/seeking through audio and video playback, also known as "[[skip steps]]"
* Improved support for H.264 (including [[Hi10P]]) multi-threaded video decoding when software decoder on CPU is used
* Improved Stereoscopic 3D playback with video playlist switching when playlists have 2D and 3D videos
* Added support for MK3D (Matroska 3D) video extensions and enable double cache by default on these videos
* Added a Chapter Selector Window with visual thumbnails shows thumbs on where to skip to in video
* Added support for Closed Captions (CC) in CEA-608 and CEA-708 formats (ATSC Closed Caption)
* Added support for external subtitles over UPnP / DNLA through the settings section
* Upgraded FFmpeg (libavcodec and libavformat) libraries to release version [http://www.ffmpeg.org/download.html#release_2.6.2 FFmpeg 2.6.2]
* Remove certain audio codecs from core and made them into audio decoder and audio encoder add-ons
* Disabled hardware video decoding of MPEG-2 videos with Standard Definition resolution by default
* Added support for [[Music_nodes| music nodes]] that can defined views that are used to organize your media from the music menu
* Added support for marking as watched during other library operations like “update library” when scanning sources
* Added support for allowing different sort orders for different sort methods
* Added ability to jump to first unwatched episode in TV section by default
* Added support to rescrape season art for newly added seasons
* Improved MusicBrainz tags support to the Music Library and Database
* Improved and extended [[Smart playlists|Smart Playlists]] functionality
* Improved performance for SQL database queries for faster library browsing
* Updated music, movies, tv shows, and music video scrapers for Kodi
* Improved the default cross-platform event driven active state machine pattern [[AudioEngine#ActiveAE|ActiveAE]] (Kodi's [[AudioEngine]])
* Improved ALSA sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop and generic Linux based Embedded Systems
* Improved PulseAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop
* Improved OSS (Open Sound System) sink for [[AudioEngine#ActiveAE|ActiveAE]] for BSD, like FreeBSD and similar BSD Unix based systems
* Improved AUDIOTRACK sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Amlogic]]
* Improved Pi Audio sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Raspberry Pi]]
* Improved DirectSound sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Improved WASAPI sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Improved CoreAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for (Mac) OS X and iOS
* Improved Darwin sink for [[AudioEngine#ActiveAE|ActiveAE]] for (Mac) OS X and iOS
* Added new audio visualization addons (only OpenGL versions for Linux and OS X for now)?
* Improved display of CPU / GPU frequency and temperature for all supported platforms
* Improved keymap for music playback, as while in full screen pressing select/ok button will now show the OSD
* Added support for [[wikipedia:WSGI|WSGI (Web Server Gateway Interface)]] to extend the Python Script support in Kodi's integrated webserver
* Added support for JSONP for JSON-RPC requests to Kodi's integrated webserver
* Added support for image resizing to Kodi's integrated webserver
* Improved webserver caching control
* Improved the JSON-RPC API
* Improved the the integrated UPnP Media Server and Client
* Changed Kodi application code base to C++11
* Improved [[CEC|HDMI CEC (Consumer Electronics Control)]] support for [http://libcec.pulse-eight.com/ Pulse-Eight's LibCEC]
* Upgraded HDMI-CEC libraries code from Pulse-Eight to [http://raw.githubusercontent.com/Pulse-Eight/libcec/master/ChangeLog LibCEC release version 3.0.0]
* Upgraded DVD-Video navigation and playback libraries (libdvdnav, libdvdread, and libdvdcss)
* Upgraded SAMBA client code library to version 3.6.12 for improved support for SMB/CIFS protocol
* Updated community maintained translations to over 60+ languages to date for Kodi via [[Translation System|Transifex Translation System]]
* Removed internal DAAP VFS client code for iIunes 6.x music shares (network stream from older Apple iTunes)
* Removal AFP filesystem support from Kodi's VFS (Virtual File System)
* Improved code stability and performance as well as general code clean-up in all areas
* Improved MediaCodec API video decoding implementations support for Android 4.2 (API level 17) and later
* Improved the dedicated AMLCodec hardware accelerated video decoding support for [[Amlogic]] devices
* Added automatic refresh rate switching support for video playback on Android 5.0 and later (>= API 21), including Android TV<ref>http://github.com/anssih/xbmc/commits/android/refreshrate_wip WIP refreshrate</ref>
* Added support for HEVC hardware decoding for MediaCodec API in Android 4.4.2 and later when the VPU supports it
* Added support for HEVC hardware decoding on [[Amlogic]] SoCs in Android 4.4.2 and later when the VPU supports it
* Added support for UltraHD decoding / 4K resolution output on [[Amlogic]] SoCs in Android when HW supports it
* Added support for screenshot and video bookmarks on [[Amlogic]] SoCs hardware
* Added support for LCD/VFD display panel output on [[Amlogic]] SoCs hardware
* Added support for de-interlacing using BOB deinterlace method on Android
* Added support for 7.1 channels PCM playback
* Added support for system handling of audio volume on Android
* Moved to Android API 17 as minimum with SDK 14 and NDK 10e, meaning at least Android 4.2 is now required
* Improved [http://en.wikipedia.org/wiki/ARM_architecture#Advanced_SIMD_.28NEON.29 NEON (Advanced SIMD instruction set)] CPU acceleration support for ARM architecture
* Removed the dependency for root/SU access permission rights on Android
* Improved Kodi support for [http://en.wikipedia.org/wiki/Berkeley_Software_Distribution BSD (operating system)] on FreeBSD, PC-BSD, and other similar BSD platforms
* Added MIPS processor architecture support for Linux (Imagination Technologies MIPS Creator CI20 as reference)
* Added support for HEVC hardware video decoding on [[Amlogic]] SoCs when the VPU supports it
* Added support for UltraHD decoding / 4K resolution output on [[Amlogic]] SoCs in Android when HW supports it
* Added support for screenshot and video bookmarks on [[Amlogic]] SoCs hardware
* Added support for LCD/VFD display panel output on [[Amlogic]] SoCs hardware
* Improved video accelerated decoding on [[Freescale|Freescale i.MX 6]] based devices
* Improved ARM processor architecture (using [[WeTek Play]] and [[Raspberry Pi]] as reference devices)
* Improved OpenGL ES and EGL support (using [[WeTek Play]] and [[Raspberry Pi]] as reference devices)
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration (requires VDPAU compatible hardware and drivers)
* Improved XvBA (AMD/ATI) Hardware Video Acceleration (requires XvBA compatible hardware and drivers)
* Improved OpenMAX Video Acceleration API support for Linux (using Raspberry Pi as reference hardware)
* Improved dedicated AMLCodec hardware accelerated video decoding support for Linux on [[Amlogic]] devices
* Improved AMD/Intel x86-64 64-bit (AMD64 / IA-64t CPU architectures) support under Linux
* Removed dependencies of SDL (Simple DirectMedia Layer) for everything but hardware abstraction for input devices
* Improve Apple VDADecoder Video Acceleration support for iOS (on iPad, iPhone, and iPod iDevices)
* Moved to iOS 8.1 SDK, minimum iOS 5.1 is now required, this removes support for Apple TV 2 builds
* Improve Apple VDADecoder Video Acceleration support for (Mac) OS X
* Added Kodi support for OS X 10.10 "Yosemite" from Apple
* Moved to OS X 10.10 SDK, meaning minimum (Mac) OS X 10.7 Lion is now required, and no more 32-bit builds
* Improved DXVA/DXVA2 (DirectX Video Acceleration) support (requires DXVA/DXVA2 compatible hardware and drivers)
* Added support for HEVC hardware video decoding via DXVA on Windows when hardware and driver supports exist
* ?
|
|
|-
| style="white-space:nowrap; background:salmon;"| 16.0<br />16.1
| 20 February 2016<br />24 April 2016
| Jarvis
|
{{main| Kodi v16 (Jarvis) changelog |Jarvis API changes}}

* Added support for handling RDS Radio signals via PVR and EPG frontend
* Added support for PVR addons to handle RDS radio signals in UECP and Rass formats
* Added FM Radio receiver based upon RTL-SDR as PVR Addon backend client
* Added support to PVR API for Scheduling Recordings of TV Shows (EPG based DVR Timers for "Series Recording")
* Added option for PVR clients and backends to add timeshift indicator to the Video OSD for Live TV
* Added support to show channels without EPG data in PVR guide window
* Added 'Play recording' context menu option if an EPG entry has an associated (PVR) recording
* Added enhancement and impovements to the PVR API (example series/episode metadata, timer and recording status)
* Updated Kodi's PVR Addon API version to 4.0.0 for Kodi v16 (Jarvis)
* Improved EPG association by broadcast ID
* Improved speedup reading EPG from database
* Changed activations of PVR windows so they are only available if PVR is enabled
* Changed "Add timer" as renamed to "Record", and renamed "Add custom timer" to just "Add timer"
* Added, updated, and improved PVR backend clients addons for all popular third-party external [[PVR backend]] platforms:
** [[Add-on:PVR Demo Client|PVR Demo Client]] dummy addon with fake (method stub) [[PVR backend]] for [[PVR]] skinning and regression testing
** [[Add-on:IPTV Simple Client|IPTV Simple Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:FilmOn PVR Client|FilmOn]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Stalker Client|Stalker Middleware]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:HDHomeRun PVR|HDHomeRun]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:VU+ / Enigma2 Client|Enigma2 (Dreambox / Vu+ / DBox2)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:VBox TV Gateway PVR Client|VBox TV Gateway]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Njoy N7 PVR Client|Njoy Digital (N7)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:PCTV Systems Client|PCTV Systems (Broadway)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Tvheadend HTSP Client|Tvheadend HTSP Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:VDR VNSI Client|VDR VNSI Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:MythTV PVR Client|MythTV PVR Client]] Addon backend client maintained and available from the Kodi's community
** [[Add-on:NextPVR PVR Client|NextPVR (former GB-PVR)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Argus TV Client|Argus TV (former ForTheRecord)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:DVBLink PVR Client|DVBLink PVR Client]] Addon backend client maintained and available from Kodi's community
** [[Add-on:DVBViewer Client|DVBViewer Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:MediaPortal PVR Client|MediaPortal PVR Client]] Addon backend client maintained and available from Kodi's community
** [[Add-on:PVR.WMC|WMC (Windows Media Center)]] PVR Addon backend client maintained and available from Kodi's community
* Added support for allowing skins and resource addons to be activated via info dialog
* Added support for disabling auto-updates per addon from the info panel dialog
* Added automatic dependency handling for binary addons
* Improved add-on update and rollback support by adding ability to choose only a specific repo
* Improved capabilities for downgrading of addons by supporting multiple versions in same repository
* Improved bootstrap buildsystem for binary addons to support arbitrary meta repositories
* Improved the ability to [http://github.com/xbmc/xbmc/pull/901 extend Kodi's native Python API by writing C++ code generated] via [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 Groovy] and [http://en.wikipedia.org/wiki/Groovy_%28programming_language%29 SWIG]
* Updated the Groovy (code generator) library to 2.4.4
* Moved some binary (RSXS) Screensavers and Audio Visualizations (Vis) to addons
* Moved the addon rollback feature to the update dialog and list all available versions there
* Updated GUI ABI version 15 as minimum setting any skin before Kodi 15.0 (Isengard) as incompatible
* Update guilib ABI (for libgui) to version 5.10.0
* Changed saving of skin settings which are now stored as separate files
* Added support for Animated GIF images to loadable for any kind of textures, e.g. Posters and FanArt
* Added support for image resource addons (as example weather icons, weather fanart, studio logos, and genre icons)
* Added support for sound resource addons (skin effect sounds for button clicks, transitions, etc.)
* Added new dialogs for managning and settings for digital sound processing addons (Audio DSP plugins)
* Added new dialog to display RDS Radio information under PVR windows
* Added option for skinners to add a timeshift indicator to the Video OSD for Live TV
* Added skinning support to enable editing of user-ratings from skins frontend
* Added support of <depth> tag for stereoscopic (3D) effect for controls to GUI engine for skins
* Added stereoscopic (3D) depth support for the Confluence skin
* Added the use of image resource addons for updating weather fanart images in Confluence
* Added 'Events' to the Confluence homescreen 'System' submenu
* Added EPG to search results window (add to PVR search results window in Confluence)
* Added new infolabel that can be used to display fanart for moviesets inside a movie set
* Added new infolabels that can display audio/subtitle properties for all available streams
* Added new infolabels for displaying user ratings
* Added support for skins to use a lightweight font
* Added toggle switch to visually mark dirty regions to help skinners optimize and troubleshoot skins
* Added support for sortby and sortorder attributes to the <content> element
* Added ability in guilib to visualize control hitrects when tagged
* Added option to conditionally include files to allow skinners to conditionally include a file
* Added option for skins to show separate icons for empty and full DVD-ROM drives
* Added support for specifying the image scaling algorithm for image resizing/caching
* Added new on-screen keyboard layouts for; Chinese, Korean, English QWERTZ, Czech QWERTZ and QWERTY
* Updated keyboard layout for some languages and added a new keyboard layouts for a few languages
* Improved default quality setting of image scaling algorithm for image resizing/caching
* Improved skinning PVR section by reduceing amount of dialogs and simplify skinning Live TV and EPG windows
* Improved skin reloading in case theme/color/font is not default
* Improved touch and gesture support for all platforms, and also improved the default touch screen skin ([[Add-on:Re-Touched|Re-Touched]])
* Removed skin XML files for Karaoke support as the feature has been removed from Kodi's core
* Removed native TvTunes support from Confluence since they changed into a paid-only service
* Added support for lossless software decode of DTS-HD tracks/streams in videos using libdcadec
* Added support to utilize pixel aspect ratio from SAR (Storage Aspect Ratio) tags in MKV containers
* Improved Stereoscopic 3D playback with video playlist switching when playlists have 2D and 3D videos
* Improved and enhanced Blu-ray support (including updated libbluray dependecies)
* Upgraded FFmpeg multimedia codec and demux libraries to stable branch release version [http://www.ffmpeg.org/download.html#release_2.8.5 FFmpeg 2.8.5]
* Removed certain audio codecs from core and made them into audio decoder and audio encoder add-ons
* Unified the music library and files view (similar to how its done in video library already)
* Added option for for user ratings of video items and editing userratings from the GUI frontend
* Added support for set overview (plot) in movie sets in the video library
* Added setting for to not group movies into a movie set in the video library if it contains a single item
* Added event logging which among others shows which files did not get added to library
* Added genre to television series episode view in the video library
* Added support for Audio and Subtitle Track Count to Smart Playlist selections in the video library
* Added support to sort by top albums by play count in the music library
* Added support for sorting dynamic directory listings from content
* Added a FFmpeg tag loader that can read additional metadata from more media containers
* Added support to use the new FFmpeg tag loader for reading tags from .DSP files
* Added support to use the new FFmpeg tag loader for reading tags from .MKA files
* Added support for the MusicBrainz "ARTISTS" tag in id3v2, ape, xiph for music files
* Added ability to fetch season year from video database based on first aired episode
* Updated music, movies, tv shows, and music video scrapers for Kodi
* Added initial support for [http://forum.kodi.tv/forumdisplay.php?fid=235 Audio DSP] (Digital Signal Processing) plugins and addons for Kodi's [[AudioEngine]]
* Improved the default cross-platform event driven active state machine pattern [[AudioEngine#ActiveAE|ActiveAE]] (Kodi's [[AudioEngine]])
* Improved ALSA sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop and generic Linux based Embedded Systems
* Improved PulseAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop
* Improved OSS (Open Sound System) sink for [[AudioEngine#ActiveAE|ActiveAE]] for BSD, like FreeBSD and similar BSD Unix based systems
* Improved AUDIOTRACK sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Amlogic]]
* Improved Pi Audio sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Raspberry Pi]]
* Improved DirectSound sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Improved WASAPI sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Improved CoreAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for (Mac) OS X and iOS
* Improved Darwin sink for [[AudioEngine#ActiveAE|ActiveAE]] for (Mac) OS X and iOS
* Added initial support for AirPlay from iOS 9 music streaming capability
* Added own lists for audio, subtitle and sub download languages
* Added ability to open the SmartPlayListEditor for a given playlist
* Added "long-press" support to extend the functionality of a single button on a remote control
* Improved code stability and performance as well as general code clean-up in many core areas
* Improved the the integrated UPnP / DNLA Media Server and Client
* Improved AirPlay compatibility suppor for iOS 8 (via updated libshairplay)
* Improved Kodi's JSON-RPC API
* Improved [[CEC|HDMI CEC (Consumer Electronics Control)]] support for [http://libcec.pulse-eight.com/ Pulse-Eight's LibCEC]
* Updated community maintained translations to over 60+ languages to date for Kodi via [[Translation System|Transifex Translation System]]
* Updated critical dependency libraries such as openssl, gnutls, and CMake (used to compile binary addons)
* Removed support for the current karaoke implmenetation from the core as it was not being maintained
* Added experimental pass-through support for Dolby Digital (AC3) audio
* Added experimental pass-through support for Dolby TrueHD audio (if supported by underlying hardware & firmware)
* Added experimental pass-through support for DTS audio
* Added experimental pass-through support for DTS-HD Master Audio (if supported by underlying hardware & firmware)
* Added software decode support of Dolby Digital Plus (DD+/E-AC3/EC-3) to PCM audio output
* Added proper implementation of Surface Rendering going thru EGL for video decoded with Android's MediaCodec API
* Added proper implementation of handling MEDIA keys support on Android
* Improved MediaCodec API video decoding implementations support for Android 4.2 (API level 17) and later
* Improved automatic refresh rate switching support for video playback on Android 5.0 and later (>= API 21), inc. Android TV
* Improved support for UltraHD decoding / 4K resolution output when HW supports it
* Improved playback of HEVC, VC-1 / WMV 9, and VP9 hardware video decoding when using Android's MediaCodec API
* Improved display of other Android apps while browsing these under Kodi as application launcher
* Improved audio output by decouple Kodi and system volume which removes double audio volume slider
* Improved touch-screen keymapping for Android based platforms for better gesture support
* Improved [http://en.wikipedia.org/wiki/ARM_architecture#Advanced_SIMD_.28NEON.29 NEON (Advanced SIMD instruction set)] CPU acceleration support for ARM architecture
* Removed support for hardware video decoding via Android StageFright library (libstagefright)
* Improved Kodi support for [http://en.wikipedia.org/wiki/Berkeley_Software_Distribution BSD (operating system)] on FreeBSD, PC-BSD, and other similar BSD platforms
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration (requires VDPAU compatible hardware and drivers)
* Added multi-touch support, and improved touch and gesture support on Linux
* Added support for HEVC hardware video decoding via [[wikipedia:VAAPI|VAAPI]] API when the VPU and drivers supports it
* Added support for HEVC hardware video decoding via [[wikipedia:VDPAU|VDPAU]] API when the VPU and drivers supports
* Improved rendering GUI (including OSD) at a different resolution than video playback plane
* Improved automatic refresh rate switching support for video playback
* Improved EGL rendering on Amlogic by implement 480cvbs/i/p and 576cvbs/i/p modes
* Improved SQLite file access performance on Raspberry Pi using MMAP acceleration
* Improved support for UltraHD decoding / 4K resolution output when hardware supports it
* Improved video accelerated decoding on [[Freescale|Freescale i.MX 6]] based devices
* Improved ARM processor architecture (using [[WeTek Play]] and [[Raspberry Pi]] as reference devices)
* Improved OpenGL ES and EGL support (using [[WeTek Play]] and [[Raspberry Pi]] as reference devices)
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration (requires VDPAU compatible hardware and drivers)
* Improved XvBA (AMD/ATI) Hardware Video Acceleration (requires XvBA compatible hardware and drivers)
* Improved OpenMAX Video Acceleration API support for Linux (using Raspberry Pi as reference hardware)
* Improved dedicated AMLCodec hardware accelerated video decoding support for Linux on [[Amlogic]] devices
* Improved AMD/Intel x86-64 64-bit (AMD64 / IA-64t CPU architectures) support under Linux
* Added support for iOS 9.0 by adding support for compiling Kodi with Xcode 7 IDE and iOS SDK 9.0
* Moved to iOS 8.4 SDK and Xcode 6.4 IDE as default which added support for iOS 8.4
* Improved Apple VDADecoder Video Acceleration support for iOS (on iPad, iPhone, and iPod iDevices)
* Improved touch and gesture support for iOS based iDevice platforms (iPad, iPod, and iPhone)
* Removed support for compiling Apple TV 2 builds
* Removed iOS 5.1 (iPad 1) compatiibility as it was required to add iOS 9
* Improved Apple VDADecoder Video Acceleration support for (Mac) OS X
* Added support for compiling Kodi with Xcode 7 IDE and OS X 10.11 SDK
* Updated the whole rendering system on Microsoft Windows platforms to DirectX 11 and Direct3D 11 native support
* Added support for caching font vertices on GPU side (requires Windows 8 and DirectX 11 device drivers)
* Added support for hardware based Stereoscopic 3D (requires Windows 8 and DirectX 11 device drivers)
* Added support for interleaved Stereoscopic 3D mode on Windows platforms (requires DirectX 11 device drivers)
* Added support for checkerboard Stereoscopic 3D mode on Windows platforms (requires DirectX 11 device drivers)
* Improved DXVA/DXVA2 rendering and decoding on Windows (when using DirectX 11 device drivers)
* Improved support for HEVC hardware video decoding via DXVA on Windows when hardware and driver supports exist
* ?
|
|
|-
| style="white-space:nowrap; background:salmon;"| 17.0<br />17.1<br />17.2<br />17.3<br />17.4<br />17.5<br />17.6
| 5 February 2017<br />23 March 2017<br />21 May 2017<br />24 May 2017<br />22 August 2017<br />24 October 2017<br />15 November 2017
| Krypton
|
{{main| Kodi v17 (Krypton) changelog |Krypton API changes}}
|
|-
| style="white-space:nowrap; background:#a0e75a;"| 18.0
| 29 January 2019
| Leia
|
{{main| Kodi v18 (Leia) changelog |Leia API changes}}
29 December 2017 - XBox One v18 Alpha released to Windows Store
|
|-
| style="white-space:nowrap; background:skyblue;"| 19.0
| TBA
| M***
|
|-
|}

== Codename history ==
{{see|Codename history}}

== References ==
<references/>

[[Category:Kodi]]
[[Category:Development]]