Official Kodi Wiki - User contributions [en]

Advancedsettings.xml

2026-05-27T18:49:16Z

Crystalp:

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

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

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>


<maxcommbreaklength>250</maxcommbreaklength>


<mincommbreaklength>90</mincommbreaklength>


<maxcommbreakgap>120</maxcommbreakgap>


<commbreakautowait>0</commbreakautowait>


<commbreakautowind>0</commbreakautowind>


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

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

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

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

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


<useisodates>false</useisodates> 


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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

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

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

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

== File system settings ==

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

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

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

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

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== GUI rendering settings ==

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

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

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

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

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

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

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

=== smartredraw ===

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

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

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= References =
<references />

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

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

Advancedsettings.xml

2026-05-27T18:48:32Z

Crystalp: update maxtempo description

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

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

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>


<maxcommbreaklength>250</maxcommbreaklength>


<mincommbreaklength>90</mincommbreaklength>


<maxcommbreakgap>120</maxcommbreakgap>


<commbreakautowait>0</commbreakautowait>


<commbreakautowind>0</commbreakautowind>


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

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

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

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

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


<useisodates>false</useisodates> 


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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

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

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

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

== File system settings ==

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

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

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

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

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== GUI rendering settings ==

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

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

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

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

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

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

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

=== smartredraw ===

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

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

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= References =
<references />

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

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

InfoLabels

2026-05-16T17:33:27Z

Crystalp:

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

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

=== Addon ===

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

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

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

=== Control ===

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

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

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

=== Game ===

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

=== ListItem ===

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

=== MusicPartyMode ===

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

=== Network ===

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

=== Player labels ===

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

==== Music player ====

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

==== Video player ====

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

=== Playlist ===

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

=== PVR ===

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

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

=== Skin ===

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

=== Slideshow ===

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

=== System ===

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

=== Visualisation ===

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

=== Weather labels ===

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

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

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

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

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

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

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

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

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

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

<section end="main content" />

{{top}}

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

InfoLabels

2026-05-16T17:32:16Z

Crystalp: DTS audio codec code is dts for v22 and up. deprecated dca.

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

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

=== Addon ===

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

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

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

=== Control ===

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

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

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

=== Game ===

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

=== ListItem ===

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

=== MusicPartyMode ===

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

=== Network ===

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

=== Player labels ===

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

==== Music player ====

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

==== Video player ====

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

=== Playlist ===

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

=== PVR ===

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

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

=== Skin ===

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

=== Slideshow ===

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

=== System ===

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

=== Visualisation ===

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

=== Weather labels ===

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

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

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

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

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

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

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

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

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

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

<section end="main content" />

{{top}}

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

MySQL/Setting up MySQL

2026-04-08T16:52:02Z

Crystalp:

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

'''Version Requirements'''

Recommended:<br />
The latest LTS (long term support) versions of MySQL or MariaDB, for continuing support and regular bug/security fixes.<br />
They were MySQL 8.4.x and MariaDB 11.8.x at the time of writing.

Minimum:

{|class="prettytable"
! Kodi version !! MySQL version !! MariaDB version
|-
| style="width:200px; text-align:left;" | Up to v21 - Omega
| style="width:200px; text-align:center;" | 5.6
| style="width:200px; text-align:center;" | 5.5
|-
| style="width:200px;" | v22 - Piers (and above)
| style="width:200px; text-align:center;" | 5.7.9
| style="width:200px; text-align:center;"" | 10.2.5
|}

MySQL/MariaDB can be installed on just about every major OS and NAS:

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the official MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD=YOUR_MARIADB_ROOT_PASSWORD
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=1
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

On first run this will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{updated|22}}

MySQL/Setting up MySQL

2026-04-08T16:30:51Z

Crystalp: Must assign some value to the env variable MARIADB_AUTO_UPGRADE for the MariaDB docker to auto upgrade with major releases

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

'''Version Requirements'''

Recommended:<br />
The latest LTS (long term support) versions of MySQL or MariaDB, for continuing support and regular bug/security fixes.<br />
They were MySQL 8.4.x and MariaDB 11.8.x at the time of writing.

Minimum:

{|class="prettytable"
! Kodi version !! MySQL version !! MariaDB version
|-
| style="width:200px; text-align:left;" | Up to v21 - Omega
| style="width:200px; text-align:center;" | 5.6
| style="width:200px; text-align:center;" | 5.5
|-
| style="width:200px;" | v22 - Piers (and above)
| style="width:200px; text-align:center;" | 5.7.9
| style="width:200px; text-align:center;"" | 10.2.5
|}

MySQL/MariaDB can be installed on just about every major OS and NAS:

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the offical MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD=YOUR_MARIADB_ROOT_PASSWORD
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=1
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

This will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{updated|22}}

MySQL/Setting up MySQL

2026-04-08T16:09:21Z

Crystalp: include the current MySQL and MariaDB LTS versions

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

'''Version Requirements'''

Recommended:<br />
The latest LTS (long term support) versions of MySQL or MariaDB, for continuing support and regular bug/security fixes.<br />
They were MySQL 8.4.x and MariaDB 11.8.x at the time of writing.

Minimum:

{|class="prettytable"
! Kodi version !! MySQL version !! MariaDB version
|-
| style="width:200px; text-align:left;" | Up to v21 - Omega
| style="width:200px; text-align:center;" | 5.6
| style="width:200px; text-align:center;" | 5.5
|-
| style="width:200px;" | v22 - Piers (and above)
| style="width:200px; text-align:center;" | 5.7.9
| style="width:200px; text-align:center;"" | 10.2.5
|}

MySQL/MariaDB can be installed on just about every major OS and NAS:

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the offical MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD=YOUR_MARIADB_ROOT_PASSWORD
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

This will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{updated|22}}

MySQL/Setting up MySQL

2026-04-08T12:45:59Z

Crystalp: mark the page "updated to v22"

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

'''Version Requirements'''

The latest LTS (long term support) versions of MySQL or MariaDB are recommended for the continuing support and regular bug/security fixes.<br />
The minimum requirements are:

{|class="prettytable"
! Kodi version !! MySQL version !! MariaDB version
|-
| style="width:200px; text-align:left;" | Up to v21 - Omega
| style="width:200px; text-align:center;" | 5.6
| style="width:200px; text-align:center;" | 5.5
|-
| style="width:200px;" | v22 - Piers (and above)
| style="width:200px; text-align:center;" | 5.7.9
| style="width:200px; text-align:center;"" | 10.2.5
|}

MySQL/MariaDB can be installed on just about every major OS and NAS:

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the offical MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD=YOUR_MARIADB_ROOT_PASSWORD
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

This will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{updated|22}}

MySQL/Setting up MySQL

2026-04-08T12:43:43Z

Crystalp: mysql/mariadb version requirements

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

'''Version Requirements'''

The latest LTS (long term support) versions of MySQL or MariaDB are recommended for the continuing support and regular bug/security fixes.<br />
The minimum requirements are:

{|class="prettytable"
! Kodi version !! MySQL version !! MariaDB version
|-
| style="width:200px; text-align:left;" | Up to v21 - Omega
| style="width:200px; text-align:center;" | 5.6
| style="width:200px; text-align:center;" | 5.5
|-
| style="width:200px;" | v22 - Piers (and above)
| style="width:200px; text-align:center;" | 5.7.9
| style="width:200px; text-align:center;"" | 10.2.5
|}

MySQL/MariaDB can be installed on just about every major OS and NAS:

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the offical MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD=YOUR_MARIADB_ROOT_PASSWORD
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

This will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{Isengard updated}}

Advancedsettings.xml

2026-01-23T21:01:03Z

Crystalp: Remove database option enforcessl, see PR 27724

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

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

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>


<maxcommbreaklength>250</maxcommbreaklength>


<mincommbreaklength>90</mincommbreaklength>


<maxcommbreakgap>120</maxcommbreakgap>


<commbreakautowait>0</commbreakautowait>


<commbreakautowind>0</commbreakautowind>


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

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

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

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


<useisodates>false</useisodates> 


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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

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

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

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

== File system settings ==

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

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

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

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

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== GUI rendering settings ==

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

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

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

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

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

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

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

=== smartredraw ===

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

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

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= References =
<references />

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

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

Subtitles

2026-01-11T03:47:53Z

Crystalp: clarify that bcp 47 support is new with v22

{{mininav|[[Video library]] {{l2| [[Settings]] }}|[[Video playback]] {{l2| [[Settings/Player|Player]] }} }}
<section begin="intro" />Kodi supports both stand-alone subtitle and embedded subtitles. Most major subtitle formats are supported. Kodi can also search and download subtitles directly from full screen playback. <section end="intro" />

== Supported formats ==

Text-based subtitle formats supported:
* SubRip/SRT
* VPlayer
* SAMI
* MPL2
* MicroDVD
* SubStation Alpha (or Sub Station Alpha) known as SSA/ASS
* Closed caption EIA-608/EIA-708
* Timed text/TX3G
* WebVTT {{note|New on Kodi 20}}

Image-based subtitle formats supported:
* VobSub (idx/sub)
* PGS (Presentation Graphic Stream Subtitle)
* SUP (Subtitle bitmap image of DVD and Blu-ray)

== Changing subtitle settings during playback ==
[[File:Estuary-OSD-video-subtitle-selection.png|500px|right|thumb|The audio options are found under the gear icon.]]
{{main|Video playback}}
Various subtitle settings can be changed or they turned On/Off (default is on) via the [[Video_playback#Video_Player_OSD|OSD (On Screen Display)]] while watching a movie by selecting the subtitle menu or audio options.

{{note|To make Kodi '''turn off''' subtitles by default: While playing a video, bring up the on screen display and select the audio options -> Turn off "subtitles" -> scroll down and select "save as default for all videos".}}
{{-}}

=== Settings details ===
[[File:Video Playback OSD 04.jpg|right|500px]]
{{#lst:Video playback|OSD subs}}

== Additional settings ==

=== Main settings ===
{{See also|Settings/Player/Language#Subtitles}}

=== Adjusting subtitles position ===
The position of the subtitles can be adjusted vertically (but not horizontally) in the [[Settings/System/Display#Calibration|Video Calibration]] screen, you can also configure the way that they are displayed though the [[Settings/Player/Language#Subtitles|Subtitles Settings]].<br />
'''Note:''' This does not apply to DVD subtitles as the DVD itself defines their location.

=== Adjusting brightness of HDR subtitles ===
Over-bright subtitles can be adjusted using the ''GUI peak luminance in HDR PQ mode'' setting.<br>
See: '''[[Settings/System/Display#GUI_peak_luminance_in_HDR_PQ_mode| GUI peak luminance in HDR PQ mode]]'''

== Subtitle downloader ==
{{Main|HOW-TO:Set_up_subtitle_services}}

* <code>ActivateWindow(subtitlesearch)</code> can be bound to a remote button using [[keymaps]] in order to quickly bring up the subtitle search window.

== Manually downloaded external subtitle files ==
To use stand-alone subtitle files with video files, put them in the same folder as the video file or alternatively go to the [[Settings/Player/Language#Download_Services|Subtitles Settings]] and set a Custom Subtitle Directory. You can also choose to manually browse for the subtitle file via the [[Video_playback#Video_Player_OSD|OSD (On Screen Display)]]. You can configure the way that they are displayed through the [[Settings/Player/Language#Subtitles|Subtitles Settings]], and you can adjust where they are displayed onscreen through the [[Settings/System/Display#Calibration|Video Calibration Screen]].

The subtitle and video files must have the same name, for example:
'''Video File:''' The Matrix.avi
'''Subtitle:''' The Matrix.srt

=== Compressed subtitles ===
Kodi also supports compressed VobSub subtitles. Please note that the subtitles inside the [http://en.wikipedia.org/wiki/Rar RAR] archive still need to have the same name as the video file and requires the rar add-on being installed: See: [[Add-on:RAR_archive_support|RAR archive support]].
'''Video File:''' The Matrix.avi
'''Subtitle:''' The Matrix.rar
Where The Matrix.rar containins the VobSub-file ''The Matrix.sub'' and the ''The Matrix.idx'' VobSub index-file that has been compressed with [http://en.wikipedia.org/wiki/Rar RAR].
If you want Kodi to automatically turn on packed subtitles, you have to turn on the '''Search for Subtitles in RARs''' option in [[Settings/Player/Language#Subtitles|Subtitles Settings]].

=== Using multi language subtitles ===
Kodi supports the use of more than one external subtitle. This of course is most useful when you have more than one subtitle file, (eg. for more than language).

To use this functionality you need to rename the subtitle files as <movie name>.<language>.<subtitle extension>.<br>
The language piece can be an ISO 639-1 or ISO 639-2 code, a BCP 47 tag (with - characters replaced with _) or the English name of a language.<br>
{{note|support for BCP 47 tags is new with Kodi 22}}

For example:

'''Video File:''' The Matrix.avi
'''Subtitle 1:''' The Matrix.English.srt
'''Subtitle 2:''' The Matrix.fr.srt
'''Subtitle 3:''' The Matrix.zh_yue.srt

<br />

You can even mix subtitle formats, eg:

'''Video File:''' Movie Name (2006).avi
'''Subtitle 1:''' Movie Name (2006).Chinese.idx
'''Subtitle 1:''' Movie Name (2006).Chinese.sub
'''Subtitle 2:''' Movie Name (2006).Japanese.idx
'''Subtitle 2:''' Movie Name (2006).Japanese.sub
'''Subtitle 3:''' Movie Name (2006).English.srt
'''Subtitle 4:''' Movie Name (2006).French.smi
'''Subtitle 5:''' Movie Name (2006).German.ssa

It works basically the same for using [[External audio tracks|manually downloaded external audio track files]].

== Advanced options ==

=== Adding fonts ===
You can add additional fonts to add support for your language and to customise your style. Your additional fonts can be stored in the Kodi folder at <code>Kodi/media/Fonts/</code>.

The supported font format type is TTF {{note|On Kodi 20 - Add support for OTF font type}}.

{{note|On Kodi 20 - Please note that each time you add or remove fonts you will have to restart Kodi, to allow the font cache to be rebuilt and show fonts in the settings.}}

For additional info see '''media''' section on [[Kodi_data_folder]] page.

=== Increasing the delay range for subtitle adjustment ===
{{main|advancedsettings.xml}}
If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. Kodi uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.

# Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is ".xml" and '''not''' ".txt" or ".xml.txt".
# Cut and paste this into your new plain text file:
#: <syntaxhighlight lang=xml enclose="div">
<advancedsettings>
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 
</video>
</advancedsettings>
</syntaxhighlight>
# Change the two values between the tags to fit your situation.
# Save this file in your '''[[Userdata|userdata folder]]'''
#: ''If you have an existing file, make sure the <video></video> tags, and settings we'll add between them, are between the main <advancedsettings></advancedsettings> tags.''

=== Using Forced Subtitles ===
Many movies have subtitles encoded for secondary languages spoken during the film – when these are added to the movie, they are known as forced subtitles and are always visible (despite not being hard encoded). Kodi (since v13 Gotham) recognizes and respects the forced flag for showing subtitles (even if subtitles are turned off by default, the forced flag will trigger them being turned on). This requires that the user have set the default languages in Settings in order to function properly. If there are multiple forced subtitles, Kodi will select the forced subtitles that match the default playback language.

; Internal Forced Subtitles
If you are using an .mkv file, the forced subtitles may be included in the file when originally encoded. If so, Kodi will automatically recognize that they are present and will display them at the appropriate times. If they are not included, or if the header was not properly edited, you will need to use external subtitles.

; External Forced Subtitles
If you are using anything other than an .mkv file, or if your mkv doesn’t have the forced subtitles properly included, the forced flag can be easily added to your external subtitles. Following the same naming conventions listed above, you can then append the forced flag to the end of the subtitle file name. The forced flag can be either upper, lower or mixed case in the filename and can use a “.” (dot), “ “ (space) or “-“ (dash) to separate them from the name of the movie and language of the subtitles. IE:
<syntaxhighlight lang=xml enclose="div">
Movie Name (2006).English.Forced.srt
Movie Name (2006).en.forced.srt
Movie Name (2006).German.Forced.srt
Movie Name (2006)-Swedish-Forced.srt
</syntaxhighlight>

= References =
{{github_link|[https://github.com/xbmc/xbmc/blob/master/xbmc/cores/VideoPlayer/VideoPlayer.cpp#L94 Requirements to load subtitles]}}

{{updated|17}}

[[Category:Video library]]
[[Category:Manual]]
[[Category:Subtitles|*]]

Subtitles

2026-01-11T03:44:50Z

Crystalp: ext sub languages can be more than full English names

{{mininav|[[Video library]] {{l2| [[Settings]] }}|[[Video playback]] {{l2| [[Settings/Player|Player]] }} }}
<section begin="intro" />Kodi supports both stand-alone subtitle and embedded subtitles. Most major subtitle formats are supported. Kodi can also search and download subtitles directly from full screen playback. <section end="intro" />

== Supported formats ==

Text-based subtitle formats supported:
* SubRip/SRT
* VPlayer
* SAMI
* MPL2
* MicroDVD
* SubStation Alpha (or Sub Station Alpha) known as SSA/ASS
* Closed caption EIA-608/EIA-708
* Timed text/TX3G
* WebVTT {{note|New on Kodi 20}}

Image-based subtitle formats supported:
* VobSub (idx/sub)
* PGS (Presentation Graphic Stream Subtitle)
* SUP (Subtitle bitmap image of DVD and Blu-ray)

== Changing subtitle settings during playback ==
[[File:Estuary-OSD-video-subtitle-selection.png|500px|right|thumb|The audio options are found under the gear icon.]]
{{main|Video playback}}
Various subtitle settings can be changed or they turned On/Off (default is on) via the [[Video_playback#Video_Player_OSD|OSD (On Screen Display)]] while watching a movie by selecting the subtitle menu or audio options.

{{note|To make Kodi '''turn off''' subtitles by default: While playing a video, bring up the on screen display and select the audio options -> Turn off "subtitles" -> scroll down and select "save as default for all videos".}}
{{-}}

=== Settings details ===
[[File:Video Playback OSD 04.jpg|right|500px]]
{{#lst:Video playback|OSD subs}}

== Additional settings ==

=== Main settings ===
{{See also|Settings/Player/Language#Subtitles}}

=== Adjusting subtitles position ===
The position of the subtitles can be adjusted vertically (but not horizontally) in the [[Settings/System/Display#Calibration|Video Calibration]] screen, you can also configure the way that they are displayed though the [[Settings/Player/Language#Subtitles|Subtitles Settings]].<br />
'''Note:''' This does not apply to DVD subtitles as the DVD itself defines their location.

=== Adjusting brightness of HDR subtitles ===
Over-bright subtitles can be adjusted using the ''GUI peak luminance in HDR PQ mode'' setting.<br>
See: '''[[Settings/System/Display#GUI_peak_luminance_in_HDR_PQ_mode| GUI peak luminance in HDR PQ mode]]'''

== Subtitle downloader ==
{{Main|HOW-TO:Set_up_subtitle_services}}

* <code>ActivateWindow(subtitlesearch)</code> can be bound to a remote button using [[keymaps]] in order to quickly bring up the subtitle search window.

== Manually downloaded external subtitle files ==
To use stand-alone subtitle files with video files, put them in the same folder as the video file or alternatively go to the [[Settings/Player/Language#Download_Services|Subtitles Settings]] and set a Custom Subtitle Directory. You can also choose to manually browse for the subtitle file via the [[Video_playback#Video_Player_OSD|OSD (On Screen Display)]]. You can configure the way that they are displayed through the [[Settings/Player/Language#Subtitles|Subtitles Settings]], and you can adjust where they are displayed onscreen through the [[Settings/System/Display#Calibration|Video Calibration Screen]].

The subtitle and video files must have the same name, for example:
'''Video File:''' The Matrix.avi
'''Subtitle:''' The Matrix.srt

=== Compressed subtitles ===
Kodi also supports compressed VobSub subtitles. Please note that the subtitles inside the [http://en.wikipedia.org/wiki/Rar RAR] archive still need to have the same name as the video file and requires the rar add-on being installed: See: [[Add-on:RAR_archive_support|RAR archive support]].
'''Video File:''' The Matrix.avi
'''Subtitle:''' The Matrix.rar
Where The Matrix.rar containins the VobSub-file ''The Matrix.sub'' and the ''The Matrix.idx'' VobSub index-file that has been compressed with [http://en.wikipedia.org/wiki/Rar RAR].
If you want Kodi to automatically turn on packed subtitles, you have to turn on the '''Search for Subtitles in RARs''' option in [[Settings/Player/Language#Subtitles|Subtitles Settings]].

=== Using multi language subtitles ===
Kodi supports the use of more than one external subtitle. This of course is most useful when you have more than one subtitle file, (eg. for more than language).

To use this functionality you need to rename the subtitle files as <movie name>.<language>.<subtitle extension>.<br>
The language piece can be an ISO 639-1 or ISO 639-2 code, a BCP 47 tag (with - characters replaced with _) or the English name of a language.<br>
For example:

'''Video File:''' The Matrix.avi
'''Subtitle 1:''' The Matrix.English.srt
'''Subtitle 2:''' The Matrix.fr.srt
'''Subtitle 3:''' The Matrix.zh_yue.srt

<br />

You can even mix subtitle formats, eg:

'''Video File:''' Movie Name (2006).avi
'''Subtitle 1:''' Movie Name (2006).Chinese.idx
'''Subtitle 1:''' Movie Name (2006).Chinese.sub
'''Subtitle 2:''' Movie Name (2006).Japanese.idx
'''Subtitle 2:''' Movie Name (2006).Japanese.sub
'''Subtitle 3:''' Movie Name (2006).English.srt
'''Subtitle 4:''' Movie Name (2006).French.smi
'''Subtitle 5:''' Movie Name (2006).German.ssa

It works basically the same for using [[External audio tracks|manually downloaded external audio track files]].

== Advanced options ==

=== Adding fonts ===
You can add additional fonts to add support for your language and to customise your style. Your additional fonts can be stored in the Kodi folder at <code>Kodi/media/Fonts/</code>.

The supported font format type is TTF {{note|On Kodi 20 - Add support for OTF font type}}.

{{note|On Kodi 20 - Please note that each time you add or remove fonts you will have to restart Kodi, to allow the font cache to be rebuilt and show fonts in the settings.}}

For additional info see '''media''' section on [[Kodi_data_folder]] page.

=== Increasing the delay range for subtitle adjustment ===
{{main|advancedsettings.xml}}
If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. Kodi uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.

# Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is ".xml" and '''not''' ".txt" or ".xml.txt".
# Cut and paste this into your new plain text file:
#: <syntaxhighlight lang=xml enclose="div">
<advancedsettings>
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 
</video>
</advancedsettings>
</syntaxhighlight>
# Change the two values between the tags to fit your situation.
# Save this file in your '''[[Userdata|userdata folder]]'''
#: ''If you have an existing file, make sure the <video></video> tags, and settings we'll add between them, are between the main <advancedsettings></advancedsettings> tags.''

=== Using Forced Subtitles ===
Many movies have subtitles encoded for secondary languages spoken during the film – when these are added to the movie, they are known as forced subtitles and are always visible (despite not being hard encoded). Kodi (since v13 Gotham) recognizes and respects the forced flag for showing subtitles (even if subtitles are turned off by default, the forced flag will trigger them being turned on). This requires that the user have set the default languages in Settings in order to function properly. If there are multiple forced subtitles, Kodi will select the forced subtitles that match the default playback language.

; Internal Forced Subtitles
If you are using an .mkv file, the forced subtitles may be included in the file when originally encoded. If so, Kodi will automatically recognize that they are present and will display them at the appropriate times. If they are not included, or if the header was not properly edited, you will need to use external subtitles.

; External Forced Subtitles
If you are using anything other than an .mkv file, or if your mkv doesn’t have the forced subtitles properly included, the forced flag can be easily added to your external subtitles. Following the same naming conventions listed above, you can then append the forced flag to the end of the subtitle file name. The forced flag can be either upper, lower or mixed case in the filename and can use a “.” (dot), “ “ (space) or “-“ (dash) to separate them from the name of the movie and language of the subtitles. IE:
<syntaxhighlight lang=xml enclose="div">
Movie Name (2006).English.Forced.srt
Movie Name (2006).en.forced.srt
Movie Name (2006).German.Forced.srt
Movie Name (2006)-Swedish-Forced.srt
</syntaxhighlight>

= References =
{{github_link|[https://github.com/xbmc/xbmc/blob/master/xbmc/cores/VideoPlayer/VideoPlayer.cpp#L94 Requirements to load subtitles]}}

{{updated|17}}

[[Category:Video library]]
[[Category:Manual]]
[[Category:Subtitles|*]]

NFO files/Movies

2026-01-11T03:21:55Z

Crystalp: Add originallanguage

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files to be scraped into the movie library are relatively simple and require only a single nfo file per title.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

There are two naming schemes for movie nfo files. Both are explained and {{kodi}} recommends using the ''<VideoFileName>.nfo'' format.

<section begin="MovieNFONaming" />;<VideoFileName>.nfo
:*NFO Files are named the same as the video file except with the ''.nfo'' extension.
:*We recommend using this filename format to name nfo files.

;movie.nfo
:{{Kodi}} may also scan nfo files named '''''movie.nfo'''''. To use this name, the setting '''Movies are in separate folders that match the movie title''' must be '''Enabled''' in the '''[[Adding_video_sources#Set_Content|Set Content Screen]]'''
:*If the above setting is not enabled, {{kodi}} will ignore the ''movie.nfo''. If the ''<VideoFileName>.nfo'' file is available, {{kodi}} will scan this one instead, otherwise an online scrape will be performed if a valid scraper is set for the Source.
:*If you use ''movie.nfo'' and later Export your library to Separate Files, {{kodi}} will still create the nfo file in the ''<VideoFileName>.nfo'' format and two nfo files will exist. If a Refresh or rescan is run in future, and the above setting is still enabled, the ''<VideoFileName>.nfo'' file will be ignored in favour of ''movie.nfo'', which means any changes you may have made to the library entry (play counts, watched status etc) will not be re-scanned back into the library.
:*We recommend using the ''<VideoFileName>.nfo'' format for nfo files to avoid the above traps.<section end="MovieNFONaming" />

The below image details naming and location for Single File, DVD and Bluray movies:

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalMovieArtwork01.jpg|'''''Example of correct use of Movie Folder with artwork, nfo file, trailer and theme.<br> Take note of file naming and location.'''''
</gallery>

= nfo Tags =
The following table lists available XML tags. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

The "Required" column indicates whether a tag can be optionally added or ommitted when creating the nfo to suit your purpose. The less tags used, the less information added to the library.

{|class="prettytable"
! width=430px | NFO (xml) Tag || Required || Multiple || Notes
|-
|<movie></movie> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title for the movie
|-
|<originaltitle></originaltitle> || No || No || Displays the original title of the movie. <br>
For example, if the scraper is set to german language and the scraped movie in german is "Der mit dem Wolf tanzt" the original title will be "Dances with Wolves"
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying movie title. Not displayed in any library listing. See: ''[[Movie_sets#Sort_Title|Sort Title]]''
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or omit the default attribute<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="themoviedb" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250 movies
|-
|<outline></outline> || || || Should be short, will be displayed on a single line (scraped from IMDB only)
|-
|<plot></plot> || || || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short movie slogan. "The true story of a real fake" is the tagline for "Catch me if you can"
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="" preview=""></thumb> || No || Yes || Path to available Movie Posters. Not needed when using local artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="discart"
:<thumb aspect="keyart"
:<thumb aspect="landscape"
:<thumb aspect="poster"
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available movie fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country certification flags
|-
|<playcount></playcount> || No || No || Number of times movie has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date last played as ''yyyy-mm-dd''
|-
|<id></id> || No || No || The default ID. <br>
Do not use. This is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Movie genre.
|-
|<tag></tag> || No || Yes || Library Tags. See...'''[[Video library tags]]'''
|-
|
<set>
<name></name>
<overview></overview>
</set>
|| No || No || Movie set tags <br />
The <overview> tag allows a short summary of the movie set. It can be displayed by some skins.
<br />See... '''[[Movie sets]]'''
|-
|<country></country> || No || Yes || Country of origin
|-
|<credits></credits> || No || Yes || Field for writers.
|-
|<director></director> || No || Yes || Movie Director
|-
|<premiered></premiered> || No || No || Release date of movie. Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not used
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to movie trailer<br> Do not add local path to trailer. {{kodi}} will automatically scan for local trailers.<br> See... '''[[Trailers]]'''
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
<hdrtype></hdrtype>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
|| No || Yes || Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref><br><br>

Accepted values for <hdrtype></hdrtype> are:
* empty = SDR;
* hdr10;
* dolbyvision;
* hlg
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
|-
|<showlink></showlink> || No || No || Connect movie to TV Show. Use the TV Show <title></title> name.
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Movie resume point in Seconds<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|-
|<originallanguage></originallanguage> || No || No || Main spoken language of the movie (import: ISO 639-1, 639-2, BCP 47 or English language name. export: BCP 47)<br>
example uses:<br>
:<originallanguage>fr</originallanguage>
:<originallanguage>fr-CA</originallanguage>
:<originallanguage>French</originallanguage>
Added in Kodi v22
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/TV shows

2026-01-11T03:21:47Z

Crystalp: Add originallanguage

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.

= episodeguide URL =
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider.

Due to an issue where the UniqueID for TV shows and movies across TV Maze, TMDB and TheTVDB are '''not''' unique, the episode guide was converted to a JSON format which clearly identified which site the UniqueID belongs to.

These changes have been incorporated into v19 and later releases of {{kodi}}. [https://forum.kodi.tv/showthread.php?tid=370489 Read more here]

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>

= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<tvshow></tvshow> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan (added in v22)
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not used for locally saved artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags<br>
Not used for locally saved artwork
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
{"tmdb": "76479", "imdb": "tt1190634", "tvdb": "355567"}
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above.<br>
For v19 and later, a JSON format is used. ''[https://forum.kodi.tv/showthread.php?tid=370489 Read more here]''<br>
TVDB scraper uses TheTVDB v4 API<br>
Other providers: ''"tvmaze":'' and ''"tvrage":''
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Continuing or Ended show
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to TV Show trailer
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons. eg:<br>
<namedseason number="1">Season 1: The Maze</namedseason>
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|-
|<seasonplot number=""></seasonplot> || No || Yes || Plot of a season. Can contain more information on multiple lines, will be wrapped. ex:<br>
<seasonplot number="1">Plot of the season</seasonplot>
Added in Kodi v22.
|-
|<originallanguage></originallanguage> || No || No || Main spoken language of the show (import: ISO 639-1, 639-2, BCP 47 or English language name. export: BCP 47)<br>
example uses:<br>
:<originallanguage>fr</originallanguage>
:<originallanguage>fr-CA</originallanguage>
:<originallanguage>French</originallanguage>
Added in Kodi v22
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Video library]]

Databases/MyVideos

2026-01-11T03:08:07Z

Crystalp: Add originalLanguage field to movies tvshows movie_view tvshow_view

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|originalLanguage || text || Main spoken language of the show (added in v22)
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|originalLanguage || text || Main spoken language of the show (added in v22)
|-
|tagline || text || Show tagline (added in v22)
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo, actor or videoversion|| || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|-
|originalLanguage || text || Main spoken language of the movie (added in v22) || <originallanguage></originallanguage>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|-
|originalLanguage || text || Main spoken language of the show (added in v22) || <originallanguage></originallanguage>
|-
|tagline || text || Show tagline (added in v22) || <tagline></tagline>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the relations between media "parents" (movies, episodes, ...) and their video assets (versions, extras) for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || The video asset. Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || id of the media
|-
|media_type || text || The type of media this asset is linked with (v21: the only supported value is "movie")
|-
|itemType || integer || Type of video asset. 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Name of the video asset. Foreign key to the [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

NFO files/TV shows

2026-01-11T02:27:17Z

Crystalp: Add seasonplot

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.

= episodeguide URL =
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider.

Due to an issue where the UniqueID for TV shows and movies across TV Maze, TMDB and TheTVDB are '''not''' unique, the episode guide was converted to a JSON format which clearly identified which site the UniqueID belongs to.

These changes have been incorporated into v19 and later releases of {{kodi}}. [https://forum.kodi.tv/showthread.php?tid=370489 Read more here]

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>

= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<tvshow></tvshow> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan (added in v22)
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not used for locally saved artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags<br>
Not used for locally saved artwork
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
{"tmdb": "76479", "imdb": "tt1190634", "tvdb": "355567"}
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above.<br>
For v19 and later, a JSON format is used. ''[https://forum.kodi.tv/showthread.php?tid=370489 Read more here]''<br>
TVDB scraper uses TheTVDB v4 API<br>
Other providers: ''"tvmaze":'' and ''"tvrage":''
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Continuing or Ended show
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to TV Show trailer
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons. eg:<br>
<namedseason number="1">Season 1: The Maze</namedseason>
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|-
|<seasonplot number=""></seasonplot> || No || Yes || Plot of a season. Can contain more information on multiple lines, will be wrapped. ex:<br>
<seasonplot number="1">Plot of the season</seasonplot> <br>
Added in Kodi v22.
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/TV shows

2026-01-11T01:26:54Z

Crystalp: clarify that tv show tagline is functional only from v22. For some reason the tag was already in the documentation but the tag was not functional yet.

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.

= episodeguide URL =
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider.

Due to an issue where the UniqueID for TV shows and movies across TV Maze, TMDB and TheTVDB are '''not''' unique, the episode guide was converted to a JSON format which clearly identified which site the UniqueID belongs to.

These changes have been incorporated into v19 and later releases of {{kodi}}. [https://forum.kodi.tv/showthread.php?tid=370489 Read more here]

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>

= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.

{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|<tvshow></tvshow> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan (added in v22)
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not used for locally saved artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags<br>
Not used for locally saved artwork
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
{"tmdb": "76479", "imdb": "tt1190634", "tvdb": "355567"}
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above.<br>
For v19 and later, a JSON format is used. ''[https://forum.kodi.tv/showthread.php?tid=370489 Read more here]''<br>
TVDB scraper uses TheTVDB v4 API<br>
Other providers: ''"tvmaze":'' and ''"tvrage":''
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Continuing or Ended show
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to TV Show trailer
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons. eg:<br>
<namedseason number="1">Season 1: The Maze</namedseason>
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Video library]]

Databases/MyVideos

2026-01-11T01:23:56Z

Crystalp: Clarify tvshow tagline is available from v22

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|tagline || text || Show tagline (added in v22)
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo, actor or videoversion|| || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|-
|tagline || text || Show tagline (added in v22) || <tagline></tagline>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the relations between media "parents" (movies, episodes, ...) and their video assets (versions, extras) for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || The video asset. Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || id of the media
|-
|media_type || text || The type of media this asset is linked with (v21: the only supported value is "movie")
|-
|itemType || integer || Type of video asset. 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Name of the video asset. Foreign key to the [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

Databases/MyVideos

2026-01-11T01:20:15Z

Crystalp: Add tagline field to tvshow and tvshow_view

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|tagline || text || Show tagline
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo, actor or videoversion|| || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|-
|tagline || text || Show tagline || <tagline></tagline>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the relations between media "parents" (movies, episodes, ...) and their video assets (versions, extras) for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || The video asset. Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || id of the media
|-
|media_type || text || The type of media this asset is linked with (v21: the only supported value is "movie")
|-
|itemType || integer || Type of video asset. 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Name of the video asset. Foreign key to the [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

Advancedsettings.xml

2026-01-07T04:03:01Z

Crystalp: updated for PR 27649

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>


<maxcommbreaklength>250</maxcommbreaklength>


<mincommbreaklength>90</mincommbreaklength>


<maxcommbreakgap>120</maxcommbreakgap>


<commbreakautowait>0</commbreakautowait>


<commbreakautowind>0</commbreakautowind>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>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>
.001 .3g2 .3gp .asf .asx .avc .avi .avs .bdm .bdmv .bin .bivx .dat .divx .dv .dvr-ms .evo .fli .flv .f4v
.h264 .ifo .img .iso .m2t .m2ts .m2v .m3u .m3u8 .m4v .mkv .mk3d .mov .mp4 .mpd .mpeg .mpg .mpl .mpls .mts
.nrg .nsv .nuv .ogm .ogv .pls .pva .pxml .qt .rcv .rec .rm .rmvb .rss .sdp .strm .svq3 .tp .trp .ts .ty
.url .udf .vc1 .vdr .viv .vob .vp3 .webm .wmv .wpl .wtv .xsp .xspf .xvid .zip
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==
To prevent the resizing of artwork add the following two tags and values to your advancedsettings.xml file. More details on each tag follows in the next sections.
<syntaxhighlight lang=xml enclose="div">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

<syntaxhighlight lang=xml enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached fanart]] should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.<section end="fanartres description" />

<syntaxhighlight lang=xml enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for music, video, TV, and EPG databases.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of kodi's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as Kodi is concerned) paths. Use this for mysql only.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;<port>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
:by default "MyVideos"+DB number will be used.
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.
* mysql: defines the name of the database to use

;<user>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<connecttimeout> [https://github.com/xbmc/xbmc/pull/26657]
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines a connect timeout, in seconds. Default value is 5 seconds.

;<compression>
: ''Optional'' - Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}

;<key>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<cert>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ca>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<capath>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ciphers>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<enforcessl> [https://github.com/xbmc/xbmc/pull/27649]
: ''Optional''
* sqlite3: silently ignored
* mysql: Defines whether connecting with SSL will be attempted first (see MySQL/MariaDB option MYSQL_OPT_SSL_ENFORCE). Default value: false

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>kodi_video</name>
<user>kodi</user>
<pass>kodi</pass>
<connecttimeout>3</connecttimeout>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang=xml enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
</musicdatabase>
</syntaxhighlight>

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.aac .ac3 .aif .aiff .ape .cmc .cmr .cue .dmc .dff .dsf .dsp .dts .dtshd .flac .gcm .gdm .idsp .imf
.m15 .m3u .m4a .m4b .mac .mka .mp+ .mp2 .mp3 .mpa .mpc .mpd .mpdsp .mpp .mpt .mss .nsv .oga .ogg .opus
.pls .pxml .rm .rma .rmt .rsd .rss .sap .sfx .shn .spt .strm .tak .tm2 .tm8 .tmc .tta .uni .url
.waa .wam .wav .wma .wpl .wtv .wv .wvs .xsp .xspf .xwav .zip
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang=xml enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang=xml enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang=xml enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<recentlyaddeditems>35</recentlyaddeditems> 

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

<albumformat>%B - %Y</albumformat> 

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>


<useisodates>false</useisodates> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[Add-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<fronttobackrendering>true</fronttobackrendering>
</gui>
</syntaxhighlight>

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

* true: on '''(Default)'''
* false: off

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]
[[Category:Karellen]]

Portable mode

2025-10-19T02:46:13Z

Crystalp:

{{mininav|[[Installing]] }}

= Introduction =
{{kodi}} can be installed as a portable application ''(portable install or portable mode)'' on MS Windows and, with caveats, on macOS. Other platforms do not support portable installations.

= MS Windows =
[[File:Portable01.jpg|300px|right]]
<section begin="PortableMode" />If you have a requirement to run a different version of Kodi or multiple of the same version without removing your current installation, Kodi has the ability to run in portable mode.

Follow these steps to install additional Kodi setups on the same computer.

# Download required version of Kodi and run the Installation
# During the installation process you will be prompted to specify the install location. This must be changed from the default location offered. Install to...
#* A removable USB device, or
#* Another folder or hard drive on your computer where standard users have write permission (e.g. ''not'' under Program Files)
# '''Once the Install has finished do not run Kodi''' until the remainder of these steps have been completed.
# Navigate to where you just installed Kodi and look for the file '''''kodi.exe'''''
# Create a shortcut to kodi.exe. Usually by right clicking on the kodi.exe file and selecting ''Send to'' then ''desktop (create shortcut)''
# Right click on the newly created shortcut and select ''Properties''. In ''Target:'', add the switch ''-p'' after kodi.exe i.e. '''"E:\Kodi\kodi.exe" -p''' and save the change (see image)
# Go to your start menu and locate the newly created entry for your portable install (it will be under new name you gave the install). Right click on the Kodi shortcut there (do not run it!), select properties and make the same -p change as above. '''Note''': In some cases an entry may not be created here. If you intend to only use the shortcut created in the previous step, this step can be skipped.<ref>https://forum.kodi.tv/showthread.php?tid=360927&pid=3029136#pid3029136</ref>
# Start Kodi (via either the shortcut or the newly modified start menu entry). This will create a '''portable_data''' folder within the portable installation folder. This folder is the equivelant of the '''[[Kodi data folder]]''' created in standard installations.

'''Note''': It is this shortcut that enables Portable Mode. If you create another shortcut and fail to add the '''-p''' switch, or start this portable version of {{kodi}} in another manner, then the standard userdata folder will be created which may overwrite your existing installation of {{Kodi}}.<section end="PortableMode" />

; Location of [[Kodi data folder]]
: When using Portable Mode, the location of the ''[[Kodi data folder]]'' is moved into the portable installation folder and named '''portable_data'''
: Using the image example, the Kodi data folder will be located in '''''E:\Kodi v18\portable_data'''''
{{-}}

Since Kodi v22, multiple portable installations in different data directories can run simultaneously.

= macOS =
{{warning|Portable mode is recommended for testing/development on macOS by advanced users only. During updates, app bundles will replace the entire existing bundle, and any portable data will be lost.}}

osX 10.6.2 introduced the ability to provide arguments using '''''open''''' to execute an application bundle. This feature has been added to {{kodi}} v19- Matrix.<ref>https://github.com/xbmc/xbmc/pull/17788</ref>

In a terminal window execute the following command
<syntaxhighlight lang="xml">
open <location_to_app_bundle>/Kodi.app --args -p
</syntaxhighlight>

= References =
<References />

{{top}}
{{updated|20}}
[[Category:Karellen]]
[[Category:Installation]]

Portable mode

2025-10-19T02:42:10Z

Crystalp:

{{mininav|[[Installing]] }}

= Introduction =
{{kodi}} can be installed as a portable application ''(portable install or portable mode)'' on MS Windows and, with caveats, on macOS. Other platforms do not support portable installations.

= MS Windows =
[[File:Portable01.jpg|300px|right]]
<section begin="PortableMode" />If you have a requirement to run a different version of Kodi or multiple of the same version without removing your current installation, Kodi has the ability to run in portable mode.
Since Kodi v22, multiple portable installations in different data directories can run simultaneously.

Follow these steps to install additional Kodi setups on the same computer.

# Download required version of Kodi and run the Installation
# During the installation process you will be prompted to specify the install location. This must be changed from the default location offered. Install to...
#* A removable USB device, or
#* Another folder or hard drive on your computer where standard users have write permission (e.g. ''not'' under Program Files)
# '''Once the Install has finished do not run Kodi''' until the remainder of these steps have been completed.
# Navigate to where you just installed Kodi and look for the file '''''kodi.exe'''''
# Create a shortcut to kodi.exe. Usually by right clicking on the kodi.exe file and selecting ''Send to'' then ''desktop (create shortcut)''
# Right click on the newly created shortcut and select ''Properties''. In ''Target:'', add the switch ''-p'' after kodi.exe i.e. '''"E:\Kodi\kodi.exe" -p''' and save the change (see image)
# Go to your start menu and locate the newly created entry for your portable install (it will be under new name you gave the install). Right click on the Kodi shortcut there (do not run it!), select properties and make the same -p change as above. '''Note''': In some cases an entry may not be created here. If you intend to only use the shortcut created in the previous step, this step can be skipped.<ref>https://forum.kodi.tv/showthread.php?tid=360927&pid=3029136#pid3029136</ref>
# Start Kodi (via either the shortcut or the newly modified start menu entry). This will create a '''portable_data''' folder within the portable installation folder. This folder is the equivelant of the '''[[Kodi data folder]]''' created in standard installations.

'''Note''': It is this shortcut that enables Portable Mode. If you create another shortcut and fail to add the '''-p''' switch, or start this portable version of {{kodi}} in another manner, then the standard userdata folder will be created which may overwrite your existing installation of {{Kodi}}.<section end="PortableMode" />

; Location of [[Kodi data folder]]
: When using Portable Mode, the location of the ''[[Kodi data folder]]'' is moved into the portable installation folder and named '''portable_data'''
: Using the image example, the Kodi data folder will be located in '''''E:\Kodi v18\portable_data'''''
{{-}}

= macOS =
{{warning|Portable mode is recommended for testing/development on macOS by advanced users only. During updates, app bundles will replace the entire existing bundle, and any portable data will be lost.}}

osX 10.6.2 introduced the ability to provide arguments using '''''open''''' to execute an application bundle. This feature has been added to {{kodi}} v19- Matrix.<ref>https://github.com/xbmc/xbmc/pull/17788</ref>

In a terminal window execute the following command
<syntaxhighlight lang="xml">
open <location_to_app_bundle>/Kodi.app --args -p
</syntaxhighlight>

= References =
<References />

{{top}}
{{updated|20}}
[[Category:Karellen]]
[[Category:Installation]]

Samples

2025-10-11T19:03:42Z

Crystalp: Removed U2 Live Performance Clip, which had lots of glitches (not only when played with Kodi so the clip is likely faulty).

{{mininav| [[Troubleshooting]] {{l2|[[Development builds]] }} }}

{{forum link2|1=Questions? Comments? See the ''[http://forum.kodi.tv/showthread.php?tid=248794 discussion thread]''}}

''List and links compiled and maintained by @ht2tweak. Last updated May 25, 2025''

Kodi users are demanding enthusiasts when it comes to media players with Kodi and having as-close-to-perfect video playback capabilities as possible. We expect most/all videos to play smoothly, in the proper mode, and w/o distracting artifacts such as stutters, frame skips, improper framerates, macroblocking, and audio drop-outs.

Below is a collection of a/v clips for testing, pushing media player capabilities. Not all types, but the most widely used or critical types for home theater enthusiasts. [[w:Fair use|Fair use]] is claimed on all non-[[w:copyleft|copyleft]] clips, as their the purpose is only for testing, technical evaluation, and documentation.

For any YouTube video, use [https://www.4kdownload.com/prUoducts/product-videodownloader 4K Video Downloader] or [https://jdownloader.org/download/ JDownloader2] to download and save.

==4K (UltraHD) & HDR Formats==
#[https://drive.google.com/file/d/0BwxFVkl63-lEY3l3ODJReDg3RzQ/view?usp=sharing&resourcekey=0-5kDw2QbFk9eLrWE1N9M1rQ H.264 29.97fps, 51Mbps] (MOV, ''@ht2tweak's'' iPhone 6S raw 4K footage)
#[https://www.youtube.com/watch?v=Ppz41EmaJyU H.264 30fps] (MP4, 4K Test Patterns) (YouTube) ''(thanks @hansolo)''
#[https://drive.google.com/file/d/0BwxFVkl63-lEdVBuZkltckdZZ0k/view?usp=sharing&resourcekey=0-k91iv2m3Plumc5jdKCbxdQ HEVC 10-bit 59.94fps] (Korean ATSC 3.0 satellite TV capture sample)
#[https://mega.nz/file/Sfw1hDpK#ErxCOpQDVjcI1gq6ZbX3vIfdtXZompkFe0jq47EhR2o HDR 10-bit HEVC 24fps] (MP4, 'Exodus' sample)
#[https://drive.google.com/file/d/0BwxFVkl63-lEdU9Ma0VYc3YxSVE/view?usp=sharing&resourcekey=0-FJsSx7fEhiVEtQMRwo_ePQ HDR 10-bit HEVC 25fps] (TS, Astra DVB satellite capture sample; no audio) ''(courtesy WeTek)''
#[https://mega.nz/file/aOIj3RgY#9YSI8ik27dsdUv0xE0eZ-GvVnemJ3cgzbDVd7ga_vjc HDR 10-bit HEVC 59.94fps] (MP4, Camp by Sony)
#[https://drive.google.com/file/d/1Ic9DZXMSo07EJMqCFaQRKSSrSw6y1mYv/view?usp=sharing HDR10 HEVC 59.94] (MOV, ''@ht2tweak's'' iPhone 11 Pro Max raw 4K footage using [https://apps.apple.com/us/app/4k-hdr-video-recorder/id1203170948 4K HDR Video Recorder app])
#[https://drive.google.com/u/0/uc?id=1Nz2MPf2FPz3A99ciBSAl3m0U0XBbV1bv&export=download HDR10+ Int'l Space Station Sample 24fps] (TS)
#[https://mega.nz/file/af4zSAbQ#gBiHRiX3oLnBvxMNnytC08v8DRkKzQIkhGpg96nAWXE HDR10+ Profile A HEVC 10-bit 23.976 Sample] (MKV with DTS:X audio)
#[https://mega.nz/file/nehDka6Z#C5_OPbSZkONdOp1jRmc09C9-viDc3zMj8ZHruHcWKyA HDR10+ Profile B HEVC 10-bit 23.976 Sample] (MKV with EAC-3 JOC ATMOS audio)
#[https://mega.nz/file/TPJn0CxT#hF1UvP733phr5QZs1ls1JUkh6eSRVc2cyyj1bMgacw4 HDR10+ Profile B HEVC 10-bit 23.976 Sample] (MKV with TrueHD ATMOS audio)
#[https://ff.de/hdr10plus-metadata-test/ HDR10+ Profile B Lake Dynamic Changes Test 60fps] (MP4)
#[https://mega.nz/file/2ew0DApT#UOEt2mrKYOHDak2TlgZSk6nQmJPckHntZvWHdfjVARY Hybrid HDR10/Dolby Vision Sample] (MKV with TrueHD ATMOS audio)
#[https://mega.nz/file/GaQ2AZRB#_CGi8bQ4-SVgLPLEtEGwWxO-b-W_sC6LL6z3dd4mDYs Hybrid HDR10+/Dolby Vision Sample] (MKV with TrueHD 5.1 audio)
#[https://drive.google.com/file/d/1Q_UljfzGRhLf2eDuvkJO6hAg1m5PtS8S/view?usp=drive_link Hybrid HDR10+/Dolby Vision 120fps Video Game Capture] (TS)
#[https://drive.google.com/file/d/1cTRNwacsV-8J8PtcYNVDXBmGZF1SOynj/view?usp=sharing Dolby Vision w/embedded HLG HEVC 59.94] (MOV, ''@hdmkv's'' iPhone 11 Pro Max raw 4K footage using [https://apps.apple.com/us/app/4k-hdr-video-recorder/id1203170948 4K HDR Video Recorder app])
#[https://img.photographyblog.com/reviews/apple_iphone_13_pro/sample_images/4K60p.mov Dolby Vision w/embedded HLG HEVC 60fps] (MOV, Photography Blog's iPhone 13 Pro raw 4K footage)
#[https://drive.google.com/file/d/0BwxFVkl63-lEc3k0aldZaGtaVm8/view?usp=sharing&resourcekey=0-ECypkFcgdKx1YiojpUCWBA Dolby Vision 10-bit HEVC 23.976fps] (TS, LG Comparison Demo) ''(thanks @soyhakan)''
#[https://drive.google.com/file/d/0BwxFVkl63-lEWmNWcGl4eVRWS2M/view?usp=sharing&resourcekey=0-WkmICjhK5yus4EAaPuSuSw Dolby Vision 10-bit HEVC 23.976fps] (TS, LG Trailer) ''(thanks @soyhakan)''
#[https://mega.nz/folder/aagzVbbT#WuxcI61oaTv8X3VA_T9_cg Dolby Vision FEL Test Samples] (check if your media player supports TV-led Full Enhancement Layer DV. With ''DV FEL All Layers Test'', you should see [https://discourse.coreelec.org/uploads/default/original/3X/9/7/97ba6658628c698efac4bae31a031c17b06db3bc.jpeg a woman appear at about 80 seconds in], and with the ''DV FEL Power Rangers Credits Test'', the font should be solid white, not faded gray) ([https://mega.nz/folder/drYRlALT#fbRfBAdVE88fmoLdXoAVJQ Additional test files here], and [https://drive.google.com/drive/u/1/folders/1yAq-jgsb8pYa92PnGZkxyEV0E3VVkhiC here])
#[https://drive.google.com/drive/folders/1qCyCTmhEVZjdY5O8gNVFna-nnkVQkhI_ HDR vs. Dolby Vision Looped Test Samples] (Over 80 comparison samples; [https://youtu.be/nGgW5ZDKfMM see how to test here]) ''(thanks @RESET_9999)''
#[https://mega.nz/file/2TYwVSTZ#LBh2CoX3QUfkR_kwey_aim9QWvwk3UpLQozEG9n2ww0 Dolby Vision Mystery Box (Profile 5)] (MP4)
#[https://drive.google.com/file/d/1-8C0ZYnIhEqOVJQ532hIJobP5XR6A7gj/view Dolby Vision Lake Dynamic Changes Test (Profile 8.1) 23.976fps] (MP4)
#[https://mega.nz/file/DGJU1BzL#4jtSK9Kvx2N6WuNdnQXyOi4NFEqLIymLrmSK5R8WilY Dolby Vision Color Accuracy Sample (Profile 7)] (assess proper color rendering, flesh tones)
#[https://www.demolandia.net/4k-video-test/dolby-vision/page-1.html Dolby Vision MP4 Samples] (hosted by Demolandia)
#[https://mega.nz/#F!aBAGBJBb!vGOiLiLo9HT7fBA1qww3-Q LG Dolby Vision Demo Clips] (change extension from .lge to .mkv after downloading)
#[https://mega.nz/file/eOQTXKQA#PCMDK-jzyPA1xGMUC0GSe4yHzVWdIlYxitB-OuRrC88 Dolby Vision Profile 10] (Dolby Vision in AV1)
#[https://mega.nz/file/OaAkQAAY#8vOIMPc_flcJDx6HMA_BnKPwnhKHZb0dPoImlOx9BGE Dolby Vision Profile 20] (3D MVC Dolby Vision, presently only playable on Vision Apple Vision Pro VR)
#[https://www.youtube.com/watch?v=s6zR2T9vn2c VP9] (YouTube)
#[https://mega.nz/#!pQEGgRwY!pD9whIlM-U9tJIA-LojxSt582BAZGfdSA5wAQLT06I4 VP9 Profile 2 HDR 24fps] The Redwoods (MKV) ''(thanks @wesk05)''
#[https://mega.nz/#!hJdFEIBI!uSOjZtkkjIVYSfqD9aSfONf1yq__uQvlsf47pCtFvdQ VP9 Profile 2 HDR 59.94fps] The World in HDR (MKV) ''(thanks @wesk05)''
#[https://storage.googleapis.com/downloads.webmproject.org/vp9/decoder-test-streams/HDR10%2B_Sample_Video.webm VP9 Profile 2 HDR10+ 29.97fps] (WEBM)
#[https://upload.wikimedia.org/wikipedia/commons/1/1e/First_8K_Video_from_Space_-_Ultra_HD_VP9.webm VP9 8K ISS NASA Clip 29.976fps] (WEBM)
#[https://storage.googleapis.com/media.webmproject.org/devsite/vp9/hdr-encoding/strobe_scientist.mkv ProRes HDR DCI-P3] Strobe Scientist (MKV)
#[https://www.youtube.com/watch?v=GsTKEQzLkmw AV1 23.976] Bruce Springsteen Nightshift Music Video
#[https://mega.nz/file/GShnVJxS#PQWSfOsd5L3nMq1WBIRkvnKDW8uYRGibDjK9UFzwNrI AV1 24fps HDR] Jolt Clip
#[https://www.youtube.com/watch?v=i82xURPkLWo AV1 59.940] Gemini Man Clip
#[https://www.youtube.com/watch?v=LXb3EKWsInQ AV1 59.940 HDR] Costa Rica
#[https://mega.nz/file/aPBiACoT#A3BqP2CXQrTguj-K82qWO4jrTft1w1UDFn2oEfES-FE AV1 23.976 Dolby Vision (Profile 10)] Documentary sample (similar to #28 above)
#[https://mega.nz/file/OLpynJqa#poa_ABib_vlyFlD7cIfExpqVZK4nNFSZDCTaesqeGoY AV1 23.976 HDR10+ Clip]
#[https://www.youtube.com/watch?v=CHSnz0bCaUk AV1 8K 60fps HDR] Alaska
#[https://www.youtube.com/watch?v=a_kza3_ubQ4 AV1 12K 60fps HDR] Deepest Blacks

==3D Formats==
#[https://drive.google.com/file/d/0BwxFVkl63-lEd2c0ekxfbFd3Tmc/view?usp=sharing&resourcekey=0-xPh7W5aHnTo4SNN790Lscg 3D MVC ISO Sample #1] (1080p/23.976)
#[https://drive.google.com/file/d/0BwxFVkl63-lEM2xjQndxV3ZzaVE/view?usp=sharing&resourcekey=0-ugbr-4FiuVyADmYOK_oXoQ 3D MVC ISO Sample #2 with 3D Subtitles] (1080p/23.976)
#[https://drive.google.com/file/d/0BwxFVkl63-lEMkJTV21JNnhfNlE/view?usp=sharing&resourcekey=0--B5KIzJq8TkuruFtWZy0Ig 3D MVC ISO Sample #3 for Pop-out & Depth Evaluation] (1080p/23.976)
#[https://drive.google.com/file/d/0BwxFVkl63-lEWmRyc0YwUExxX0U/view?usp=sharing&resourcekey=0-JS17Gxnro9jCG_3sY_kXcg 3D MVC ISO Sample #4 for Proper Lip-synch & Clean Render Check] (1080p/23.976)
#[https://mega.nz/#!8BcClSRb!Jd48Bfc-8DjGvr7upqDVaDz5RdRI1xdR0PQ1-kZIAsI 3D MVC Resolution Pattern] (1080p/23.976) ''(Per @wesk05 (thanks), pay attention to the alphabets and the vertical & horizontal bars. If you see gray lines in the vertical resolution boxes, it's an indication that either the playing device or the display is not showing full 1080p resolution in 3D mode)''
#[https://thedigitaltheater.com/avatar-the-way-of-water-2022/ 'Avatar: The Way of the Water' 3D ISO & SBS Trailers]
#[https://we.tl/GVI7OpbcYU 3D MVC ISO Barco Stinger Trailer] (1080p/24)
#[https://we.tl/LirYPMi3Y7 3D MVC ISO Dolby 3D Glasses Return Clip] (1080p/24)
#[https://drive.google.com/file/d/0BwxFVkl63-lETWMzM1dRZF9XMDA/view?usp=sharing&resourcekey=0-RgKV_-y3FZVwsvrsukuvfw 3D Immersive MVC Sample] (MKV @ 1080p/23.976)
#[https://drive.google.com/file/d/1hGOmRT8tDXaM9-KdAmD-f0IUP1OZBgZe/view?usp=sharing 3D MVC IMAX Countdown] (MKV @ 1080p/23.976 with DTS-HD MA 5.1)
#[https://mega.nz/file/eO5QmTxa#WgYpyzYqSkscLTLI3BztXCLbCo3h6ZAUyAgesNCMNLw 3D MVC DTS Paint Symphony] (MKV @ 1080p/23.976 with DTS-HD MA 7.1)
#[https://mega.nz/file/vT4U1LQC#jtJ0WC0hXWPRgobSeDTbC_-sOtIf2hu4oL1buwH2kDI 3D MVC LG Sports Pop-outs Reel] (MKV @ 1080p/23.976 with DTS-HD MA 5.1)
#[https://we.tl/t-SBSah1jIKx H(SBS) Alita Battle Angel Trailer (side-by-side)] (MKV @ 1080p/23.976)
#[https://mega.nz/file/nTwAAACA#hJEHtSVpzAfLg3A2J48I0_P8X-DQen5YC_fEpoRq3Xo F(SBS) Chickens Clip (full side-by-side)] (MKV @ 3840p/23.976)
#[https://mega.nz/file/nPBHyDZa#Ikb1ay31dJQsiL75ziDjLd5MI69r4xn3ns2usnRwvJQ F(SBS) Dinos Clip (full side-by-side)] (MKV @ 3840p/23.976)
#[https://drive.google.com/file/d/0BwxFVkl63-lET0czejJBVXJLSkE/view?usp=sharing&resourcekey=0-nN7dFCvZTmALjj3H_4G1uw H(TAB)/HOU (top-and-bottom/half-over-under)] (MKV @ 1080p/23.976)

==Codecs, Framerates, Skin Tones, Black-levels and Subtitles==
#[https://www.rtings.com/images/test-materials/2015/305_24p.mp4 RTINGS 24p Judder Test (H.264 1080p/24.000)] (MP4) ([https://i.rtings.com/images/reviews/ju6500/ju6500-24p-small.jpg this is failing], and [https://i.rtings.com/images/reviews/ju7100/ju7100-24p-small.jpg this is passing])
#[https://drive.google.com/file/d/0BwxFVkl63-lERkJRU003ZTd2VEk/view?usp=sharing&resourcekey=0-swC_jMVMd_EXmweT0tGKSg H.264 1080p/23.976] (MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lEdzlZZ2lCLTVLa2c/view?usp=sharing&resourcekey=0-iCq6zrc9whsrif4-Zvu0DQ H.264 1080p/24] (MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lEbFBzak1sbmU1N0E/view?usp=sharing&resourcekey=0-GOK3gZYAmP-ywn6T9zCDoQ H.264 1080i/25] (MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lEWDUzUVUtZEw4cDA/view?usp=sharing&resourcekey=0-xLf9zGIdfdibsOe8L5JWDg H.264 1080p/25] (MKV)
#[https://mega.nz/#!XI1yiKLA!rF4vweNo_xA7vpSzpLU-JctqfUGZN4vVU1m6WIJ5lT4 H.264 1080i/29.97 4:2:0@High 26Mbps] (C-Band satellite capture in MKV w/DTS-HD MA 2.0 audio, converted from E-AC3) ''(thanks @alanisrox69)''
#[https://drive.google.com/file/d/0BwxFVkl63-lEbVptTVZ2NENURHM/view?usp=sharing&resourcekey=0-ZkTnO85pBHyp7fYNMHGyjQ H.264 1080p/50] (MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lEUGZnR1JHUUU0WEk/view?usp=sharing&resourcekey=0-YrNv_pEiY4Ukaw_X5rckRw H.264 1080p/59.94] (MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lETTVtaVV0LUVRZ1k/view?usp=sharing&resourcekey=0-rQVL39j5O_oysqA4xOSefQ H.264 1080p/60] (MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lETFVpOWRVVGNfeEU/view?usp=sharing&resourcekey=0-e9HrVO61IGkoTc_GBMNbww VC-1 1080p/23.976] (MKV w/TrueHD 5.1 audio)
#[https://drive.google.com/file/d/0BwxFVkl63-lERnhlY1pHeW5wbjQ/view?usp=sharing&resourcekey=0-EZX7FzpNtVgz7U0lUDejfg VC-1 1080i/29.97] (MKV w/DTS-HD MA 5.1 audio)
#[https://mega.nz/file/SfYHyBoR#uSW0ifRybwGtyP_jDGrRvxywYzAaO5IeRx3teaEANh4 HEVC 1080p/59.94] (U.S. ATSC3.0 OTA capture w/EAC3 audio (converted from AC4), muxed into MKV)
#[https://drive.google.com/file/d/0BwxFVkl63-lETXlOa3hEMmVyZGM/view?usp=sharing&resourcekey=0-FG5JbjCsd8QduRhkZ2aT8A MPEG2 1080i/29.97] (U.S. ATSC1.0 OTA capture w/DD5.1 audio, muxed into MKV)
#[https://mega.nz/#!GJMAADTK!deabwHlqtw2I_ihoY6_0xnxT_1W_d3jpAjnANKRBAzE MPEG2 4:2:0@High 1080i/29.97 36Mbps] (C-Band satellite capture in TS w/DTS-HD MA 5.1 audio, converted from E-AC3) ''(thanks @alanisrox69 for #13-15)''
#[https://mega.nz/#!jREAxYgb!MtjBIh1oSJJBZgLT7AcdG88hGCFG-ak7pC2AyjrsaIQ MPEG2 4:2:0@High 720p/59.94 20Mbps] (C-Band satellite capture in TS)
#[https://mega.nz/#!c9dhAaKA!MG5Yi-MJNATE2_KqcnNJZCRKtTWvdjJP1NwG8Ggdw3E MPEG2 4:2:2@High 1080i/29.97 35Mbps] (C-Band satellite capture in TS w/DTS-HD MA 5.1 audio, converted from E-AC3) (many media players can't play this)
#[https://www.dropbox.com/sh/6iy4gxgsfn14opq/AAAK_L1M_NwZwBPb5IkEPh7Ga?dl=0 Hi10 Anime Samples] ''(thanks @Morien)''
#H.265 1080p (medium bitrate) Test #1 [https://drive.google.com/file/d/0B3-obtCH8dE8d04yQnY5ZkFJdVE/view?usp=sharing in ISO], and [https://drive.google.com/file/d/0B3-obtCH8dE8V0NXdi1Jd3NrNkk/view?usp=sharing in MKV] ''(thanks @Mike)''
#[https://drive.google.com/file/d/0BwxFVkl63-lEbWhqS284RkpNMXc/view?usp=sharing&resourcekey=0-QvcZotOvzcEttZqO0k-xCg 2D Forced Subtitles Sample #1 (SRT)]
#[https://drive.google.com/file/d/0BwxFVkl63-lEVEluSFZ4NlhpLUk/view?usp=sharing&resourcekey=0-jrRNAhII3KVOq5Qid60tCw 2D Forced Subtitles Sample #2 (PGS)]
#3D Subtitles (use clip #2 in '3D Test Clips' section above)
#[http://www.hifiandtheater.com/files/intimax-test.mkv Black Level Test #1 Sample] (evaluate quality of your display's blacks in SDR) (1080p MKV) ''(thanks @hifiandtheater.com)''
#[https://mega.nz/file/OaJnkSzb#sqR1bLb5IT7AXJS_o2SJQwXuNv4oRYsIDwMN6Ov1Hrs Black Level Test #2 Sample] (evaluate quality of your display's blacks in HDR) (4K MKV)
#[https://mega.nz/file/HPxljYjL#XgM3dltBT6COFjQmbagedqDa-GYIzG0ueb8_il2sbyE Black Level Test #3 Sample] (evaluate quality of your display's blacks in Dolby Vision) (4K MKV)
#[https://mega.nz/file/rHRTlYyK#EYBA8-cqAsjB9FmnjQntH1uL7sLNq5y_tmkReetO9GA Skin Tones Check 1080p] (MKV w/chapters for each image)
#[https://mega.nz/file/SXYH1TzS#QKjwl4QJdEMbTVHOVdI_hAykYC_G1zw9VAuNxu66o0o Skin Tones Check 4K SDR] (MKV w/chapters for each image)
#[https://www.diversifiedvideosolutions.com/dolby-vision.html Dolby Vision Test Pattern Suite]
#[https://mega.nz/file/raByiTib#Fje3cxhPb4NkBJ936KVQjPNdSwslGqiboa8IYb05t5Q Quick Brown Fox 4K Focus Test Image]

==High Bitrate Test Clips==
Media players should be able play 90Mbps (or better) smoothly, w/o stutters for full 1080p, and 140Mbps (or better) for full 4K

*[https://repo.jellyfin.org/archive/jellyfish/ Jellyfish, up to 400Mbps] (H.264 and H.265 HEVC MKV) ''(thanks @ScottAllyn01)''
*[https://repo.jellyfin.org/test-videos/ Jellyfin Test Videos in SDR, HDR & Dolby Vision] (H.264, HEVC & AV1 MP4's)
*[http://dl.ganjanetwork.ru/Files/Video%20Test%20Files/Bitrate/Birds/ Birds, up to 90Mbps] (H.264 MKV or M2TS)

==HD/object-based Audio Test Clips==
#[https://mega.nz/#!cM9VmBSL!mME5qULH2H5M24vLmjqfZZkaoUjY6RsrGPiw3ultMW0 Dolby Digital Plus (EAC3) 7.1] (M2TS @ 1080p/29.97) ''(thanks @wesk05)''
#[https://mega.nz/file/eGpUEADR#iqOQcWbIMijoUzuZgdKK0H3jhQKnem2VUXfDSxmTNqo Dolby Digital Plus (EAC3) 7.1 Channel Check] (MKV @ 1080p/29.97)
#[https://drive.google.com/file/d/1_Gc0v7glw5hGJ6l37En5YKDPnPSLR6HM/view?usp=sharing Enhanced AC3 with Joint Object Coding (EAC3-JOC) ATMOS Sample] (MKV @ 4K/23.976 HDR10)
#[https://drive.google.com/drive/folders/1s-Tyh0Ozbz03JdHuW1om4GifVskyogza?usp=drive_link Portals EAC3-JOC ATMOS Channel Check Renderer] ''(by AVSForum member ibanezjp)''
#[https://drive.google.com/drive/folders/1s-Tyh0Ozbz03JdHuW1om4GifVskyogza?usp=drive_link EAC3-JOC ATMOS Quick Channel Check] ''(by AVSForum member ibanezjp)''
#Dolby TrueHD 5.1 (use clip #10 in 'Codecs' section below)
#[https://mega.nz/file/GTpF2BYY#oPAC-1XJUp0iLSe0VRnfE4YLOWyucKB6iLJ1rR8UEsE Dolby TrueHD 7.1 Channel Check] (MKV @ 1080p/29.97)
#[https://mega.nz/file/7XAAkRwK#MdlZNP9diVAyJh1Hnrp7zTQk4AHSRs6ujuHoxGUG85A Dolby ATMOS 'Amaze' Demo] (M2TS @ 1080p/24)
#[https://drive.google.com/file/d/0BwxFVkl63-lENElIcC1xTnF2Yk0/view?usp=sharing&resourcekey=0-1_ByUhiruAwxfSNqW4ryAQ Dolby ATMOS 'Helicopter' Demo] (M2TS @ 1080p/29.97 with DD+ 7.1 secondary track)
#[https://www.demolandia.net/downloads.html?id=236762 Dolby ATMOS 'Audiosphere' Demo] (M2TS @ 1080p/24)
#[https://www.demolandia.net/downloads.html?id=52783232 Dolby ATMOS 'Silent' Demo] (M2TS @ 1080p/24)
#[https://drive.google.com/file/d/0BwxFVkl63-lEcU1ScWZuMjhpOXM/view?usp=sharing&resourcekey=0-Kw7GSvWtpTG5WNFXvJXxNw DTS-HD HRA 5.1] (MKV @ 1080p/23.976 VC-1)
#[https://mega.nz/file/KP4DDKDQ#Fz87dP9cJLvmKZsCFXwH5G5eJ6o0sryZtSVw5bWmfwY DTS-HD HRA 7.1] (MKV @ 1080p/29.97)
#[https://www.demolandia.net/downloads.html?id=30191483 DTS-HD MA 5.1 Channel Check] (MKV @ 1080p/23.976)
#[https://drive.google.com/file/d/1HyQE5eqvV8BewCdbR9Xq3jbh1eUX0zXN/view?usp=sharing DTS-HD MA 5.1 THX Deep Note Genesis] (MKV @ 2160p/24)
#[https://mega.nz/file/KaogwLiY#gs1Gpd3s65zPjLciE_hCoGb_zpIWlcVeslnNXnWgpMY DTS-HD MA 7.1 'Dredd' Audio Channel Check] (M2TS @ 1080p/23.976)
#[https://mega.nz/file/3f4RwBjQ#tBEzhz4vPsiIu9urMD0l49Fa2EjrSuK4Xi0gXifTju4 DTS:X 11-channel Object Emulator] (MKV @ 1080p/23.976)
#[https://mega.nz/file/6SAQ3IyT#U5t0luX15dSaKzLNu2rSb7AcuhZ-Vymss7sgRrDbSQ0 DTS:X 'Gravity' Demo] (MKV @ 1080p/23.976)
#[https://mega.nz/#!0NVhDIbY!D4Fte7Kb7728H9CRY3IVTHJ45ZwkCQiugdFS7pZCN_s DTS:X 'Movement' Demo] (M2TS @ 1080p/23.976) ''(thanks @wesk05)''
#[https://mega.nz/file/GOBTHIwK#Vrrwuj_i-K86Gk6CPtm9aC8iYXHn6Y8Gvqp1QkYywao DTS-UHD (DTS:X Profile 2 9.1 Channel Sample)] (MP4 @1080p/23.976) ''Made for streaming platforms, similar to #3-5 above, but no hardware/software appear to support it yet. Likely needs to make it into FFMPEG''
#[https://mega.nz/#!Rcl1ECiL!pzPT5LvMyYIoKbsm3HdMDi2vO6aPpE8gAjLsSTH1DZg LPCM 5.1] (MKV @ 1080p/23.976) ''(thanks @wesk05)''
#[https://drive.google.com/file/d/0BwxFVkl63-lEV2JjazFWQ05OSG8/view?usp=sharing&resourcekey=0-gZ3u3gtnO6cC4qw6dgg1nw LPCM 7.1] (MKV @ 1080p/23.976)
#[https://www2.iis.fraunhofer.de/AAC/multichannel.html AAC 5.1]
#[https://github.com/sfiera/flac-test-files FLAC 2.0 to 7.1 Test Files]
#[https://drive.google.com/file/d/1dWB93rzbd3tuHckQH8ZisnJd7NDgApoe/view?usp=sharing FLAC 5.1 and 7.1 audio-only samples]

==Resources for Additional Test Clips or Samples==
*[https://www.murideo.com/videos.html Murideo Test Patterns & Videos] (to test skin tones, resolution, etc.)
*[https://drive.google.com/drive/u/1/folders/1yAq-jgsb8pYa92PnGZkxyEV0E3VVkhiC 4K-8K Dolby Vision Samples & Test Clips] ''(hosted by Salty01 at AVSForum)''
*[https://www.avsforum.com/threads/2024-home-theater-demos-for-dolby-vision-atmos-dts-x-4k-uhd-and-video-games.3297254/ 2024 Home Theater Demos for Dolby Vision/Atmos, DTS:X, 4K UHD, and Video Games!] ''(managed by Sawtaytoes at AVSForum)''
*[https://hub.trinnov.com/trailers Trinnov 4K Dolby ATMOS & Auro-3D trailers]
*[https://www.demolandia.net Demolandia] (4K and 3D trailers trailers)
*[https://thedigitaltheater.com/ The Digital Theater] (several excellent ATMOS, 3D, IMAX, etc. trailers)
*[https://4kmedia.org/ 4K Media] (HDR, Dolby Vision, LG, Samsung, more trailers & clips)
*[https://lf-tk-sg.ibytedtos.com/obj/tcs-client-sg/resources/video_demo_hevc.html HEVC Samples]
*[https://dl.photoprism.app/samples/Formats/Video/ Photoprism's Samples Collection] (AV1, H.266, VP9 and various formats)
*[http://hdr4k.blogspot.com/ 4k2160psources] (LG, Samsung, Sony 4K HDR clips)
*[https://vimeo.com/showcase/6344460 Limelight Muskoka Dolby Vision] (showcase reel) (click on a clip's title, then Download button, then choose 'Original')
*[https://isovideo.com/SDR_to_HDR_Up_Conversion_Examples.php ISO Video] (HDR and HLG clips regraded from SDR sources)
*[https://download.blender.org/demo/movies/BBB/ Big Buck Bunny] (test suite with 2D, 3D and 4K clips)
*[http://www.cnx-software.com/2010/03/17/where-to-get-video-audio-and-image-samples/ CNXSoft's samples/links]
*[http://www.w6rz.net/ W6RZ MPEG2 clips]
*[https://www.koi-sama.net/files/hi10/ AVC High 10 Profile Anime Samples] ''(thanks @Morien)''
*[http://4ksamples.com/ 4Ksamples] (movie, sports, nature clips in 4K)
*[https://www.youtube.com/user/jacobschwarz/videos Jacob + Katie Schwarz: We See the World in 4K] (beautiful 4K nature videos) (YouTube)
*[https://www.youtube.com/user/aroundtheworld4k/videos Around the World 4K] (Cities worldwide in striking 4K) (YouTube)
*[https://www.youtube.com/channel/UCW35MLO96M_UVG7YzMt1I2A/videos Cities in 4K] (Similar to above) (YouTube)
*[https://www.youtube.com/channel/UC_3n6GTFuC4tTAojueLBTHg/playlists Manufacturer and other demos in 4K] (YouTube)
*[https://www.youtube.com/channel/UCve7_yAZHFNipzeAGBI5t9g/videos The HDR Channel] (YouTube)
*[https://www.youtube.com/channel/UC4CAxaO75mfkPr3GRiSGE_w/videos 8K World] (YouTube)
*[https://x265.com/hevc-video-files/ x265 HEVC Samples]
*[http://www.evosiastudios.com/category/portfolio/films/ Evosia Studios] (several beautiful 1080p to 4K films)
*[http://www.libde265.org/downloads-videos/ libde265] (1080p to maxed-out 4K samples) ''(thanks @Martijn)''
*[https://www.youtube.com/user/martinheck1/videos Timestorm Films] (4K to 8K videos)
*[http://samples.mplayerhq.hu/ MplayerHQ's library] (many clips)
*[https://www.pc-magazin.de/ratgeber/hdr-tv-testfilm-testbild-kostenlos-download-3195250.html PC-Magazin.de's Test Files/samples] (4K HDR and SDR test patterns with German descriptions)
*[https://tdarr.io/samples/ Tdarr Samples] (Over 2,000 240p-4K samples)

== Library samples ==
=== Fake movie library ===
:A zipped collection of 1,000 empty movie files, with NFO files, poster, and fanart for each entry. Various movies from different years, including sequels/sets, remakes, movies named the same but unrelated, various genres, and so on. Useful for testing things like library scanning speed, library navigation, filtering, etc.

:* https://www.dropbox.com/s/llciqryeqqk4t70/Test%20video%20library.zip?dl=0

=== Fake TVShow library ===
:A zipped collection of 1,273 empty tvshow files and various show artwork. Contains 20 popular TVShows.

:* https://github.com/zag2me/Kodi-Test-Sample-Media

=== Music library ===
: Just the one album for now but hope to increase this over time. It's a complete album in MP3 format, tagged with Musicbrainz Picard ID3v2.3 (ID3v1 ID3v2.3) with extra genre, comment and composer tags for testing. Coverart is also included as a folder.jpg file. The album is licensed "Attribution-ShareAlike 3.0 Unported Creative Commons license" by the artist. You can download or pay for the album here if you like it. http://hungrylucy.com/album/pulse-of-the-earth

:* https://www.dropbox.com/s/rk8ue5fs49v5pnm/Creative_Commons_Music.zip?dl=0

=== Fake Sports TV Show library ===
: Here is a fake sports TV show library for use with the Kodi sports scraper. It includes a number of sports folders broken down into seasons and then events. This should work nicely with the current Sports TV scraper on the Kodi forums.

:* https://www.thesportsdb.com/Sports_fake_video_files.zip

=== Homebrew Games and Game ROMs ===
: These are locations to find a number of freely licensed "homebrew" games for classic consoles and stand-alone games that can be downloaded for testing with Kodi's upcoming [[Games|RetroRlayer]] feature. They include some homebrew games for NES, SNES, and GameBoy emulators, as well as a few homebrew game titles, such as; Cannonball, xrick, ChaiLove games and Lutro games.

:* https://github.com/OpenEmu/OpenEmu-Update/tree/master/Homebrew
:* https://buildbot.libretro.com/assets/cores/

== See also ==
* [[Video levels and color space]]

[[Category:Troubleshooting]]

Smart playlists/Rules and groupings

2025-08-16T14:34:57Z

Crystalp:

{{:Smart_playlists/Contents}}
{{mininav|[[Playlists]] | [[Smart playlists]] }}

This page lists the available attributes and operators that can be used in Smart Playlist XSP files. What can be used is dependent on the playlist type and rules.

For a complete Master list see '''[https://github.com/xbmc/xbmc/blob/master/xbmc/playlists/SmartPlayList.cpp Smart Playlists on Github]'''

= Grouping =
Available fields for grouping. Availability depends upon the playlist type in use.

* none
* sets
* genres
* years
* actors
* directors
* writers
* studios
* countries
* artists
* albums
* tags
* originalyears

= Operators =
The operators available will depend on the selected <code>field</code>.

The <code>operator</code> attribute specifies the rule that should be used to match the parameter to the <code>field</code>. All matching is done case-insensitive. The allowed operators are:

{| class="prettytable" style="margin-right: 0;"
! <code>operator</code>
! Definition
|-
| contains
| True if the field contains the parameter as a substring
|-
| doesnotcontain
| True if the field does not contain the parameter as a substring
|-
| is
| True if the field matches the parameter exactly
|-
| isnot
| True if the field does not match the parameter exactly
|-
| startswith
| True if the start of the field matches the parameter
|-
| endswith
| True if the end of the field matches the parameter
|-
| lessthan
| True if the content of the field is less than the parameter
|-
| greaterthan
| True if the content of the field is greater than the parameter
|-
| after
| True if the content of the field comes after the parameter
|-
| before
| True if the content of the field comes before the parameter
|-
| inthelast
| True if the field falls in the last range specified by the parameter. Only applicable for a date field.
|-
| notinthelast
| True if the field does not fall in the last range specified by the parameter. Only applicable for a date field.
|}

= Fields =

== Songs ==

* Genre
* Source
* Album
* DiscTitle
* Artist
* AlbumArtist
* Title
* Year
* OrigYear
* Time
* TrackNumber
* Filename
* Path
* Playcount
* LastPlayed
* Rating
* UserRating (v22: 0=no rating)
* Comment
* Moods
* BPM
* SampleRate
* MusicBitRate
* NoOfChannels
* DateAdded
* DateModified
* DateNew

== Albums ==
* Genre
* Source
* Album
* DiscTitle
* TotalDiscs
* IsBoxset
* Artist
* AlbumArtist
* Year
* OrigYear
* AlbumDuration
* Review
* Themes
* Moods
* Styles
* Compilation
* AlbumType
* MusicLabel
* Rating
* UserRating (v22: 0=no rating)
* Playcount
* LastPlayed
* Path
* AlbumStatus
* DateAdded
* DateModified
* DateNew

== Artists ==
* Artist
* Source
* Genre
* Moods
* Styles
* Instruments
* Biography
* ArtistType
* Gender
* Disambiguation
* Born
* BandFormed
* Disbanded
* Died
* Role
* Path
* DateAdded
* DateModified
* DateNew

== TV Shows ==
* Title
* OriginalTitle
* Plot
* TvShowStatus
* Votes
* Rating
* UserRating (v22: 0=no rating)
* Year
* Genre
* Director
* Actor
* NumberOfEpisodes
* NumberOfWatchedEpisodes
* Playcount
* Path
* Studio
* MPAA
* DateAdded
* LastPlayed
* InProgress
* Tag

== Episodes ==
* Title
* TvShowTitle
* OriginalTitle
* Plot
* Votes
* Rating
* UserRating (v22: 0=no rating)
* Time
* Writer
* AirDate
* Playcount
* LastPlayed
* InProgress
* Genre
* Year // premiered
* Director
* Actor
* EpisodeNumber
* Season
* Filename
* Path
* Studio
* MPAA
* DateAdded
* Tag
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Movies ==
* Title
* OriginalTitle
* Plot
* PlotOutline
* Tagline
* Votes
* Rating
* UserRating (v22: 0=no rating)
* Time
* Writer
* Playcount
* LastPlayed
* InProgress
* Genre
* Country
* Year // premiered
* Director
* Actor
* MPAA
* Top250
* Studio
* Trailer
* Filename
* Path
* Set
* Tag
* DateAdded
* Has multiple versions (v22)
* Has extras (v22)
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Music Videos ==
* Title
* Genre
* Album
* Year
* Artist
* Filename
* Path
* Playcount
* LastPlayed
* Rating
* UserRating (v22: 0=no rating)
* Time
* Director
* Studio
* Plot
* Tag
* DateAdded
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Other ==
* Playlist
* VirtualFolder

{{top}}

{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

NFO files/Creating

2025-08-10T16:19:15Z

Crystalp: episode nfo were missing

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
<section begin="intro" />This page explains the various methods available to create NFO files.<section end="intro" />

For template and example NFO files, see... '''[[NFO_files/Templates|Templates and Samples]]'''

= Kodi Created nfo =
This option requires that your library has already been scraped with metadata.

Using the built in [[Import-export_library| Import & Export]] function of Kodi will export the existing library metadata into individual nfo files which are correctly created and saved.

This is useful if you have an existing library and would like to '''[[backup]]''' the library or to import the library into another {{kodi}} installation.

Using these exported NFO files, it is possible to edit the metadata and '''[[Updating_or_removing_videos#Individual_Refresh|Refresh]]''' the changes back into the library

:'''See: [[Import-export_library| Import & Export]]'''

= Manual Creation =
: '''See- [[NFO_files/Templates|Templates and Samples]]'''
NFO files can be created using a simple text editor such as Notepad in Windows, or the equivelant in other operating systems. There are dedicated code editors that can also be used. They will not provide the required {{kodi}} tags, but they will avoid glitches when saving the nfo file, which is commonly experienced with text editors.

Two common code editors that can be used:
*[https://notepad-plus-plus.org/ Notepad++]
*[https://code.visualstudio.com/ Visual Studio Code]

'''Structure of the nfo file''':

1. The file is saved as Unicode Transformation Format-8 (UTF-8). The first line of the file will contain the following...
:<syntaxhighlight lang=xml enclose="div"><?xml version="1.0" encoding="UTF-8" standalone="yes"?></syntaxhighlight>

2. The second line and the last line of the file contains the appropriate opening and closing tags for the class of media. Avaliable classes are...
:<syntaxhighlight lang=xml enclose="div"><movie></movie>, <tvshow></tvshow>, <episodedetails></episodedetails>, <artist></artist>, <album></album> and <musicvideo></musicvideo></syntaxhighlight>

3. Between the opening and closing category tags are the tags for the metadata. Each tag must have an opening tag and a closing tag. eg...
<div style="margin-left: 1.5em;">
<syntaxhighlight lang=xml enclose="div">
<title>Blade Runner 2049</title>

<title> = opening tag
Blade Runner 2049 = metadata
</title> = closing tag
</syntaxhighlight>
</div>

4. Available tags are listed in the appropriate Metadata NFO page.

5. Once created, the file is named as follows:
<section begin="NFOnaming" />
:{| class="prettytable"
|-
| Albums || '''''album.nfo'''''
|-
| Artists || '''''artist.nfo'''''
|-
| Episodes || '''''<'''{{red|VideoFileName}}'''>.nfo'''''
|-
| Movies<sup>note</sup> || '''''<'''{{red|VideoFileName}}'''>.nfo''''' or '''''movie.nfo'''''
|-
| Music Videos || '''''<'''{{red|MusicVideoFilename}}'''>.nfo'''''
|-
| TV Shows || '''''tvshow.nfo'''''
|}
<section end="NFOnaming" />
<div style="font-size: 0.8em; margin-left: 20pt;">
'''Note:'''
{{#lst:NFO_files/Movies|MovieNFONaming}}
</div>

= Media Managers =
Media Managers can create nfo files in one of three ways:
#Scraping- This is the same process as performed by the {{kodi}} scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file which then needs to be scanned into the library, unlike {{kodi}} that imports the metadata directly into the library.
#Manual- The Media Manager offers an interface that allows you to manually type in the data.
#Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then you are able to modify it.

<section begin="MediaManagers" />The following is a list of Media Managers on the forum. Questions regarding their use should be directed to the media manager developers.
*[https://forum.kodi.tv/forumdisplay.php?fid=195 Ember Media Manager]
*[https://forum.kodi.tv/showthread.php?tid=361141 Tiny Media Manager aka TMM]
*[https://forum.kodi.tv/showthread.php?tid=129134 Media Companion 3]
*[https://forum.kodi.tv/showthread.php?tid=136333 MediaElch]

Be aware there are many other media managers available that claim to be {{kodi}} compatible but have not been updated in many years. Use of these incompatible media managers have been known to corrupt the library database which requires rebuilding using the {{kodi}} scrapers.

= Scanning nfo files =
To add a '''new''' title to the library using nfo files:
* The normal '''[[Updating_or_removing_videos|Library Update]]''' function, or
* Locating the new title in Videos>Files then pressing {{keypress|i}} on a keyboard or
* Selecting ''Scan to library'' from the '''[[Basic_controls#Context_Menu|context menu]]'''

To load changes to an '''existing''' title in the library:
* Select '''[[Updating_or_removing_videos#Refresh_Library|Refresh]]''' from the '''[[Basic_controls#Information_Page|Information page]]'''

'''After the NFO files are scanned into the library, they are no longer used and serve only as a backup.

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

MySQL/Setting up MySQL

2025-07-31T03:54:08Z

Crystalp: remove misleading unnecessary quotes

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

MySQL/MariaDB can be installed on just about every major OS and NAS:

{{redv|'''Important:'''| Please use only supported versions of the MySQL or MariaDB server. As of January 2019, this is MySQL in at least version 5.7 or MariaDB in at least version 5.5, but version 10.3+ is recommended.}}

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the offical MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD=YOUR_MARIADB_ROOT_PASSWORD
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

This will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{Isengard updated}}

InfoLabels

2025-07-22T12:44:55Z

Crystalp:

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca**
:*dolbydigital
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp2
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
:
: ** note: dca replaced dts in 2011
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Cast(separator)</code>
| '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.Director(separator)</code>
| '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.Genre(separator)</code>
| '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate (kbps) of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The audio, video, or subtitle codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio, video, or subtitle title/name of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Writer(separator)</code>
| '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (e.g. FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Genre(separator)</code>
| '''Returns'''
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre(separator)</code>
| '''Returns'''
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director(separator)</code>
| '''Returns'''
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.Cast(separator)</code>
| '''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole(separator)</code>
| '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer(separator)</code>
| '''Returns'''
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre(separator)</code>
| '''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

[[Category:Skin development]]
[[Category:Add-on development]]

InfoLabels

2025-04-14T18:09:20Z

Crystalp: Player.Process(AudioChannels) is not like the other AudioChannels infolabels

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

<section begin="main content" />
Skins can use infolabels with '''$INFO[infolabel]''' or the '''<info>''' tag. Scripts can read infolabels with <code>'''xbmc.getInfoLabel('infolabel')'''</code>.

=== Addon ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Addon.SettingInt(addon_id,setting_id)</code>
| '''Returns'''
:The integer value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|-
| <code>Addon.SettingStr(addon_id,setting_id)</code>
| '''Returns'''
:The string value of the setting <code>setting_id</code> belonging to the addon with the id <code>addon_id</code>.
'''Parameters'''
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
| [https://forum.kodi.tv/showthread.php?tid=363553&pid=3098121#pid3098121 v20]
|}

=== Container ===
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Container(id).Column</code>
| '''Returns'''
:The column number of the focused position in a panel container.
|
|-
| <code>Container(id).CurrentItem</code>
| '''Returns'''
:The current item in the container or grouplist with given id.
|
|-
| <code>Container(id).CurrentPage</code>
| '''Returns'''
:The current page in the container with given id.
|
|-
| <code>Container(id).ListItem(offset).Property</code>
| '''Returns'''
:The property of the ListItem with a given offset.
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
|
|-
| <code>Container(id).ListItemAbsolute(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).ListItemNoWrap(offset).Property</code>
| '''Returns'''
:The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.<br>
:This means if the last item of a list is focused, <code>ListItemNoWrap(1)</code> will be empty while <code>ListItem(1)</code> will return the first item of the list.<br>
'''Parameters'''
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
|
|-
| <code>Container(id).ListItemPosition(x).[infolabel]</code>
| '''Returns'''
:The infolabel for an item in a container.
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|-
| <code>Container(id).NumAllItems</code>
| '''Returns'''
:The number of all items in the container or grouplist with given id including parent folder item.
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding parent folder item.
|
|-
| <code>Container(id).NumNonFolderItems</code>
| '''Returns'''
:The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
| [https://forum.kodi.tv/showthread.php?tid=298565&pid=2553240#pid2553240 v18]
|-
| <code>Container(id).NumPages</code>
| '''Returns'''
:The number of pages in the container with given id.
|
|-
| <code>Container(id).Position</code>
| '''Returns'''
:The current focused position of container / grouplist (id) as a numeric label.
|
|-
| <code>Container(id).Row</code>
| '''Returns'''
:The row number of the focused position in a panel container.
|
|-
| <code>Container.Art(type)</code>
| '''Returns'''
:The path to the art image file for the given type of the current container.
'''Parameters'''
:'''type''' - The art type to request.
{{highlight|'''Todo'''<br>
List of all art types.}}
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
[https://forum.kodi.tv/showthread.php?tid=211896&pid=1866664#pid1866664 v15]
|-
| <code>Container.Content</code>
| '''Returns'''
:The content of the current container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2109488#pid2109488 v16]
|-
| <code>Container.FolderName</code>
| '''Returns'''
:The top most folder in currently displayed folder.
|
|-
| <code>Container.FolderPath</code>
| '''Returns'''
:The complete path of currently displayed folder.
|
|-
| <code>Container.PluginCategory</code>
| '''Returns'''
:The current plugins category (set by the scripter).
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2300634#pid2300634 v17]
|-
| <code>Container.PluginName</code>
| '''Returns'''
:The current plugins base folder name.
|
|-
| <code>Container.Property(addoncategory)</code>
| '''Returns'''
:The current add-on category.
|
|-
| <code>Container.Property(reponame)</code>
| '''Returns'''
:The current add-on repository name.
|
|-
| <code>Container.ShowPlot</code>
| '''Returns'''
:The TV Show plot of the current container and can be used at season and episode level.
|
|-
| <code>Container.ShowTitle</code>
| '''Returns'''
:The TV Show title of the current container and can be used at season and episode level.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2284876#pid2284876 v17]
|-
| <code>Container.SortMethod</code>
| '''Returns'''
:The current sort method (returns a localized value).
|
|-
| <code>Container.SortOrder</code>
| '''Returns'''
:The current sort order (Ascending/Descending).
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
| <code>Container(id).TotalUnWatched</code>
| '''Returns'''
:The number of unwatched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container(id).TotalWatched</code>
| '''Returns'''
:The number of watched items in the container.
| [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
| <code>Container.Totaltime</code>
| '''Returns'''
:The total time of all items in the current container.
|
|-
| <code>Container.ViewCount</code>
| '''Returns'''
:The number of available skin view modes for the current container listing.
| [https://forum.kodi.tv/showthread.php?tid=250862&pid=2278045#pid2278045 v17]
|-
| <code>Container.Viewmode</code>
| '''Returns'''
:The current viewmode (e.g. list, icons, etc).
|
|}

=== Control ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Control.GetLabel(id)[.index()]</code>
| '''Returns'''
:The label value or texture name of the control with the given id.
'''Parameters'''
:'''id''' - The id of the control.
:'''index''' - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.
| [https://forum.kodi.tv/showthread.php?tid=211896&pid=1937160#pid1937160 v15]
|}

=== Fanart ===
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Fanart.Color1</code>
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color2</code>
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|-
| <code>Fanart.Color3</code>
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show.
|
|}

=== Game ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Game.Developer</code>
| '''Returns'''
: The developer of the game (e.g. Activision).
| v18
|-
| <code>Game.GameClient</code>
| '''Returns'''
: The add-on ID of the emulator used to play the game.
| v18
|-
| <code>Game.Genres</code>
| '''Returns'''
: The genre of the game (e.g. Action).
| v18
|-
| <code>Game.Overview</code>
| '''Returns'''
: The game description.
| v18
|-
| <code>Game.Platform</code>
| '''Returns'''
: The platform the game runs on (e.g. Atari 2600).
| v18
|-
| <code>Game.Publisher</code>
| '''Returns'''
: The publishing company of the game (e.g. Nintendo).
| v18
|-
| <code>Game.Title</code>
| '''Returns'''
: The name of the game.
| v18
|-
| <code>Game.Year</code>
| '''Returns'''
: The year the game was released.
| v18
|}

=== ListItem ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.AddonBroken</code>
| Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
| <code>ListItem.AddonCreator</code>
| '''Returns'''
:The name of the author the currently selected addon.
|
|-
| <code>ListItem.AddonDescription</code>
| '''Returns'''
:The full description of the currently selected addon.
|
|-
| <code>ListItem.AddonDisclaimer</code>
| '''Returns'''
:The disclaimer of the currently selected addon.
|
|-
| <code>ListItem.AddonInstallDate</code>
| '''Returns'''
:The date the addon was installed.
|
|-
| <code>ListItem.AddonLastUpdated</code>
| '''Returns'''
:The date the addon was last updated.
|
|-
| <code>ListItem.AddonLastUsed</code>
| '''Returns'''
:The date the addon was used last.
|
|-
| <code>ListItem.AddonLifecycleDesc</code>
| '''Returns'''
:The description of the lifecycle type (e.g. broken due to website changes).
| v19
|-
| <code>ListItem.AddonLifecycleType</code>
| '''Returns'''
:The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
| v19
|-
| <code>ListItem.AddonName</code>
| '''Returns'''
:The name of the currently selected addon.
|
|-
| <code>ListItem.AddonNews</code>
| '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
|
|-
| <code>ListItem.AddonSize</code>
| '''Returns'''
:The filesize of the addon.
|
|-
| <code>ListItem.AddonSummary</code>
| '''Returns'''
:A short description of the currently selected addon.
|
|-
| <code>ListItem.AddonType</code>
| '''Returns'''
:The type of the currently selected addon (e.g. screensaver, script, skin, etc).
|
|-
| <code>ListItem.AddonVersion</code>
| '''Returns'''
:The version of the currently selected addon.
|
|-
| <code>ListItem.Album</code>
| '''Returns'''
:The album of the currently selected song in a container.
|
|-
| <code>ListItem.AlbumArtist</code>
| '''Returns'''
:The artist of the currently selected album in a list.
|
|-
| <code>ListItem.AlbumStatus</code>
| '''Returns'''
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
| v19
|-
| <code>ListItem.Appearances</code>
| '''Returns'''
:The number of movies featuring the selected actor or directed by the selected director.
| v17
|-
| <code>ListItem.Artist</code>
| '''Returns'''
:The artist of the currently selected song in a container.
|
|-
| <code>ListItem.AudioChannels</code>
| '''Returns'''
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
|
|-
| <code>ListItem.AudioCodec</code>
| '''Returns'''
:The audio codec of the currently selected video.<br>
:Possible values:
:*aac
:*aac_lc*
:*he_aac*
:*he_aac_v2*
:*aac_ssr*
:*aac_ltp*
:*aac_latm
:*ac3
:*aif
:*aifc
:*aiff
:*alac
:*ape
:*avc
:*cdda
:*dca
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma_x*
:*dtshd_ma_x_imax*
:*dtsma
:*eac3
:*eac3_ddp_atmos*
:*flac
:*mp1
:*mp3
:*mp3float
:*ogg
:*opus
:*pcm
:*pcm_bluray
:*pcm_s16le
:*pcm_s24le
:*truehd
:*truehd_atmos*
:*vorbis
:*wav
:*wavpack
:*wmapro
:*wmav2
| *v22
|-
| <code>ListItem.AudioLanguage</code>
| '''Returns'''
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.BitRate</code>
| '''Returns'''
:The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
| v19
|-
| <code>ListItem.BPM</code>
| '''Returns'''
:The Beats Per Minute of the currently selected song.
| v19
|-
| <code>ListItem.Cast</code>
| '''Returns'''
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.CastAndRole</code>
| '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ChannelLogo</code>
| '''Returns'''
:The logo of the currently selected radio or TV channel (PVR).
| v22
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The name of current selected TV channel in a container (PVR).
|
|-
| <code>ListItem.ChannelName</code>
| '''Returns'''
:The channel name of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumber</code>
| '''Returns'''
:The channel number of the selected item (PVR).
|
|-
| <code>ListItem.ChannelNumberLabel</code>
| '''Returns'''
:The channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| <code>ListItem.Comment</code>
| '''Returns'''
:The comment assigned to the item (PVR/MUSIC).
|
|-
| <code>ListItem.ContributorAndRole</code>
| '''Returns'''
:The list of all people and their role who've contributed to the selected song.
|
|-
| <code>ListItem.Contributors</code>
| '''Returns'''
:The list of all people who've contributed to the selected song.
|
|-
| <code>ListItem.Country</code>
| '''Returns'''
:The production country of the currently selected movie in a container.
|
|-
| <code>ListItem.CurrentItem</code>
| '''Returns'''
:The current index of the item in a container starting at 1.
| v19
|-
| <code>ListItem.Date</code>
| '''Returns'''
:The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
|
|-
| <code>ListItem.DateAdded</code>
| '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
| <code>ListItem.DBID</code>
| '''Returns'''
:The database id of the currently selected ListItem in a container.
|
|-
| <code>ListItem.DBTYPE</code>
| '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
| <code>ListItem.Director</code>
| '''Returns'''
:The director of the currently selected movie in a container.
|
|-
| <code>ListItem.DiscNumber</code>
| '''Returns'''
:The disc number of the currently selected song in a container.
|
|-
| <code>ListItem.DiscTitle</code>
| '''Returns'''
:The disc title of the currently selected album or song.
| v19
|-
| <code>ListItem.Duration[(format)]</code>
| '''Returns'''
:The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>ListItem.EndDate</code>
| '''Returns'''
:The end date of the selected item (PVR).
|
|-
| <code>ListItem.EndTime</code>
| '''Returns'''
:The end time of current selected TV programme in a container (PVR).
|
|-
| <code>ListItem.EndTimeResume</code>
| '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| <code>ListItem.Episode</code>
| '''Returns'''
:The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.EpisodeName</code>
| '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
| <code>ListItem.FileExtension</code>
| '''Returns'''
:The file extension (without leading dot) of the currently selected item in a container.
|
|-
| <code>ListItem.FileName</code>
| '''Returns'''
:The filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameAndPath</code>
| '''Returns'''
:The full path with filename of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FileNameNoExtension</code>
| '''Returns'''
:The filename without its extension.
| v19
|-
| <code>ListItem.FolderName</code>
| '''Returns'''
:The top most folder of the path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.FolderPath</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
| <code>ListItem.Genre</code>
| '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
|
|-
| <code>ListItem.HdrType</code>
| '''Returns'''
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
| v20
|-
| <code>ListItem.IMDBNumber</code>
| '''Returns'''
:The IMDB iD of the selected Video in a container.
|
|-
| <code>ListItem.Label</code>
| '''Returns'''
:The left label of the currently selected item in a container.
|
|-
| <code>ListItem.Label2</code>
| '''Returns'''
:The right label of the currently selected item in a container.
|
|-
| <code>ListItem.LastPlayed</code>
| '''Returns'''
:The last play date of video in a container.
|
|-
| <code>ListItem.Mood</code>
| '''Returns'''
:The mood of the selected song.
|
|-
| <code>ListItem.Mpaa</code>
| '''Returns'''
:The MPAA rating of the currently selected movie in a container.
|
|-
| <code>ListItem.MusicChannels</code>
| '''Returns'''
:The number of audio channels for a song.
| v19
|-
| <code>ListItem.NextDuration</code>
| '''Returns'''
:The duration of the next item (PVR).
| v18
|-
| <code>ListItem.NextEndDate</code>
| '''Returns'''
:The end date of the next item (PVR).
|
|-
| <code>ListItem.NextEndTime</code>
| '''Returns'''
:The end of the next item (PVR).
|
|-
| <code>ListItem.NextGenre</code>
| '''Returns'''
:The genre of the next item (PVR).
|
|-
| <code>ListItem.NextPlot</code>
| '''Returns'''
:The plot of the next item (PVR).
|
|-
| <code>ListItem.NextPlotOutline</code>
| '''Returns'''
:The plot outline of the next item (PVR).
|
|-
| <code>ListItem.NextStartDate</code>
| '''Returns'''
:The start date of the next item (PVR).
|
|-
| <code>ListItem.NextStartTime</code>
| '''Returns'''
:The start time of the next item (PVR).
|
|-
| <code>ListItem.NextTitle</code>
| '''Returns'''
:The title of the next item (PVR).
|
|-
| <code>ListItem.OriginalDate</code>
| '''Returns'''
:The original release date of the item.
| v19
|-
| <code>ListItem.OriginalTitle</code>
| '''Returns'''
:The original title of the currently selected movie in a container.
|
|-
| <code>ListItem.ParentalRatingCode</code>
| '''Returns'''
:The parental rating code.
| v22
|-
| <code>ListItem.ParentalRatingIcon</code>
| '''Returns'''
:The parental rating icon.
| v22
|-
| <code>ListItem.ParentalRatingSource</code>
| '''Returns'''
:The parental rating source.
| v22
|-
| <code>ListItem.Path</code>
| '''Returns'''
:The complete path of the currently selected song or movie in a container.
|
|-
| <code>ListItem.PercentPlayed</code>
| '''Returns'''
:The returns percentage value [0-100] of how far the selected video has been played.
|
|-
| <code>ListItem.PictureAperture</code>
| '''Returns'''
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>ListItem.PictureAuthor</code>
| '''Returns'''
:The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>ListItem.PictureByline</code>
| '''Returns'''
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>ListItem.PictureBylineTitle</code>
| '''Returns'''
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>ListItem.PictureCamMake</code>
| '''Returns'''
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>ListItem.PictureCamModel</code>
| '''Returns'''
:The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>ListItem.PictureCaption</code>
| '''Returns'''
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>ListItem.PictureCategory</code>
| '''Returns'''
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>ListItem.PictureCCDWidth</code>
| '''Returns'''
:The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>ListItem.PictureCity</code>
| '''Returns'''
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>ListItem.PictureColour</code>
| '''Returns'''
:Whether the selected picture is "Colour" or "Black and White".
|
|-
| <code>ListItem.PictureComment</code>
| '''Returns'''
:The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>ListItem.PictureCopyrightNotice</code>
| '''Returns'''
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>ListItem.PictureCountry</code>
| '''Returns'''
:The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>ListItem.PictureCountryCode</code>
| '''Returns'''
:The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>ListItem.PictureCredit</code>
| '''Returns'''
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>ListItem.PictureDate</code>
| '''Returns'''
:The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureDesc</code>
| '''Returns'''
:The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>ListItem.PictureDigitalZoom</code>
| '''Returns'''
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>ListItem.PictureExpMode</code>
| '''Returns'''
:The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>ListItem.PictureExposure</code>
| '''Returns'''
:The class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>ListItem.PictureExposureBias</code>
| '''Returns'''
:The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>ListItem.PictureExpTime</code>
| '''Returns'''
:The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>ListItem.PictureFlashUsed</code>
| '''Returns'''
:The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>ListItem.PictureFocalLen</code>
| '''Returns'''
:The lens focal length of the selected picture.
|
|-
| <code>ListItem.PictureFocusDist</code>
| '''Returns'''
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>ListItem.PictureGPSAlt</code>
| '''Returns'''
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>ListItem.PictureGPSLat</code>
| '''Returns'''
:The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>ListItem.PictureGPSLon</code>
| '''Returns'''
:The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>ListItem.PictureHeadline</code>
| '''Returns'''
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>ListItem.PictureImageType</code>
| '''Returns'''
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>ListItem.PictureIPTCDate</code>
| '''Returns'''
:The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>ListItem.PictureIPTCTime</code>
| '''Returns'''
:The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>ListItem.PictureISO</code>
| '''Returns'''
:The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>ListItem.PictureKeywords</code>
| '''Returns'''
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>ListItem.PictureLightSource</code>
| '''Returns'''
:The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>ListItem.PictureLongDate</code>
| '''Returns'''
:The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureLongDatetime</code>
| '''Returns'''
:The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>ListItem.PictureMeteringMode</code>
| '''Returns'''
:The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>ListItem.PictureObjectName</code>
| '''Returns'''
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>ListItem.PictureOrientation</code>
| '''Returns'''
:The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>ListItem.PicturePath</code>
| '''Returns'''
:The filename and path of the selected picture.
|
|-
| <code>ListItem.PictureProcess</code>
| '''Returns'''
:The process used to compress the selected picture.
|
|-
| <code>ListItem.PictureReferenceService</code>
| '''Returns'''
:The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>ListItem.PictureResolution</code>
| '''Returns'''
:The dimensions of the selected picture.
|
|-
| <code>ListItem.PictureSource</code>
| '''Returns'''
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>ListItem.PictureSpecialInstructions</code>
| '''Returns'''
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>ListItem.PictureState</code>
| '''Returns'''
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>ListItem.PictureSublocation</code>
| '''Returns'''
:The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>ListItem.PictureSupplementalCategories</code>
| '''Returns'''
:The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>ListItem.PictureTransmissionReference</code>
| '''Returns'''
:The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>ListItem.PictureUrgency</code>
| '''Returns'''
:The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>ListItem.PictureWhiteBalance</code>
| '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| <code>ListItem.PlayCount</code>
| '''Returns'''
:The playcount of video in a container.
|
|-
| <code>ListItem.Plot</code>
| '''Returns'''
:The complete text summary of video in a container.
|
|-
| <code>ListItem.PlotOutline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Premiered</code>
| '''Returns'''
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
|
|-
| <code>ListItem.PrivacyPolicy</code>
| '''Returns'''
:The official Kodi privacy-policy.
| v17
|-
| <code>ListItem.ProgramCount</code>
| '''Returns'''
:The number of times an xbe has been run from "my programs".
|
|-
| <code>ListItem.Progress</code>
| '''Returns'''
:The part of the programme that's being played (PVR).
|
|-
| <code>ListItem.Property(Addon.Changelog)</code>
| '''Returns'''
:The changelog of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.ID)</code>
| '''Returns'''
:The identifier of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Path)</code>
| '''Returns'''
:The path of the currently selected addon.
|
|-
| <code>ListItem.Property(Addon.Status)</code>
| '''Returns'''
:The status of the currently selected addon.
|
|-
| <code>ListItem.Property(Album_Description)</code>
| '''Returns'''
:The review of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Duration)</code>
| '''Returns'''
:The duration of an album in HH:MM:SS.
| v19
|-
| <code>ListItem.Property(Album_Label)</code>
| '''Returns'''
:The record label of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Mood)</code>
| '''Returns'''
:The moods of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Rating)</code>
| '''Returns'''
:The scraped rating of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Style)</code>
| '''Returns'''
:The styles of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Theme)</code>
| '''Returns'''
:The themes of the currently selected album.
|
|-
| <code>ListItem.Property(Album_Type)</code>
| '''Returns'''
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
|
|-
| <code>ListItem.Property(Album_UserRating)</code>
| '''Returns'''
:The user rating of the currently selected album.
|
|-
| <code>ListItem.Property(Artist_Born)</code>
| '''Returns'''
:The Date of Birth of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Description)</code>
| '''Returns'''
:The biography of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Died)</code>
| '''Returns'''
:The Date of Death of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Disambiguation)</code>
| '''Returns'''
:The brief description of the currently selected artist that differentiates them from others with the same name.
| v18
|-
| <code>ListItem.Property(Artist_Disbanded)</code>
| '''Returns'''
:The disbanding date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Formed)</code>
| '''Returns'''
:The formation date of the currently selected band.
|
|-
| <code>ListItem.Property(Artist_Gender)</code>
| '''Returns'''
:The gender of the currently selected artist (e.g.male, female, or other).
| v18
|-
| <code>ListItem.Property(Artist_Genre)</code>
| '''Returns'''
:The genre of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Instrument)</code>
| '''Returns'''
:The instruments played by the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Mood)</code>
| '''Returns'''
:The moods of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Sortname)</code>
| '''Returns'''
:The sortname of the currently selected artist.
| v18
|-
| <code>ListItem.Property(Artist_Style)</code>
| '''Returns'''
:The styles of the currently selected artist.
|
|-
| <code>ListItem.Property(Artist_Type)</code>
| '''Returns'''
:The type of the currently selected artist (person, group, orchestra, choir, etc).
| v18
|-
| <code>ListItem.Property(Artist_YearsActive)</code>
| '''Returns'''
:The years the currently selected artist has been active.
|
|-
| <code>ListItem.Property(AudioChannels.[n])</code>
| '''Returns'''
:The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
|
|-
| <code>ListItem.Property(AudioCodec.[n])</code>
| '''Returns'''
:The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
|
|-
| <code>ListItem.Property(AudioLanguage.[n])</code>
| '''Returns'''
:The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
|
|-
| <code>ListItem.Property(game.stretchmode)</code>
| '''Returns'''
:The name of the stretch mode (e.g. Stretch 4:3).
| v18
|-
| <code>ListItem.Property(game.videofilter)</code>
| '''Returns'''
:The name of the video filter (e.g. Bilinear).
| v18
|-
| <code>ListItem.Property(game.videorotation)</code>
| '''Returns'''
:The angle of the rotation.
| v18
|-
| <code>ListItem.Property(NumEpisodes)</code>
| '''Returns'''
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
|
|-
| <code>ListItem.Property(Role.Arranger)</code>
| '''Returns'''
:The name of the person who arranged the selected song.
|
|-
| <code>ListItem.Property(Role.Composer)</code>
| '''Returns'''
:The name of the person who composed the selected song.
|
|-
| <code>ListItem.Property(Role.Conductor)</code>
| '''Returns'''
:The name of the person who conducted the selected song.
|
|-
| <code>ListItem.Property(Role.DJMixer)</code>
| '''Returns'''
:The name of the DJ who remixed the selected song.
|
|-
| <code>ListItem.Property(Role.Engineer)</code>
| '''Returns'''
:The name of the person who was the engineer of the selected song.
|
|-
| <code>ListItem.Property(Role.Lyricist)</code>
| '''Returns'''
:The name of the person who wrote the lyrics of the selected song.
|
|-
| <code>ListItem.Property(Role.Mixer)</code>
| '''Returns'''
:The name of the person who mixed the selected song.
|
|-
| <code>ListItem.Property(Role.Orchestra)</code>
| '''Returns'''
:The name of the orchestra performing the selected song.
|
|-
| <code>ListItem.Property(Role.Producer)</code>
| '''Returns'''
:The name of the person who produced the selected song.
|
|-
| <code>ListItem.Property(Role.Remixer)</code>
| '''Returns'''
:The name of the person who remixed the selected song.
|
|-
| <code>ListItem.Property(Stream.Bitrate)</code>
| '''Returns'''
:The video bitrate of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Channels)</code>
| '''Returns'''
:The number of audio channels of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Codec)</code>
| '''Returns'''
:The video codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| '''Returns'''
:The audio codec of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.Description)</code>
| '''Returns'''
:The audio description of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.FPS)</code>
| '''Returns'''
:The Frames per Second of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.HDRType)</code>
| '''Returns'''
:The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
| v22
|-
| <code>ListItem.Property(Stream.Language)</code>
| '''Returns'''
:The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
| v22
|-
| <code>ListItem.Property(Stream.Resolution)</code>
| '''Returns'''
:The video resolution of the currently playing video.
| v22
|-
| <code>ListItem.Property(Stream.StereoMode)</code>
| '''Returns'''
:The stereomode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| '''Returns'''
:The subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|-
| <code>ListItem.Property(TotalEpisodes)</code>
| '''Returns'''
:The total number of episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(TotalSeasons)</code>
| '''Returns'''
:The total number of seasons for the currently selected TV show.
|
|-
| <code>ListItem.Property(UnWatchedEpisodes)</code>
| '''Returns'''
:The number of unwatched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.Property(WatchedEpisodes)</code>
| '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
|
|-
| <code>ListItem.PVRClientName</code>
| '''Returns'''
:The name of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.PVRInstanceName</code>
| '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
| v22
|-
| <code>ListItem.Rating[(name)]</code>
| '''Returns'''
:The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.RatingAndVotes[(name)]</code>
| '''Returns'''
:The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.ReleaseDate</code>
| '''Returns'''
:The release date of the current item.
| v19
|-
| <code>ListItem.SampleRate</code>
| '''Returns'''
:The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
| v19
|-
| <code>ListItem.Season</code>
| '''Returns'''
:The season value for the currently selected TV show.
|
|-
| <code>ListItem.Set</code>
| '''Returns'''
:The name of the set the movie is part of.
|
|-
| <code>ListItem.SetId</code>
| '''Returns'''
:The id of the set the movie is part of.
|
|-
| <code>ListItem.Size</code>
| '''Returns'''
:The file size of the currently selected song or movie in a container.
|
|-
| <code>ListItem.SortLetter</code>
| '''Returns'''
:The first letter of the current file in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of current selected TV programme in a container.
|
|-
| <code>ListItem.StartDate</code>
| '''Returns'''
:The start date of the selected item (PVR).
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of current selected TV programme in a container.
|
|-
| <code>ListItem.StartTime</code>
| '''Returns'''
:The start time of the selected item (PVR).
|
|-
| <code>ListItem.Status</code>
| '''Returns'''
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
|
|-
| <code>ListItem.StereoscopicMode</code>
| '''Returns'''
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
|
|-
| <code>ListItem.Studio</code>
| '''Returns'''
:The studio of current selected music video in a container.
|
|-
| <code>ListItem.SubtitleLanguage</code>
| '''Returns'''
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
|
|-
| <code>ListItem.Tag</code>
| '''Returns'''
:The name of the 'tag' this movie is part of.
|
|-
| <code>ListItem.Tagline</code>
| '''Returns'''
:The small summary of current video in a container.
|
|-
| <code>ListItem.Title</code>
| '''Returns'''
:The title of the currently selected song or movie in a container.
|
|-
| <code>ListItem.Top250</code>
| '''Returns'''
:The IMDB top 250 position of the currently selected ListItem in a container.
|
|-
| <code>ListItem.TotalDiscs</code>
| '''Returns'''
:The total amount of discs belonging to an album.
| v19
|-
| <code>ListItem.TrackNumber</code>
| '''Returns'''
:The track number of the currently selected song in a container.
|
|-
| <code>ListItem.Trailer</code>
| '''Returns'''
:The full trailer path with filename of the currently selected movie in a container.
|
|-
| <code>ListItem.TVShowDBID</code>
| '''Returns'''
:The TV show DBID of the selected season or episode a container.
| v19
|-
| <code>ListItem.TVShowTitle</code>
| '''Returns'''
:The name value for the currently selected TV show in the season and episode depth of the video library.
|
|-
| <code>ListItem.UniqueID()</code>
| '''Returns'''
:The UniqueID of the selected item in a container.
| v19
|-
| <code>ListItem.UserRating</code>
| '''Returns'''
:The user rating of the currently selected item in a container.
|
|-
| <code>ListItem.VideoAspect</code>
| '''Returns'''
:The aspect ratio of the currently selected video.<br>
:Possible values:
:*1.00*
:*1.19*
:*1.33
:*1.37
:*1.66
:*1.78
:*1.85
:*2.00*
:*2.20
:*2.35
:*2.40
:*2.55
:*2.76
| *v20
|-
| <code>ListItem.VideoCodec</code>
| '''Returns'''
:The video codec of the currently selected video.<br>
:Possible values:
:*3iv2
:*av1
:*avc1
:*div2
:*div3
:*divx
:*divx 4
:*dx50
:*flv
:*h264
:*hev1
:*hevc
:*hvc1
:*microsoft
:*mp42
:*mp43
:*mp4v
:*mpeg1
:*mpeg1video
:*mpeg2
:*mpeg2video
:*mpeg4
:*mpg4
:*rv40
:*svq1
:*svq3
:*theora
:*vc-1
:*vc1
:*vp6f
:*vp8
:*vp9
:*wmv
:*wmv2
:*wmv3
:*wvc1
:*xvid
|
|-
| <code>ListItem.VideoResolution</code>
| '''Returns'''
:The resolution of the currently selected video.<br>
:Possible values:
:*480
:*576
:*540
:*720
:*1080
:*4K
:*8K*
{{highlight|'''Note'''<br>
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.}}
| *v18
|-
| <code>ListItem.VideoVersionName</code>
| '''Returns'''
:The name of the video version.
| v21
|-
| <code>ListItem.Votes[(name)]</code>
| '''Returns'''
:The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| <code>ListItem.Writer</code>
| '''Returns'''
:The name of Writer of current video in a container.
|
|-
| <code>ListItem.Year</code>
| '''Returns'''
:The year of the currently selected song, album, or movie in a container.
|}

=== MusicPartyMode ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPartyMode.SongsPlayed</code>
| '''Returns'''
:The number of songs played during Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongs</code>
| '''Returns'''
:The number of songs available to Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsPicked</code>
| '''Returns'''
:The number of songs picked already for Party Mode.
|
|-
| <code>MusicPartyMode.MatchingSongsLeft</code>
| '''Returns'''
:The number of songs left to be picked from for Party Mode.
|
|-
| <code>MusicPartyMode.RelaxedSongsPicked</code>
| '''Returns'''
:The number of relaxed songs picked during Party Mode.
|
|-
| <code>MusicPartyMode.RandomSongsPicked</code>
| '''Returns'''
:The number of unique random songs picked during Party Mode.
|
|}

=== Network ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Network.LinkState</code>
| '''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|-
| <code>Network.MacAddress</code>
| '''Returns'''
:The system's mac address.
|
|-
| <code>Network.SubnetMask</code>
| '''Returns'''
:The network subnet mask.
|
|-
| <code>Network.GatewayAddress</code>
| '''Returns'''
:The network gateway address.
|
|-
| <code>Network.DNS1Address</code>
| '''Returns'''
:The network dns server 1 address.
|
|-
| <code>Network.DNS2Address</code>
| '''Returns'''
:The network dns server 2 address.
|
|-
| <code>Network.DHCPAddress</code>
| '''Returns'''
:The DHCP server ip address.
|
|}

=== Player labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Player.FinishTime</code>
| Time playing media will end
|
|-
| <code>Player.FinishTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Chapter</code>
| Current chapter of current playing media
|
|-
| <code>Player.ChapterCount</code>
| Total number of chapters of current playing media
|
|-
| <code>Player.Time</code>
| Elapsed time of current playing media
|
|-
| <code>Player.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.TimeRemaining</code>
| Remaining time of current playing media
|
|-
| <code>Player.TimeRemaining(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Duration</code>
| Total duration of the current playing media
|
|-
| <code>Player.Duration(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekTime</code>
| Time to which the user is seeking
|
|-
| <code>Player.SeekBar</code>
| Time to which the user is seeking as a percentage (for use in slider controls)
|
|-
| <code>Player.SeekOffset</code>
| Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
|
|-
| <code>Player.SeekOffset(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.SeekStepSize</code>
| Displays the seek step size. (v15 addition)
|
|-
| <code>Player.Progress</code>
| Shows how much (percentage) of the file has been played
|
|-
| <code>Player.ProgressCache</code>
| Shows how much of the file is cached above current play percentage
|
|-
| <code>Player.Folderpath</code>
| Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.Filenameandpath</code>
| Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|-
| <code>Player.StartTime</code>
| Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|-
| <code>Player.StartTime(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| <code>Player.Title</code>
| Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|-
| <code>Player.Filename</code>
| Returns the filename of the currently playing media. (supports .offset() and .position())
|
|-
| <code>Player.Volume</code>
| Returns the volume level in dB
|
|-
| <code>Player.PlaySpeed</code>
| Current playspeed. (range:0.8 to 1.5)
|
|-
| <code>Player.Process(AudioBitsPerSample)</code>
| Bits per sample of the currently playing item
|
|-
| <code>Player.Process(AudioChannels)</code>
| List of audio channels of the currently playing item (ex FL+FR)
|
|-
| <code>Player.Process(AudioDecoder)</code>
| Audiodecoder name of the currently playing item
|
|-
| <code>Player.Process(AudioSamplerate)</code>
| Samplerate f the currently playing item
|
|-
| <code>Player.Process(DeintMethod)</code>
| Deinterlace method of the currently playing video
|
|-
| <code>Player.Process(PixFormat)</code>
| Pixel format of the currently playing video
|
|-
| <code>Player.Process(VideoDAR)</code>
| Display aspect ratio of the currently playing video
|
|-
| <code>Player.Process(VideoFPS)</code>
| Video framerate of the currently playing video
|
|-
| <code>Player.Process(VideoHeight)</code>
| Height of the currently playing video
|
|-
| <code>Player.Process(VideoDecoder)</code>
| Videodecoder name of the currently playing video
|
|-
| <code>Player.Process(VideoWidth)</code>
| Width of the currently playing video
|
|-
| <code>Player.Process(VideoScanType)</code>
| The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
| v20
|-
| <code>Player.CutList</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|-
| <code>Player.Chapters</code>
| this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
| v19
|}

==== Music player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>MusicPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>MusicPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>MusicPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>MusicPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>MusicPlayer.Title</code>
| Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Album</code>
| Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Album_Mood)</code>
| Shows the moods of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Style)</code>
| Shows the styles of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Theme)</code>
| Shows the themes of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Type)</code>
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Label)</code>
| Shows the record label of the currently playing Album
|
|-
| <code>MusicPlayer.Property(Album_Description)</code>
| Shows a review of the currently playing Album
|
|-
| <code>MusicPlayer.Artist</code>
| Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Property(Artist_Born)</code>
| Date of Birth of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Died)</code>
| Date of Death of the currently playing Artist
|
|-
| <code>MusicPlayer.Property(Artist_Formed)</code>
| Formation date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_Disbanded)</code>
| Disbanding date of the currently playing Artist/Band
|
|-
| <code>MusicPlayer.Property(Artist_YearsActive)</code>
| Years the currently Playing artist has been active
|
|-
| <code>MusicPlayer.Property(Artist_Instrument)</code>
| Instruments played by the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Description)</code>
| Shows a biography of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Mood)</code>
| Shows the moods of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Style)</code>
| Shows the styles of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Genre)</code>
| Shows the genre of the currently playing artist
|
|-
| <code>MusicPlayer.Property(Artist_Sortname)</code>
| Sortname of the currently playing Artist
| v18
|-
| <code>MusicPlayer.Property(Artist_Type)</code>
| Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
| <code>MusicPlayer.Property(Artist_Gender)</code>
| Gender of the currently playing Artist - male, female, other
| v18
|-
| <code>MusicPlayer.Property(Artist_Disambiguation)</code>
| Brief description of the currently playing Artist that differentiates them from others with the same name
| v18
|-
| <code>MusicPlayer.Genre</code>
| Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Lyrics</code>
| Lyrics of current song stored in ID tag info
|
|-
| <code>MusicPlayer.Year</code>
| Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Rating</code>
| Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.DiscNumber</code>
| Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Comment</code>
| Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Time</code>
| Current time in song
|
|-
| <code>MusicPlayer.TimeRemaining</code>
| Current remaining time in song
|
|-
| <code>MusicPlayer.TimeSpeed</code>
| Both the time and the playspeed formatted up. e.g. 1:23 (2x)
|
|-
| <code>MusicPlayer.TrackNumber</code>
| Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.Duration</code>
| Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|-
| <code>MusicPlayer.BitRate</code>
| Bitrate of current song
|
|-
| <code>MusicPlayer.Channels</code>
| Number of channels of current song
|
|-
| <code>MusicPlayer.BitsPerSample</code>
| Number of bits per sample of current song
|
|-
| <code>MusicPlayer.SampleRate</code>
| Samplerate of current song
|
|-
| <code>MusicPlayer.Codec</code>
| Codec of current song
|
|-
| <code>MusicPlayer.PlaylistPosition</code>
| Position of the current song in the current music playlist
|
|-
| <code>MusicPlayer.PlaylistLength</code>
| Total size of the current music playlist
|
|-
| <code>MusicPlayer.ChannelName</code>
| Channel name of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|-
| <code>MusicPlayer.ChannelGroup</code>
| Channel group of of the radio programme that's currently playing (PVR).
|
|-
| <code>MusicPlayer.Contributors</code>
| List of all people who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.ContributorAndRole</code>
| List of all people and their role who've contributed to the currently playing song
|
|-
| <code>MusicPlayer.Mood</code>
| Mood of the currently playing song
|
|-
| <code>MusicPlayer.Property(Role.Arranger)</code>
| Returns the name of the person who arranged the selected song
|
|-
| <code>MusicPlayer.Property(Role.Composer)</code>
| Returns the name of the person who composed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Conductor)</code>
| Returns the name of the person who conducted the selected song
|
|-
| <code>MusicPlayer.Property(Role.DJMixer)</code>
| Returns the name of the dj who remixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Engineer)</code>
| Returns the name of the person who was the engineer of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Lyricist)</code>
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| <code>MusicPlayer.Property(Role.Mixer)</code>
| Returns the name of the person who mixed the selected song
|
|-
| <code>MusicPlayer.Property(Role.Orchestra)</code>
| Returns the name of the orchestra performing the selected song
|
|-
| <code>MusicPlayer.Property(Role.Producer)</code>
| Returns the name of the person who produced the selected song
|
|-
| <code>MusicPlayer.Property(Role.Remixer)</code>
| Returns the name of the person who remixed the selected song
|
|-
| <code>MusicPlayer.UserRating</code>
| The rating the user gave to the currently playing song
|
|-
| <code>MusicPlayer.DBID</code>
| The database id of the currently playing song
| v17
|-
| <code>MusicPlayer.DiscTitle</code>
| The title of the disc currently playing
| v19
|-
| <code>MusicPlayer.ReleaseDate</code>
| Returns the release date of the song currently playing
| v19
|-
| <code>MusicPlayer.OriginalDate</code>
| Returns the original release date of the song currently playing
| v19
|-
| <code>MusicPlayer.BPM</code>
| Returns the Beats Per Minute of the currently playing song
| v19
|-
| <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
| v19
|}

==== Video player ====

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>VideoPlayer.AudioStreamCount</code>
| Returns the number of audio streams of the currently playing video
| v21
|-
| <code>VideoPlayer.VideoStreamCount</code>
| Returns the number of video streams of the currently playing video
| v22
|-
| <code>VideoPlayer.ParentalRatingCode</code>
| Shows the parental rating code
| v22
|-
| <code>VideoPlayer.ParentalRatingIcon</code>
| Shows the parental rating icon
| v22
|-
| <code>VideoPlayer.ParentalRatingSource</code>
| Shows the parental rating source
| v22
|-
| <code>VideoPlayer.ChannelLogo</code>
| Shows the logo of the currently selected radio or TV channel
| v22
|-
| <code>VideoPlayer.VideoVersionName</code>
| Show the name of the video version
| v21
|-
| <code>VideoPlayer.Time</code>
| Current time in movie
|
|-
| <code>VideoPlayer.TimeRemaining</code>
| Current remaining time in movie
|
|-
| <code>VideoPlayer.TimeSpeed</code>
| Current time + playspeed. e.g. 1:23:14 (-4x)
|
|-
| <code>VideoPlayer.Duration</code>
| Length of current movie
|
|-
| <code>VideoPlayer.Title</code>
| Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.OriginalTitle</code>
| The original title of currently playing video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.TVShowTitle</code>
| Title of currently playing episode's tvshow name. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Season</code>
| Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Episode</code>
| Episode number of the currently playing episode. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Genre</code>
| Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Director</code>
| Director of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Country</code>
| Production country of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Year</code>
| Year of release of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Premiered</code>
| The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Rating</code>
| IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.UserRating</code>
| Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Votes</code>
| IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.RatingAndVotes</code>
| IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.mpaa</code>
| MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.IMDBNumber</code>
| The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.EpisodeName</code>
| (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|-
| <code>VideoPlayer.PlaylistPosition</code>
| Position of the current song in the current video playlist
|
|-
| <code>VideoPlayer.PlaylistLength</code>
| Total size of the current video playlist
|
|-
| <code>VideoPlayer.Cast</code>
| A list of cast members, separated by carriage returns, if it's in the database
|
|-
| <code>VideoPlayer.CastAndRole</code>
| A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|-
| <code>VideoPlayer.Trailer</code>
| The trailer of the current movie. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Album</code>
| Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Artist</code>
| Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Studio</code>
| Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Writer</code>
| Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Tagline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlotOutline</code>
| Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Plot</code>
| Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.Top250</code>
| Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.LastPlayed</code>
| Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.PlayCount</code>
| Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|-
| <code>VideoPlayer.HdrType</code>
| Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
| v20
|-
| <code>VideoPlayer.VideoCodec</code>
| Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|-
| <code>VideoPlayer.VideoResolution</code>
| Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|-
| <code>VideoPlayer.VideoAspect</code>
| Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|-
| <code>VideoPlayer.AudioCodec</code>
| Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|-
| <code>VideoPlayer.AudioChannels</code>
| Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|-
| <code>VideoPlayer.AudioLanguage</code>
| Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
|
|-
| <code>VideoPlayer.SubtitlesLanguage</code>
| Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|-
| <code>VideoPlayer.StereoscopicMode</code>
| Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|-
| <code>VideoPlayer.EndTime</code>
| End date of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.NextTitle</code>
| Title of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextGenre</code>
| Genre of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlot</code>
| Plot of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextPlotOutline</code>
| Plot outline of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextStartTime</code>
| Start time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextEndTime</code>
| End time of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.NextDuration</code>
| Duration of the programme that will be played next (PVR).
|
|-
| <code>VideoPlayer.ChannelName</code>
| Name of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ChannelNumberLabel</code>
| Channel and subchannel number of the tv channel that's currently playing (PVR).
|
|-
| <code>VideoPlayer.ChannelGroup</code>
| Group of the curently tuned channel (PVR).
|
|-
| <code>VideoPlayer.ParentalRating</code>
| Parental rating of the currently playing programme (PVR).
|
|-
| <code>VideoPlayer.DBID</code>
| The database id of the currently playing video. (supports .offset() and .position())
| v17
|-
| <code>VideoPlayer.UniqueID()</code>
| Returns the UniqueID of the currently playing video
| v19
|-
| <code>VideoPlayer.TvShowDBID</code>
| Returns the tv show DBID of the currently playing episode
| v19
|}

=== Playlist ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Playlist.Length(media)</code>
| Total size of the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Position(media)</code>
| Position of the current item in the current playlist. optional parameter media is either video or music.
|
|-
| <code>Playlist.Random</code>
| Returns 'On' or 'Off'
|
|-
| <code>Playlist.Repeat</code>
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>PVR.NowRecordingTitle</code>
| Title of the programme being recorded
|
|-
| <code>PVR.NowRecordingDateTime</code>
| Start date and time of the current recording
|
|-
| <code>PVR.NowRecordingChannel</code>
| Channel number that's being recorded
|
|-
| <code>PVR.NextRecordingTitle</code>
| Title of the next programme that will be recorded
|
|-
| <code>PVR.NextRecordingDateTime</code>
| Start date and time of the next recording
|
|-
| <code>PVR.NextRecordingChannel</code>
| Channel name of the next recording
|
|-
| <code>PVR.BackendName</code>
| Name of the backend being used
|
|-
| <code>PVR.BackendVersion</code>
| version of the backend that's being used
|
|-
| <code>PVR.BackendHost</code>
| Backend hostname
|
|-
| <code>PVR.BackendDiskSpace</code>
| Available diskspace on the backend
|
|-
| <code>PVR.BackendChannels</code>
| Number of available channels the backend provides
|
|-
| <code>PVR.BackendTimers</code>
| Number of timers set for the backend
|
|-
| <code>PVR.BackendRecordings</code>
| Number of recording available on the backend
|
|-
| <code>PVR.BackendDiskspace</code>
| Free diskspace available for recordings on the backend
|
|-
| <code>PVR.BackendNumber</code>
| Backend number
|
|-
| <code>PVR.ClientCount</code>
| Number of PVR clients enabled
| v22
|-
| <code>PVR.TotalDiscSpace</code>
| Total diskspace available for recordings
|
|-
| <code>PVR.NextTimer</code>
| Next timer date
|
|-
| <code>PVR.EpgEventDuration[(format)]</code>
| Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventElapsedTime[(format)]</code>
| Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.EpgEventRemainingTime[(format)]</code>
| Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventFinishTime[(format)]</code>
| Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventSeekTime[(format)]</code>
| Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
| v18
|-
| <code>PVR.EpgEventProgress</code>
| Returns the position of currently played title on TV as integer
|
|-
| <code>PVR.TimeShiftStart[(format)]</code>
| Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftEnd[(format)]</code>
| End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftCur[(format)]</code>
| Current position of the timeshift. See ListItem.Duration for optinional formatting options
|-
| <code>PVR.TimeShiftOffset[(format)]</code>
| Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
| <code>PVR.TimeShiftProgress</code>
| Returns the position of currently timeshifted title on TV as interger
|
|-
| <code>PVR.ActStreamClient</code>
| Stream client name
|
|-
| <code>PVR.ActStreamDevice</code>
| Stream device name
|
|-
| <code>PVR.ActStreamStatus</code>
| Status of the stream
|
|-
| <code>PVR.ActStreamSignal</code>
| Signal quality of the stream
|
|-
| <code>PVR.ActStreamSnr</code>
| Signal to noise ratio of the stream
|
|-
| <code>PVR.ActStreamBer</code>
| Bit error rate of the stream
|
|-
| <code>PVR.ActStreamUnc</code>
| UNC value of the stream
|
|-
| <code>PVR.ActStreamVideoBitRate</code>
| Video bitrate of the stream
|
|-
| <code>PVR.ActStreamAudioBitRate</code>
| Audio bitrate of the stream
|
|-
| <code>PVR.ActStreamDolbyBitRate</code>
| Dolby bitrate of the stream
|
|-
| <code>PVR.ActStreamProgrSignal</code>
| Signal quality of the programme
|
|-
| <code>PVR.ActStreamProgrSnr</code>
| Signal to noise ratio of the programme
|
|-
| <code>PVR.ActStreamEncryptionName</code>
| Encryption used on the stream
|
|-
| <code>PVR.TVNowRecordingTitle</code>
| Title of the tv programme being recorded
| v17
|-
| <code>PVR.TVNowRecordingDateTime</code>
| Start date and time of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannel</code>
| Channel name of the current tv recording
| v17
|-
| <code>PVR.TVNowRecordingChannelIcon</code>
| Icon of the current recording TV channel
| v17
|-
| <code>PVR.TVNextRecordingTitle</code>
| Title of the next tv programme that will be recorded
| v17
|-
| <code>PVR.TVNextRecordingDateTime</code>
| Start date and time of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannel</code>
| Channel name of the next tv recording
| v17
|-
| <code>PVR.TVNextRecordingChannelIcon</code>
| Icon of the next recording tv channel
| v17
|-
| <code>PVR.RadioNowRecordingTitle</code>
| Title of the radio programme being recorded
| v17
|-
| <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannel</code>
| Channel name of the current radio recording
| v17
|-
| <code>PVR.RadioNowRecordingChannelIcon</code>
| Icon of the current recording radio channel
| v17
|-
| <code>PVR.RadioNextRecordingTitle</code>
| Title of the next radio programme that will be recorded
| v17
|-
| <code>PVR.RadioNextRecordingDateTime</code>
| Start date and time of the next radio recording
| v17
|-
| <code>PVR.RadioNextRecordingChannel</code>
| Channel name of the next radio recording
| v17
|-
| <code>PVR.ChannelNumberInput</code>
| Label displaying the number the user entered on remote or keyboard
| v18
|-
| <code>PVR.TimeshiftProgressDuration</code>
| Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressDuration(format)</code>
| Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressStartTime</code>
| Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressStartTime(format)</code>
| Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressEndTime</code>
| Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
| v18
|-
| <code>PVR.TimeshiftProgressEndTime(format)</code>
| Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
| v18
|-
| <code>PVR.TimeshiftProgressPlayPos</code>
| Returns the percentage of the current play position within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgStart</code>
| Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressEpgEnd</code>
| Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferStart</code>
| Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeshiftProgressBufferEnd</code>
| Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
| v18
|-
| <code>PVR.TimeShiftSeekbar</code>
| This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
| v19
|}

=== RDS ===
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>RDS.AudioLanguage</code>
| The from RDS reported audio language of channel
|
|-
| <code>RDS.ChannelCountry</code>
| Country where the radio channel is sended
|
|-
| <code>RDS.GetLine(number)</code>
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| <code>RDS.Title</code>
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Artist</code>
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Band</code>
| Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Composer</code>
| Name of the original composer/author (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Conductor</code>
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|-
| <code>RDS.Album</code>
| The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|-
| <code>RDS.TrackNumber</code>
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|-
| <code>RDS.RadioStyle</code>
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| <code>RDS.Comment</code>
| Radio station comment string if available (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNews</code>
| Message / headline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoNewsLocal</code>
| Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStock</code>
| Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoStockSize</code>
| Number of rows present in stock information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSport</code>
| Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoSportSize</code>
| Number of rows present in sport information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLottery</code>
| Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoLotterySize</code>
| Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeather</code>
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoWeatherSize</code>
| Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinema</code>
| Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoCinemaSize</code>
| Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscope</code>
| Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoHoroscopeSize</code>
| Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOther</code>
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.InfoOtherSize</code>
| Number of rows present with other informations (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStation</code>
| Name of the radio channel@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNow</code>
| Now played program name@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgNext</code>
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| <code>RDS.ProgHost</code>
| Name of the host of the radio show
|
|-
| <code>RDS.ProgEditStaff</code>
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgHomepage</code>
| Link to radio station homepage (Only be available on RadiotextPlus)
|
|-
| <code>RDS.ProgStyle</code>
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| <code>RDS.PhoneHotline</code>
| The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|-
| <code>RDS.PhoneStudio</code>
| The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|-
| <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailHotline</code>
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|-
| <code>RDS.EmailStudio</code>
| The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|}

=== Skin ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Skin.CurrentTheme</code>
| Returns the current selected skin theme.
|
|-
| <code>Skin.CurrentColourTheme</code>
| Returns the current selected colour theme of the skin.
|
|-
| <code>Skin.Font</code>
| Returns the current fontset from Font.xml.
| v18 addition
|-
| <code>Skin.String(name)</code>
| Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|-
| <code>Skin.AspectRatio</code>
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|}

=== Slideshow ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Slideshow.Altitude</code>
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| <code>Slideshow.Aperture</code>
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| <code>Slideshow.Author</code>
| Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| <code>Slideshow.Byline</code>
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| <code>Slideshow.BylineTitle</code>
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| <code>Slideshow.CameraMake</code>
| Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| <code>Slideshow.CameraModel</code>
| Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| <code>Slideshow.Caption</code>
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| <code>Slideshow.Category</code>
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| <code>Slideshow.CCDWidth</code>
| Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| <code>Slideshow.City</code>
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| <code>Slideshow.Colour</code>
| Shows whether the current picture is "Colour" or "Black and White".
|
|-
| <code>Slideshow.CopyrightNotice</code>
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| <code>Slideshow.Country</code>
| Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| <code>Slideshow.CountryCode</code>
| Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| <code>Slideshow.Credit</code>
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| <code>Slideshow.DigitalZoom</code>
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
|
|-
| <code>Slideshow.EXIFComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| <code>Slideshow.EXIFDate</code>
| Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.EXIFDescription</code>
| Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| <code>Slideshow.EXIFSoftware</code>
| Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
| <code>Slideshow.EXIFTime</code>
| Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Exposure</code>
| Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| <code>Slideshow.ExposureBias</code>
| Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| <code>Slideshow.ExposureMode</code>
| Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| <code>Slideshow.ExposureTime</code>
| Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| <code>Slideshow.Filedate</code>
| Shows the file date of the current picture
|
|-
| <code>Slideshow.Filename</code>
| Shows the file name of the current picture
|
|-
| <code>Slideshow.Filesize</code>
| Shows the file size of the current picture
|
|-
| <code>Slideshow.FlashUsed</code>
| Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| <code>Slideshow.FocalLength</code>
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| <code>Slideshow.FocusDistance</code>
| Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
| <code>Slideshow.Headline</code>
| Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| <code>Slideshow.ImageType</code>
| Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| <code>Slideshow.IPTCDate</code>
| Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| <code>Slideshow.ISOEquivalence</code>
| Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| <code>Slideshow.Keywords</code>
| Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| <code>Slideshow.Latitude</code>
| Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| <code>Slideshow.LightSource</code>
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| <code>Slideshow.LongEXIFDate</code>
| Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.LongEXIFTime</code>
| Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| <code>Slideshow.Longitude</code>
| Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| <code>Slideshow.MeteringMode</code>
| Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| <code>Slideshow.ObjectName</code>
| Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| <code>Slideshow.Orientation</code>
| Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| <code>Slideshow.Path</code>
| Shows the file path of the current picture
|
|-
| <code>Slideshow.Process</code>
| Shows the process used to compress the current picture
|
|-
| <code>Slideshow.ReferenceService</code>
| Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| <code>Slideshow.Resolution</code>
| Shows the dimensions of the current picture (Width x Height)
|
|-
| <code>Slideshow.SlideComment</code>
| Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
| <code>Slideshow.SlideIndex</code>
| Shows the slide index of the current picture
|
|-
| <code>Slideshow.Source</code>
| Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| <code>Slideshow.SpecialInstructions</code>
| Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| <code>Slideshow.State</code>
| Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| <code>Slideshow.Sublocation</code>
| Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| <code>Slideshow.SupplementalCategories</code>
| Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| <code>Slideshow.TimeCreated</code>
| Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| <code>Slideshow.TransmissionReference</code>
| Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| <code>Slideshow.Urgency</code>
| Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| <code>Slideshow.WhiteBalance</code>
| Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}

=== System ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>System.Time</code>
| Current time
|
|-
| <code>System.Time(format)</code>
| Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
| <code>System.Date</code>
| Current date
|
|-
| <code>System.Date(format)</code>
| Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
| <code>System.AlarmPos</code>
| Shutdown Timer position
|
|-
| <code>System.BatteryLevel</code>
| Returns the remaining battery level in range 0-100
|
|-
| <code>System.FreeSpace</code>
| Total Freespace on the drive
|
|-
| <code>System.UsedSpace</code>
| Total Usedspace on the drive
|
|-
| <code>System.TotalSpace</code>
| Totalspace on the drive
|
|-
| <code>System.UsedSpacePercent</code>
| Total Usedspace Percent on the drive
|
|-
| <code>System.FreeSpacePercent</code>
| Total Freespace Percent on the drive
|
|-
| <code>System.CPUTemperature</code>
| Current CPU temperature
|
|-
| <code>System.CpuUsage</code>
| Displays the cpu usage for each individual cpu core.
|
|-
| <code>System.CoreUsage(id)</code>
| Displays the usage of the cpu core with the given 'id'
|
|-
| <code>System.GPUTemperature</code>
| Current GPU temperature
|
|-
| <code>System.FanSpeed</code>
| Current fan speed
|
|-
| <code>System.BuildVersion</code>
| version of build
|
|-
| <code>System.BuildDate</code>
| Date of build
|
|-
| <code>System.FriendlyName</code>
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
| <code>System.FPS</code>
| Current rendering speed (frames per second)
|
|-
| <code>System.FreeMemory</code>
| Amount of free memory in Mb
|
|-
| <code>System.Memory(format)</code>
| Available formats: used, used.percent, free, free.percent, total
|
|-
| <code>System.ScreenMode</code>
| Screenmode (e.g. windowed / fullscreen)
|
|-
| <code>System.ScreenWidth</code>
| Width of screen in pixels
|
|-
| <code>System.ScreenHeight</code>
| Height of screen in pixels
|
|-
| <code>System.StartupWindow</code>
| The Window Kodi will load on startup
|
|-
| <code>System.CurrentWindow</code>
| Current Window we are in
|
|-
| <code>System.CurrentControl</code>
| Current focused control
|
|-
| <code>System.CurrentControlID</code>
| ID of the currently focused control.
|
|-
| <code>System.DVDLabel</code>
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| <code>System.HddTemperature</code>
| Hdd temperature
|
|-
| <code>System.OSVersionInfo</code>
| System name + kernel version
|
|-
| <code>System.KernelVersion (deprecated)</code>
| System name + kernel version
|
|-
| <code>System.Uptime</code>
| System current uptime
|
|-
| <code>System.TotalUptime</code>
| System total uptime
|
|-
| <code>System.CpuFrequency</code>
| System cpu frequency
|
|-
| <code>System.ScreenResolution</code>
| Screen resolution
|
|-
| <code>System.VideoEncoderInfo</code>
| video encoder info
|
|-
| <code>System.InternetState</code>
| Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
| <code>System.Language</code>
| Shows the current language
|
|-
| <code>System.ProfileName</code>
| Shows the User name of the currently logged in Kodi user
|
|-
| <code>System.ProfileCount</code>
| Shows the number of defined profiles
|
|-
| <code>System.ProfileAutoLogin</code>
| The profile Kodi will auto login to
|
|-
| <code>System.Progressbar</code>
| The percentage of the currently active progress.
|
|-
| <code>System.StereoscopicMode</code>
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| <code>System.TemperatureUnits</code>
| Shows Celsius or Fahrenheit symbol
|
|-
| <code>System.AddonTitle(id)</code>
| Returns the title of the addon with the given id
|
|-
| <code>System.AddonVersion(id)</code>
| Returns the version of the addon with the given id
|
|-
| <code>System.BuildVersionCode</code>
| The internal version of the kodi build
| v19
|-
| <code>System.BuildVersionGit</code>
| The git version (sha) of the kodi build
| v19
|-
| <code>System.AddonUpdateCount</code>
| The number of available addon updates
| v19
|}

=== Visualisation ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Visualisation.Preset</code>
| Shows the current preset of the visualisation.
|
|-
| <code>Visualisation.Name</code>
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Weather.Conditions</code>
| Current weather conditions – this is looked up in a background process.
|
|-
| <code>Weather.Temperature</code>
| Current weather temperature
|
|-
| <code>Weather.Location</code>
| City/town which the above two items are for
|
|-
| <code>Weather.fanartcode</code>
| Current weather fanartcode.
|
|-
| <code>Weather.plugin</code>
| Current weather plugin.
|
|}

=== Window ===

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window.Property(xmlfile)</code>
| Displays the name of the xml file currently shown
|
|-
| <code>Window.Property(IsRadio)</code>
| Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
| <code>Window(AddonBrowser).Property(Updated)</code>
| Shows the date and time the addon repo was last checked for updates
|
|-
| <code>Window.Property(Addon.ID)</code>
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| <code>Window(Home).Property(key)</code>
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|}

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
| <code>ListItem.Art(type)</code>
| Artwork for the current listitem.
|
|-
| <code>Fanart.Image</code>
| Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>ListItem.Thumb</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
| <code>ListItem.Icon</code>
| Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
| <code>ListItem.ActualIcon</code>
| Shows the default icon of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.Overlay</code>
| Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
| <code>ListItem.EPGEventIcon</code>
| Returns the icon of the EPG programme (if available).
| v18
|-
| <code>ListItem.Property(Fanart_Image)</code>
| Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
| <code>MusicPlayer.Cover</code>
| Cover of currently playing album
|
|-
| <code>MusicPlayer.Property(Fanart_Image)</code>
| Fanart image of the currently playing artist
|
|-
| <code>Player.Art(type)</code>
| Artwork for the currently playing item.
|
|-
| <code>Player.Icon</code>
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon.
| v18
|-
| <code>Player.StarRating</code>
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
|
|-
| <code>Pvr.NowRecordingChannelIcon</code>
| Channel icon of the programme currently being recorded.
|
|-
| <code>Pvr.NextRecordingChannelIcon</code>
| Channel icon of the programme that will be recorded next.
|
|-
| <code>Pvr.EPGEventIcon</code>
| Returns the icon of the currently playing EPG programme (if available).
| v18
|-
| <code>Skin.String(name)</code>
| Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
|
|-
| <code>System.AddonIcon(id)</code>
| Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
|
|-
| <code>System.ProfileThumb</code>
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| <code>VideoPlayer.Cover</code>
| Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
|
|-
| <code>Weather.ConditionsIcon</code>
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| <code>Window([window]).Property(key)</code>
| Window property. (key can be any value, optional window can be id or name)
|
|-
| <code>Window(Weather).Property(key)</code>
| The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|}

<section end="main content" />

{{top}}

[[Category:Skin development]]
[[Category:Add-on development]]

Smart playlists/Rules and groupings

2025-04-11T22:05:26Z

Crystalp:

{{:Smart_playlists/Contents}}
{{mininav|[[Playlists]] | [[Smart playlists]] }}

This page lists the available attributes and operators that can be used in Smart Playlist XSP files. What can be used is dependent on the playlist type and rules.

For a complete Master list see '''[https://github.com/xbmc/xbmc/blob/master/xbmc/playlists/SmartPlayList.cpp Smart Playlists on Github]'''

= Grouping =
Available fields for grouping. Availability depends upon the playlist type in use.

* none
* sets
* genres
* years
* actors
* directors
* writers
* studios
* countries
* artists
* albums
* tags
* originalyears

= Operators =
The operators available will depend on the selected <code>field</code>.

The <code>operator</code> attribute specifies the rule that should be used to match the parameter to the <code>field</code>. All matching is done case-insensitive. The allowed operators are:

{| class="prettytable" style="margin-right: 0;"
! <code>operator</code>
! Definition
|-
| contains
| True if the field contains the parameter as a substring
|-
| doesnotcontain
| True if the field does not contain the parameter as a substring
|-
| is
| True if the field matches the parameter exactly
|-
| isnot
| True if the field does not match the parameter exactly
|-
| startswith
| True if the start of the field matches the parameter
|-
| endswith
| True if the end of the field matches the parameter
|-
| lessthan
| True if the content of the field is less than the parameter
|-
| greaterthan
| True if the content of the field is greater than the parameter
|-
| after
| True if the content of the field comes after the parameter
|-
| before
| True if the content of the field comes before the parameter
|-
| inthelast
| True if the field falls in the last range specified by the parameter. Only applicable for a date field.
|-
| notinthelast
| True if the field does not fall in the last range specified by the parameter. Only applicable for a date field.
|}

= Fields =

== Songs ==

* Genre
* Source
* Album
* DiscTitle
* Artist
* AlbumArtist
* Title
* Year
* OrigYear
* Time
* TrackNumber
* Filename
* Path
* Playcount
* LastPlayed
* Rating
* UserRating
* Comment
* Moods
* BPM
* SampleRate
* MusicBitRate
* NoOfChannels
* DateAdded
* DateModified
* DateNew

== Albums ==
* Genre
* Source
* Album
* DiscTitle
* TotalDiscs
* IsBoxset
* Artist
* AlbumArtist
* Year
* OrigYear
* AlbumDuration
* Review
* Themes
* Moods
* Styles
* Compilation
* AlbumType
* MusicLabel
* Rating
* UserRating
* Playcount
* LastPlayed
* Path
* AlbumStatus
* DateAdded
* DateModified
* DateNew

== Artists ==
* Artist
* Source
* Genre
* Moods
* Styles
* Instruments
* Biography
* ArtistType
* Gender
* Disambiguation
* Born
* BandFormed
* Disbanded
* Died
* Role
* Path
* DateAdded
* DateModified
* DateNew

== TV Shows ==
* Title
* OriginalTitle
* Plot
* TvShowStatus
* Votes
* Rating
* UserRating
* Year
* Genre
* Director
* Actor
* NumberOfEpisodes
* NumberOfWatchedEpisodes
* Playcount
* Path
* Studio
* MPAA
* DateAdded
* LastPlayed
* InProgress
* Tag

== Episodes ==
* Title
* TvShowTitle
* OriginalTitle
* Plot
* Votes
* Rating
* UserRating
* Time
* Writer
* AirDate
* Playcount
* LastPlayed
* InProgress
* Genre
* Year // premiered
* Director
* Actor
* EpisodeNumber
* Season
* Filename
* Path
* Studio
* MPAA
* DateAdded
* Tag
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Movies ==
* Title
* OriginalTitle
* Plot
* PlotOutline
* Tagline
* Votes
* Rating
* UserRating
* Time
* Writer
* Playcount
* LastPlayed
* InProgress
* Genre
* Country
* Year // premiered
* Director
* Actor
* MPAA
* Top250
* Studio
* Trailer
* Filename
* Path
* Set
* Tag
* DateAdded
* Has multiple versions (v22)
* Has extras (v22)
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Music Videos ==
* Title
* Genre
* Album
* Year
* Artist
* Filename
* Path
* Playcount
* LastPlayed
* Rating
* UserRating
* Time
* Director
* Studio
* Plot
* Tag
* DateAdded
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Other ==
* Playlist
* VirtualFolder

{{top}}

{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Smart playlists/Rules and groupings

2025-04-11T22:04:23Z

Crystalp: added the new rules has multiple versions / extras of PR #25979

{{:Smart_playlists/Contents}}
{{mininav|[[Playlists]] | [[Smart playlists]] }}

This page lists the available attributes and operators that can be used in Smart Playlist XSP files. What can be used is dependent on the playlist type and rules.

For a complete Master list see '''[https://github.com/xbmc/xbmc/blob/master/xbmc/playlists/SmartPlayList.cpp Smart Playlists on Github]'''

= Grouping =
Available fields for grouping. Availability depends upon the playlist type in use.

* none
* sets
* genres
* years
* actors
* directors
* writers
* studios
* countries
* artists
* albums
* tags
* originalyears

= Operators =
The operators available will depend on the selected <code>field</code>.

The <code>operator</code> attribute specifies the rule that should be used to match the parameter to the <code>field</code>. All matching is done case-insensitive. The allowed operators are:

{| class="prettytable" style="margin-right: 0;"
! <code>operator</code>
! Definition
|-
| contains
| True if the field contains the parameter as a substring
|-
| doesnotcontain
| True if the field does not contain the parameter as a substring
|-
| is
| True if the field matches the parameter exactly
|-
| isnot
| True if the field does not match the parameter exactly
|-
| startswith
| True if the start of the field matches the parameter
|-
| endswith
| True if the end of the field matches the parameter
|-
| lessthan
| True if the content of the field is less than the parameter
|-
| greaterthan
| True if the content of the field is greater than the parameter
|-
| after
| True if the content of the field comes after the parameter
|-
| before
| True if the content of the field comes before the parameter
|-
| inthelast
| True if the field falls in the last range specified by the parameter. Only applicable for a date field.
|-
| notinthelast
| True if the field does not fall in the last range specified by the parameter. Only applicable for a date field.
|}

= Fields =

== Songs ==

* Genre
* Source
* Album
* DiscTitle
* Artist
* AlbumArtist
* Title
* Year
* OrigYear
* Time
* TrackNumber
* Filename
* Path
* Playcount
* LastPlayed
* Rating
* UserRating
* Comment
* Moods
* BPM
* SampleRate
* MusicBitRate
* NoOfChannels
* DateAdded
* DateModified
* DateNew

== Albums ==
* Genre
* Source
* Album
* DiscTitle
* TotalDiscs
* IsBoxset
* Artist
* AlbumArtist
* Year
* OrigYear
* AlbumDuration
* Review
* Themes
* Moods
* Styles
* Compilation
* AlbumType
* MusicLabel
* Rating
* UserRating
* Playcount
* LastPlayed
* Path
* AlbumStatus
* DateAdded
* DateModified
* DateNew

== Artists ==
* Artist
* Source
* Genre
* Moods
* Styles
* Instruments
* Biography
* ArtistType
* Gender
* Disambiguation
* Born
* BandFormed
* Disbanded
* Died
* Role
* Path
* DateAdded
* DateModified
* DateNew

== TV Shows ==
* Title
* OriginalTitle
* Plot
* TvShowStatus
* Votes
* Rating
* UserRating
* Year
* Genre
* Director
* Actor
* NumberOfEpisodes
* NumberOfWatchedEpisodes
* Playcount
* Path
* Studio
* MPAA
* DateAdded
* LastPlayed
* InProgress
* Tag

== Episodes ==
* Title
* TvShowTitle
* OriginalTitle
* Plot
* Votes
* Rating
* UserRating
* Time
* Writer
* AirDate
* Playcount
* LastPlayed
* InProgress
* Genre
* Year // premiered
* Director
* Actor
* EpisodeNumber
* Season
* Filename
* Path
* Studio
* MPAA
* DateAdded
* Tag
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Movies ==
* Title
* OriginalTitle
* Plot
* PlotOutline
* Tagline
* Votes
* Rating
* UserRating
* Time
* Writer
* Playcount
* LastPlayed
* InProgress
* Genre
* Country
* Year // premiered
* Director
* Actor
* MPAA
* Top250
* Studio
* Trailer
* Filename
* Path
* Set
* Tag
* DateAdded
* Has multiple versions
* Has extras
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Music Videos ==
* Title
* Genre
* Album
* Year
* Artist
* Filename
* Path
* Playcount
* LastPlayed
* Rating
* UserRating
* Time
* Director
* Studio
* Plot
* Tag
* DateAdded
* VideoResolution
* AudioChannels
* AudioCount
* SubtitleCount
* VideoCodec
* AudioCodec
* AudioLanguage
* SubtitleLanguage
* VideoAspectRatio
* HdrType

== Other ==
* Playlist
* VirtualFolder

{{top}}

{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

MySQL/Setting up MySQL

2025-02-13T16:16:49Z

Crystalp: /* Docker */

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or NAS will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Do not manually create the MySQL/MariaDB databases on your database server. Set up the MySQL/MariaDB server, and Kodi will create the specific databases for you.}}
{{redv|'''Also:'''| Some versions of MySQL set their passwords to expire by default, '''even the root password'''! If the password expires, Kodi cannot access the database and the TV Series and Movies libraries will disappear.<br />
To avoid this and/or fix it after it happens, make sure the account's password does not expire. (See: https://dev.mysql.com/doc/refman/5.7/en/password-management.html )}}

MySQL/MariaDB can be installed on just about every major OS and NAS:

{{redv|'''Important:'''| Please use only supported versions of the MySQL or MariaDB server. As of January 2019, this is MySQL in at least version 5.7 or MariaDB in at least version 5.5, but version 10.3+ is recommended.}}

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/18.04/serverguide/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/mysql.conf.d/mysqld.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#When using MySQL8 or higher (Ubuntu 20.04 or later), add the following line at the end of ''/etc/mysql/mysql.conf.d/mysqld.cnf'':
##<code>default_authentication_plugin=mysql_native_password</code>
##*Note: When using MariaDB this is the default, so you don't need to set it separately
#Restart your MySQL server. <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##*Note: When using MySQL8 or higher, there are additional password requirements and new authentication methods. Using the following command should avoid errors. Type in: <code>CREATE USER 'kodi' IDENTIFIED WITH mysql_native_password BY 'kodi123#';</code> and press return
##*Note: If the above command throws the error <code>ERROR 1064 (42000): You have an error in your SQL syntax;</code> (could happen if using MariaDB 10.5) try this one: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Debian Linux=
'''Debian Linux:'''
#Login as root with <code>$ su -</code>
#<code># apt-get install mariadb-server</code>
#To configure MySQL/MariaDB to listen for connections from network hosts, edit ''/etc/mysql/mariadb.conf.d/50-server.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL/MariaDB host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL/MariaDB server. <code># systemctl restart mariadb</code>
#Get into the MySQL command line utility: <code># mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED VIA mysql_native_password USING PASSWORD('kodi123#');</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>exit</code> or <code>\q</code>
#Logout as root with <code># exit</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address:<br /><code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RaspberryPi Raspbian=

'''RaspberryPi Raspbian:'''
#<code>$sudo apt-get update && sudo apt-get dist-upgrade</code> to ensure that you have the very latest iteration of Raspbian. ''(September 2017 as of writing this)''
#<code>$sudo apt-get install mysql-server</code> to install ''MYSQL Server''.
#To configure MySQL to listen for connections from network hosts, <code>$sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf</code> and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server: <code>sudo service mysql restart</code>
#Get into the MySQL command line utility: <code>sudo mysql</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from https://dev.mysql.com/downloads/windows/installer/8.0.html
#Select ''Archives'' when you want the last stable main version 5.7.36 instead of version 8.0.x.
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}}<br/>
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[Setting_up_MySQL|Arch Linux instructions]] on this page.
*[https://web.archive.org/web/20160329053954/http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

After setting up a database server on you NAS, you should create a Kodi user with full administrative privileges. The user should be able to log in from your Kodi devices, so make sure you give the user login access from external machines.
You do not need to create a database as Kodi will create the required databases itself.

{{redv|'''Warning:'''| As you are giving the Kodi user full administrative privileges and external machine access it is recommended that you review your database security. It is highly recommenced that you block internet access to your database using an appropriate firewall. }}

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Docker=
'''Mariadb in Docker Container:'''

If you are new to Docker, first install Docker for your specific OS. Containers are OS independent - see https://www.docker.com/ for more general information about Docker.

If you don't have one already, create a docker-compose.yaml file.

Here's an example service definition for a mariadb container using the offical MariaDB LTS (Long Term Support) image:

services:
mariadb:
image: mariadb:lts
container_name: mariadb
ports:
- 3306:3306
volumes:
- /your/host/path/to/database/files/:/var/lib/mysql
- /your/host/path/to/mariadb/configuration/files:/config
environment:
- MYSQL_ROOT_PASSWORD="YOUR_MARIADB_ROOT_PASSWORD"
- MYSQL_PASSWORD=kodi
- MYSQL_USER=kodi
- MARIADB_AUTO_UPGRADE=
restart: unless-stopped

To bring the new container up, (in folder where docker-compose.yaml is located):
<code>sudo docker compose up -d mariadb</code>

This will create a root user with the password you gave in the Docker Compose file. It will also create a user called "kodi" (please note that you can use any username you want - default is usually "kodi" with a password of "kodi"). The kodi user will NOT have appropriate access until you grant the correct privileges.

So, with the container running:

<code>sudo docker exec -it mariadb bash</code> (to access a shell inside the container).

Then, in that shell, run:

<code>mariadb -u root -p</code> (enter root password from Docker Compose file)

Type:
<code>GRANT ALL PRIVILEGES ON *.* TO 'kodi' IDENTIFIED BY 'kodi' WITH GRANT OPTION;</code>

Then type:
<code>FLUSH PRIVILEGES;</code>

Then you can exit the mariadb shell.

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.

'''Upto MySQL Server 5.7 Server:'''
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

'''As per MySQL 8.0 Server and upwards:'''
#<code>GRANT ALL PRIVILEGES ON `MyVideos%`.* TO `kodi`@`%`;</code>
#<code>GRANT ALL PRIVILEGES ON `MyMusic%`.* TO `kodi`@`%`;</code>

{{redv|'''Careful'''|The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade. '''Kodi requires these TRIGGERs to function properly.''' <br />
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to. <br>
Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{Isengard updated}}

Video extras

2024-12-05T00:59:06Z

Crystalp:

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />Video Extras is a new feature to handle Extra video material, such as bloopers, alternate endings, interviews etc. It was introduced in v21 as part of the Video Versions feature.

Many users are familiar with the existing '''[[Add-on:Extras | Extras addon]]'''. Video Extras is the core version of the addon which provides greater flexibility to skinners to determine when Extras are available and provide icons in the library views to indicate their presence.

Video Extras and the Extras add-on are both compatible with each other, and one won't affect the other if both are in use.<section end="intro" />

This feature works on the movie library and may be expanded to TV shows in a later release of {{kodi}}.

'''Note:''' Video Extras requires movie folders and cannot be used with a flat folder structure.

= Settings =
There are two settings that control the use of Video Extras.
# a GUI setting that controls what to do when the Extra folder is found during a Library Update.
# An '''[[Advancedsettings.xml | advancedsettings.xml]]''' entry that prevents Extras from being added to the library as movies when the GUI setting is ''Enabled''.

== GUI Setting ==
{{#lst:Settings/Media/Library|IgnoreVideoExtrasScan}}

== Advancedsetting.xml ==
Extras are video files the same way the main feature movie is a video file. This may cause Kodi to see your Extras as additional movies when the GUI setting above is ''Enabled''. To prevent each Extras video file being scraped as a movie, and adding random or duplicated movies into your library, you must tell Kodi not to scrape the Extras folder.

A number of methods are available. A listing is found here '''''[[Updating_or_removing_videos#Exclude|Excluding folders and file types]]''''' or use the '''[[Advancedsettings.xml]]''' method using the code below by simply copying and pasting the following code into your [[Advancedsettings.xml]] file. If you already have an advancedsettings.xml file, do not duplicate the <advancedsettings></advancedsettings> tags.
<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<video>

<excludefromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>

</video>
</advancedsettings>
</syntaxhighlight>

= Setup =
Before running the Library Update, ensure the Extras folder has been created in the correct location. Only a folder named '''\Extras\''' will be recognized by the scanner.

The Extras folder must be located in the same folder as your movie video file for the {{kodi}} scanner to find it. Some typical examples are listed below.

=== Single Movie Folders ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\'''Extras'''\

=== DVD Structure ===
...\MyMovies\Chronicles of Riddick\
...\MyMovies\Chronicles of Riddick\AUDIO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\'''Extras'''\

=== Bluray Structure ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\BDMV\
...\MyMovies\Lucy (2014)\BDMV\'''Extras'''\

=== Nested Folders ===
Sub-folders in the Extras folder are allowed, making it easier to organise Extras for quicker access.

An example of this is shown in the following image. When scanned, and using the first file as an example, the listing will be named ''Bloopers\Blooper Reel 1''

<gallery mode="packed" widths="600px" heights="337px">
File:VideoExtras007.jpg| '''Image 1'''- An example of sub-folders in the Extras folder
</gallery>

=== Artwork ===

Local artwork provided next to video extras files is recognized in file browsing through Videos (v21) and is imported into the library (new in v22).

The naming convention is the same that is used for movies, using the video extra file name as the movie name. For more details see '''[[Movie_artwork|Movie Artwork]]'''.

There is no support for video extras art in scrapers. The displayed artwork depends on the skin used.

= Extras Manager =
The Extras Manager is accessed from the Information page as shown in the below images

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 2'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras005.jpg| '''Image 3'''- The Extras Manager with Extras added.
</gallery>

== Play ==
Play the selected title.

== Add Extra ==
The manual method of adding Extras to the manager by navigating through your file system.

See the Adding Extras ► Manual section below.

== Choose Art ==
Allows the changing of artwork for the highlighted Extra. Which artwork is displayed is skin dependent.

== Rename ==
Change the title of the selected Extra

== Remove ==
Remove an Extra from the manager. It will not delete files from the file system. The setting '''[[Settings/Media/General#Allow_file_renaming_and_deletion| Allow file renaming and deletion]]''' has no effect.

Be aware that running an Update Library may rescan the removed title back into the library, depending on your settings.

= Adding Extras =
There are two methods to scan Extras into the Extras library:
# Running the regular Update Library or Scan item to library.
# Manually adding items.

== Library Update ==
When the above-mentioned GUI setting is ''Disabled'', the {{kodi}} scanner, in addition to searching for video files, artwork, nfo files and trailers, will also search for the ''Extras'' folder and any video files in the folder will be added to the Extras Manager.

'''Note:''' There is a known bug in v21 related to the hash of the video files which may prevent Extras from being scanned. There is a fix for v22, which may be backported to v21.x

== Manual ==
Extras can also be added manually. This is performed via the Extras Manager as detailed in the following screenshots.

When using this manual mode, it is possible to add Extras located in the Extras folder of other movies, or saved elsewhere that is accessible to {{kodi}}.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 4'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras001.jpg| '''Image 5'''- In the Extras Manager, select '''Add extra'''
File:VideoExtras002.jpg| '''Image 6'''- Select '''* Item folder''' to jump to the movie folder, or navigate to another location using the remaining options.
File:VideoExtras003.jpg| '''Image 7'''- Select the '''Extras''' folder
File:VideoExtras004.jpg| '''Image 8'''- From this screen, highlight an Extra to add to the Extras library one at a time.
File:VideoExtras005.jpg| '''Image 9'''- The Extras Manager with Extras added.
</gallery>

= Playing Extras =
Accessing Extras for playback is accomplished using one of the following methods...

# Accessing the Extras Manager (detailed above) and pressing play after selecting the Extra to play
# When a movie contains Extras, pressing play using any method will display the '''Choose version''' dialogue. From this screen you can choose to either play the movie or select Extras for the '''Choose extra''' dialogue.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras008.jpg| '''Image 10'''- From the ''Choose version'' dialogue, select ''Extras''
File:VideoExtras009.jpg| '''Image 11'''- Select the Extra to play
</gallery>

{{top}}

{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Video extras

2024-12-05T00:34:02Z

Crystalp:

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />Video Extras is a new feature to handle Extra video material, such as bloopers, alternate endings, interviews etc. It was introduced in v21 as part of the Video Versions feature.

Many users are familiar with the existing '''[[Add-on:Extras | Extras addon]]'''. Video Extras is the core version of the addon which provides greater flexibility to skinners to determine when Extras are available and provide icons in the library views to indicate their presence.

Video Extras and the Extras add-on are both compatible with each other, and one won't affect the other if both are in use.<section end="intro" />

This feature works on the movie library and may be expanded to TV shows in a later release of {{kodi}}.

'''Note:''' Video Extras requires movie folders and cannot be used with a flat folder structure.

= Settings =
There are two settings that control the use of Video Extras.
# a GUI setting that controls what to do when the Extra folder is found during a Library Update.
# An '''[[Advancedsettings.xml | advancedsettings.xml]]''' entry that prevents Extras from being added to the library as movies when the GUI setting is ''Enabled''.

== GUI Setting ==
{{#lst:Settings/Media/Library|IgnoreVideoExtrasScan}}

== Advancedsetting.xml ==
Extras are video files the same way the main feature movie is a video file. This may cause Kodi to see your Extras as additional movies when the GUI setting above is ''Enabled''. To prevent each Extras video file being scraped as a movie, and adding random or duplicated movies into your library, you must tell Kodi not to scrape the Extras folder.

A number of methods are available. A listing is found here '''''[[Updating_or_removing_videos#Exclude|Excluding folders and file types]]''''' or use the '''[[Advancedsettings.xml]]''' method using the code below by simply copying and pasting the following code into your [[Advancedsettings.xml]] file. If you already have an advancedsettings.xml file, do not duplicate the <advancedsettings></advancedsettings> tags.
<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<video>

<excludefromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>

</video>
</advancedsettings>
</syntaxhighlight>

= Setup =
Before running the Library Update, ensure the Extras folder has been created in the correct location. Only a folder named '''\Extras\''' will be recognized by the scanner.

The Extras folder must be located in the same folder as your movie video file for the {{kodi}} scanner to find it. Some typical examples are listed below.

=== Single Movie Folders ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\'''Extras'''\

=== DVD Structure ===
...\MyMovies\Chronicles of Riddick\
...\MyMovies\Chronicles of Riddick\AUDIO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\'''Extras'''\

=== Bluray Structure ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\BDMV\
...\MyMovies\Lucy (2014)\BDMV\'''Extras'''\

=== Nested Folders ===
Sub-folders in the Extras folder are allowed, making it easier to organise Extras for quicker access.

An example of this is shown in the following image. When scanned, and using the first file as an example, the listing will be named ''Bloopers\Blooper Reel 1''

<gallery mode="packed" widths="600px" heights="337px">
File:VideoExtras007.jpg| '''Image 1'''- An example of sub-folders in the Extras folder
</gallery>

=== Artwork ===

Local artwork provided next to video extras files is recognized in file browsing through Videos and is imported in the library (new in v22).

The naming convention is the same that is used for movies, using the video extra file name as the movie name. For more details see '''[[Movie_artwork|Movie Artwork]]'''.

There is no support for video extras art in scrapers. The displayed artwork depends on the skin used.

= Extras Manager =
The Extras Manager is accessed from the Information page as shown in the below images

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 2'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras005.jpg| '''Image 3'''- The Extras Manager with Extras added.
</gallery>

== Play ==
Play the selected title.

== Add Extra ==
The manual method of adding Extras to the manager by navigating through your file system.

See the Adding Extras ► Manual section below.

== Choose Art ==
Allows the changing of artwork for the highlighted Extra. Which artwork is displayed is skin dependent.

== Rename ==
Change the title of the selected Extra

== Remove ==
Remove an Extra from the manager. It will not delete files from the file system. The setting '''[[Settings/Media/General#Allow_file_renaming_and_deletion| Allow file renaming and deletion]]''' has no effect.

Be aware that running an Update Library may rescan the removed title back into the library, depending on your settings.

= Adding Extras =
There are two methods to scan Extras into the Extras library:
# Running the regular Update Library or Scan item to library.
# Manually adding items.

== Library Update ==
When the above-mentioned GUI setting is ''Disabled'', the {{kodi}} scanner, in addition to searching for video files, artwork, nfo files and trailers, will also search for the ''Extras'' folder and any video files in the folder will be added to the Extras Manager.

'''Note:''' There is a known bug in v21 related to the hash of the video files which may prevent Extras from being scanned. There is a fix for v22, which may be backported to v21.x

== Manual ==
Extras can also be added manually. This is performed via the Extras Manager as detailed in the following screenshots.

When using this manual mode, it is possible to add Extras located in the Extras folder of other movies, or saved elsewhere that is accessible to {{kodi}}.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 4'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras001.jpg| '''Image 5'''- In the Extras Manager, select '''Add extra'''
File:VideoExtras002.jpg| '''Image 6'''- Select '''* Item folder''' to jump to the movie folder, or navigate to another location using the remaining options.
File:VideoExtras003.jpg| '''Image 7'''- Select the '''Extras''' folder
File:VideoExtras004.jpg| '''Image 8'''- From this screen, highlight an Extra to add to the Extras library one at a time.
File:VideoExtras005.jpg| '''Image 9'''- The Extras Manager with Extras added.
</gallery>

= Playing Extras =
Accessing Extras for playback is accomplished using one of the following methods...

# Accessing the Extras Manager (detailed above) and pressing play after selecting the Extra to play
# When a movie contains Extras, pressing play using any method will display the '''Choose version''' dialogue. From this screen you can choose to either play the movie or select Extras for the '''Choose extra''' dialogue.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras008.jpg| '''Image 10'''- From the ''Choose version'' dialogue, select ''Extras''
File:VideoExtras009.jpg| '''Image 11'''- Select the Extra to play
</gallery>

{{top}}

{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Video extras

2024-12-05T00:29:44Z

Crystalp: Explain support of local art

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />Video Extras is a new feature to handle Extra video material, such as bloopers, alternate endings, interviews etc. It was introduced in v21 as part of the Video Versions feature.

Many users are familiar with the existing '''[[Add-on:Extras | Extras addon]]'''. Video Extras is the core version of the addon which provides greater flexibility to skinners to determine when Extras are available and provide icons in the library views to indicate their presence.

Video Extras and the Extras add-on are both compatible with each other, and one won't affect the other if both are in use.<section end="intro" />

This feature works on the movie library and may be expanded to TV shows in a later release of {{kodi}}.

'''Note:''' Video Extras requires movie folders and cannot be used with a flat folder structure.

= Settings =
There are two settings that control the use of Video Extras.
# a GUI setting that controls what to do when the Extra folder is found during a Library Update.
# An '''[[Advancedsettings.xml | advancedsettings.xml]]''' entry that prevents Extras from being added to the library as movies when the GUI setting is ''Enabled''.

== GUI Setting ==
{{#lst:Settings/Media/Library|IgnoreVideoExtrasScan}}

== Advancedsetting.xml ==
Extras are video files the same way the main feature movie is a video file. This may cause Kodi to see your Extras as additional movies when the GUI setting above is ''Enabled''. To prevent each Extras video file being scraped as a movie, and adding random or duplicated movies into your library, you must tell Kodi not to scrape the Extras folder.

A number of methods are available. A listing is found here '''''[[Updating_or_removing_videos#Exclude|Excluding folders and file types]]''''' or use the '''[[Advancedsettings.xml]]''' method using the code below by simply copying and pasting the following code into your [[Advancedsettings.xml]] file. If you already have an advancedsettings.xml file, do not duplicate the <advancedsettings></advancedsettings> tags.
<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<video>

<excludefromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>

</video>
</advancedsettings>
</syntaxhighlight>

= Setup =
Before running the Library Update, ensure the Extras folder has been created in the correct location. Only a folder named '''\Extras\''' will be recognized by the scanner.

The Extras folder must be located in the same folder as your movie video file for the {{kodi}} scanner to find it. Some typical examples are listed below.

=== Single Movie Folders ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\'''Extras'''\

=== DVD Structure ===
...\MyMovies\Chronicles of Riddick\
...\MyMovies\Chronicles of Riddick\AUDIO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\'''Extras'''\

=== Bluray Structure ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\BDMV\
...\MyMovies\Lucy (2014)\BDMV\'''Extras'''\

=== Nested Folders ===
Sub-folders in the Extras folder are allowed, making it easier to organise Extras for quicker access.

An example of this is shown in the following image. When scanned, and using the first file as an example, the listing will be named ''Bloopers\Blooper Reel 1''

<gallery mode="packed" widths="600px" heights="337px">
File:VideoExtras007.jpg| '''Image 1'''- An example of sub-folders in the Extras folder
</gallery>

=== Artwork ===

Local artwork provided next to video extras files is recognized in file browsing through Videos and is imported in the library (new in v22).

The naming convention is the same that is used for movies, see '''[[Movie_artwork|Movie Artwork]]''' for more details.

There is no support for video extras art in scrapers. The displayed artwork depends on the skin used.

= Extras Manager =
The Extras Manager is accessed from the Information page as shown in the below images

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 2'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras005.jpg| '''Image 3'''- The Extras Manager with Extras added.
</gallery>

== Play ==
Play the selected title.

== Add Extra ==
The manual method of adding Extras to the manager by navigating through your file system.

See the Adding Extras ► Manual section below.

== Choose Art ==
Allows the changing of artwork for the highlighted Extra. Which artwork is displayed is skin dependent.

== Rename ==
Change the title of the selected Extra

== Remove ==
Remove an Extra from the manager. It will not delete files from the file system. The setting '''[[Settings/Media/General#Allow_file_renaming_and_deletion| Allow file renaming and deletion]]''' has no effect.

Be aware that running an Update Library may rescan the removed title back into the library, depending on your settings.

= Adding Extras =
There are two methods to scan Extras into the Extras library:
# Running the regular Update Library or Scan item to library.
# Manually adding items.

== Library Update ==
When the above-mentioned GUI setting is ''Disabled'', the {{kodi}} scanner, in addition to searching for video files, artwork, nfo files and trailers, will also search for the ''Extras'' folder and any video files in the folder will be added to the Extras Manager.

'''Note:''' There is a known bug in v21 related to the hash of the video files which may prevent Extras from being scanned. There is a fix for v22, which may be backported to v21.x

== Manual ==
Extras can also be added manually. This is performed via the Extras Manager as detailed in the following screenshots.

When using this manual mode, it is possible to add Extras located in the Extras folder of other movies, or saved elsewhere that is accessible to {{kodi}}.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 4'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras001.jpg| '''Image 5'''- In the Extras Manager, select '''Add extra'''
File:VideoExtras002.jpg| '''Image 6'''- Select '''* Item folder''' to jump to the movie folder, or navigate to another location using the remaining options.
File:VideoExtras003.jpg| '''Image 7'''- Select the '''Extras''' folder
File:VideoExtras004.jpg| '''Image 8'''- From this screen, highlight an Extra to add to the Extras library one at a time.
File:VideoExtras005.jpg| '''Image 9'''- The Extras Manager with Extras added.
</gallery>

= Playing Extras =
Accessing Extras for playback is accomplished using one of the following methods...

# Accessing the Extras Manager (detailed above) and pressing play after selecting the Extra to play
# When a movie contains Extras, pressing play using any method will display the '''Choose version''' dialogue. From this screen you can choose to either play the movie or select Extras for the '''Choose extra''' dialogue.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras008.jpg| '''Image 10'''- From the ''Choose version'' dialogue, select ''Extras''
File:VideoExtras009.jpg| '''Image 11'''- Select the Extra to play
</gallery>

{{top}}

{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Advancedsettings.xml

2024-12-02T02:24:16Z

Crystalp:

{{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 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang=xml enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang=xml enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
<delay>0</delay>
<hdrextradelay>0</hdrextradelay>
<refresh>
<min></min> <max></max>
<rate></rate>
<delay></delay>
<hdrextradelay></hdrextradelay>
</refresh>
</latency>
</syntaxhighlight>
| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br/>
'''<delay>''' - Global default display latency.<br>
'''<hdrextradelay>''' - Global default latency added to the global default display latency when the display is in any HDR mode. Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).<br>
'''<refresh>''' - Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.<br>
'''<min>''', '''<max>''' - refresh rate range, OR<br>
'''<rate>''' - exact refresh rate<br>
'''<delay>''' - display latency for the given refresh rate<br>
'''<hdrextradelay>''' - additional latency when the display is in any HDR mode for the given refresh rate<br>
<br/>
'''Example:''' The following example sets display latency of 125 msec at 23-24 Hz
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
<br/>
'''Example:''' The following example sets display latency of 50 msec at 50 (+/-0.01) Hz
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>

|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang=xml enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>


<maxcommbreaklength>250</maxcommbreaklength>


<mincommbreaklength>90</mincommbreaklength>


<maxcommbreakgap>120</maxcommbreakgap>


<commbreakautowait>0</commbreakautowait>


<commbreakautowind>0</commbreakautowind>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>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}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==

{{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/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/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> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[Add-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<fronttobackrendering>true</fronttobackrendering>
</gui>
</syntaxhighlight>

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

* true: on '''(Default)'''
* false: off

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]
[[Category:Karellen]]

Advancedsettings.xml

2024-12-01T19:42:38Z

Crystalp: Add hdrextradelay latency (PR 24917 https://github.com/xbmc/xbmc/pull/24917)

{{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 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang=xml enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang=xml enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</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>
<hdrextradelay>0</hdrextradelay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default latency added to the global default display latency when the display is in any HDR mode.
Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).
|-
|
<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
<hdrextradelay> additional latency in HDR modes
</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 text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang=xml enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>

<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>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}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==

{{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/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/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> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[Add-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3 is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<smartredraw>true</smartredraw>
</gui>
</syntaxhighlight>

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

* true: on
* false: off '''(Default)'''

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<fronttobackrendering>true</fronttobackrendering>
</gui>
</syntaxhighlight>

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

* true: on '''(Default)'''
* false: off

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang=xml enclose="div">
<window>
<width>WIDTH</width>
<height>HEIGHT</height>
</window>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang=xml enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang=xml enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang=xml enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang=xml enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang=xml enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang=xml enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang=xml enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[Action_IDs]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]
[[Category:Karellen]]

Video extras

2024-11-10T04:08:15Z

Crystalp:

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />Video Extras is a new feature to handle Extra video material, such as bloopers, alternate endings, interviews etc. It was introduced in v21 as part of the Video Versions feature.

Many users are familiar with the existing '''[[Add-on:Extras | Extras addon]]'''. Video Extras is the core version of the addon which provides greater flexibility to skinners to determine when Extras are available and provide icons in the library views to indicate their presence.

Video Extras and the Extras add-on are both compatible with each other, and one won't affect the other if both are in use.<section end="intro" />

This feature works on the movie library and may be expanded to TV shows in a later release of {{kodi}}.

'''Note:''' Video Extras requires movie folders and cannot be used with a flat folder structure.

= Settings =
There are two settings that control the use of Video Extras.
# a GUI setting that controls what to do when the Extra folder is found during a Library Update.
# An '''[[Advancedsettings.xml | advancedsettings.xml]]''' entry that prevents Extras from being added to the library as movies when the GUI setting is ''Enabled''.

== GUI Setting ==
{{#lst:Settings/Media/Library|IgnoreVideoExtrasScan}}

== Advancedsetting.xml ==
Extras are video files the same way the main feature movie is a video file. This may cause Kodi to see your Extras as additional movies when the GUI setting above is ''Enabled''. To prevent each Extras video file being scraped as a movie, and adding random or duplicated movies into your library, you must tell Kodi not to scrape the Extras folder.

A number of methods are available. A listing is found here '''''[[Updating_or_removing_videos#Exclude|Excluding folders and file types]]''''' or use the '''[[Advancedsettings.xml]]''' method using the code below by simply copying and pasting the following code into your [[Advancedsettings.xml]] file. If you already have an advancedsettings.xml file, do not duplicate the <advancedsettings></advancedsettings> tags.
<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<video>

<excludefromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>

</video>
</advancedsettings>
</syntaxhighlight>

= Setup =
Before running the Library Update, ensure the Extras folder has been created in the correct location. Only a folder named '''\Extras\''' will be recognized by the scanner.

The Extras folder must be located in the same folder as your movie video file for the {{kodi}} scanner to find it. Some typical examples are listed below.

=== Single Movie Folders ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\'''Extras'''\

=== DVD Structure ===
...\MyMovies\Chronicles of Riddick\
...\MyMovies\Chronicles of Riddick\AUDIO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\'''Extras'''\

=== Bluray Structure ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\BDMV\
...\MyMovies\Lucy (2014)\BDMV\'''Extras'''\

= Extras Manager =
The Extras Manager is accessed from the Information page as shown in the below images

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 1'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras005.jpg| '''Image 6'''- The Extras Manager with Extras added.
</gallery>

== Play ==
Play the selected title.

== Add Extra ==
The manual method of adding Extras to the manager by navigating through your file system.

See the Adding Extras ► Manual section below.

== Choose Art ==
Allows the changing of artwork for the highlighted Extra. Which artwork is displayed is skin dependent.

== Rename ==
Change the title of the selected Extra

== Remove ==
Remove an Extra from the manager. It will not delete files from the file system. The setting '''[[Settings/Media/General#Allow_file_renaming_and_deletion| Allow file renaming and deletion]]''' has no effect.

Be aware that running an Update Library may rescan the removed title back into the library, depending on your settings.

= Adding Extras =
There are two methods to scan Extras into the Extras library:
# Running the regular Update Library or Scan item to library.
# Manually adding items.

== Library Update ==
When the above-mentioned GUI setting is ''Disabled'', the {{kodi}} scanner, in addition to searching for video files, artwork, nfo files and trailers, will also search for the ''Extras'' folder and any video files in the folder will be added to the Extras Manager.

'''Note:''' There is a known bug in v21 related to the hash of the video files which may prevent Extras from being scanned. There is a fix for v22, which may be backported to v21.x

== Manual ==
Extras can also be added manually. This is performed via the Extras Manager as detailed in the following screenshots.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 1'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras001.jpg| '''Image 2'''- In the Extras Manager, select '''Add extra'''
File:VideoExtras002.jpg| '''Image 3'''- Select '''* Item folder''' to jump to the movie folder, or navigate to another location using the remaining options.
File:VideoExtras003.jpg| '''Image 4'''- Select the '''Extras''' folder
File:VideoExtras004.jpg| '''Image 5'''- From this screen, highlight an Extra to add to the Extras library one at a time.
File:VideoExtras005.jpg| '''Image 6'''- The Extras Manager with Extras added.
</gallery>

= Playing Extras =
Accessing Extras for playback is accomplished using one of the following methods...

# Accessing the Extras Manager (detailed above) and pressing play after selecting the Extra to play
# When a movie contains Extras, pressing play using any method will display the '''Choose version''' dialogue. From this screen you can choose to either play the movie or select Extras for the '''Choose extra''' dialogue.

{{top}}

{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Video extras

2024-11-08T06:18:12Z

Crystalp:

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />Video Extras is a new feature to handle Extra video material, such as bloopers, alternate endings, interviews etc. It was introduced in v21 as part of the Video Versions feature.

Many users are familiar with the existing '''[[Add-on:Extras | Extras addon]]'''. Video Extras is the core version of the addon which provides greater flexibility to skinners to determine when Extras are available and provide icons in the library views to indicate their presence.

Video Extras and the Extras add-on are both compatible with each other, and one won't affect the other if both are in use.<section end="intro" />

This feature works on the movie library and may be expanded to TV shows in a later release of {{kodi}}.

'''Note:''' Video Extras requires movie folders and cannot be used with a flat folder structure.

= Settings =
There are two settings that control the use of Video Extras.
# a GUI setting that controls what to do when the Extra folder is found during a Library Update.
# An '''[[Advancedsettings.xml | advancedsettings.xml]]''' entry that prevents Extras from being added to the library as movies when the GUI setting is ''Enabled''.

== GUI Setting ==
{{#lst:Settings/Media/Library|IgnoreVideoExtrasScan}}

== Advancedsetting.xml ==
Extras are video files the same way the main feature movie is a video file. This may cause Kodi to see your Extras as additional movies when the GUI setting above is ''Enabled''. To prevent each Extras video file being scraped as a movie, and adding random or duplicated movies into your library, you must tell Kodi not to scrape the Extras folder.

A number of methods are available. A listing is found here '''''[[Updating_or_removing_videos#Exclude|Excluding folders and file types]]''''' or use the '''[[Advancedsettings.xml]]''' method using the code below by simply copying and pasting the following code into your [[Advancedsettings.xml]] file. If you already have an advancedsettings.xml file, do not duplicate the <advancedsettings></advancedsettings> tags.
<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<video>

<excludefromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>

</video>
</advancedsettings>
</syntaxhighlight>

= Setup =
Before running the Library Update, ensure the Extras folder has been created in the correct location. Only a folder named '''\Extras\''' will be recognized by the scanner.

The Extras folder must be located in the same folder as your movie video file for the {{kodi}} scanner to find it. Some typical examples are listed below.

=== Single Movie Folders ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\'''Extras'''\

=== DVD Structure ===
...\MyMovies\Chronicles of Riddick\
...\MyMovies\Chronicles of Riddick\AUDIO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\
...\MyMovies\Chronicles of Riddick\VIDEO_TS\'''Extras'''\

=== Bluray Structure ===
...\MyMovies\Lucy (2014)\
...\MyMovies\Lucy (2014)\BDMV\
...\MyMovies\Lucy (2014)\BDMV\'''Extras'''\

= Extras Manager =
The Extras Manager is accessed from the Information page as shown in the below images

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 1'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras005.jpg| '''Image 6'''- The Extras Manager with Extras added.
</gallery>

== Play ==
Play the selected title.

== Add Extra ==
The manual method of adding Extras to the manager by navigating through your file system.

See the Adding Extras ► Manual section below.

== Choose Art ==
Allows the changing of artwork for the highlighted Extra. Which artwork is displayed is skin dependent.

== Rename ==
Change the title of the selected Extra

== Remove ==
Remove an Extra from the manager. It will not delete files from the file system. The setting '''[[Settings/Media/General#Allow_file_renaming_and_deletion| Allow file renaming and deletion]]''' has no effect.

Be aware that running an Update Library may rescan the removed title back into the library, depending on your settings.

= Adding Extras =
There are two methods to scan Extras into the Extras library:
# Running the regular Update Library or Scan item to library.
# Manually adding items.

== Library Update ==
When the above-mentioned GUI setting is ''Disabled'', the {{kodi}} scanner, in addition to searching for video files, artwork, nfo files and trailers, will also search for the ''Extras'' folder and any video files in the folder will be added to the Extras Manager.

'''Note:''' There is a known bug in v21 related to the hash of the video files which may prevent Extras from being scanned. There is a fix for v22, which may be backported to v21.x

== Manual ==
Extras can also be added manually to the Extras Manager for those cases where Extras are added after the movie has been scanned into the library. This is performed via the Extras Manager as detailed in the following screenshots.

<gallery mode="packed" widths="500px" heights="283px">
File:VideoExtras006.jpg| '''Image 1'''- From the Movie Information page select '''Extras''' along the bottom row
File:VideoExtras001.jpg| '''Image 2'''- In the Extras Manager, select '''Add extra'''
File:VideoExtras002.jpg| '''Image 3'''- Select '''* Item folder''' to jump to the movie folder, or navigate to another location using the remaining options.
File:VideoExtras003.jpg| '''Image 4'''- Select the '''Extras''' folder
File:VideoExtras004.jpg| '''Image 5'''- From this screen, highlight an Extra to add to the Extras library one at a time.
File:VideoExtras005.jpg| '''Image 6'''- The Extras Manager with Extras added.
</gallery>

= Playing Extras =
Accessing Extras for playback is accomplished using one of the following methods...

# Accessing the Extras Manager (detailed above) and pressing play after selecting the Extra to play
# When a movie contains Extras, pressing play using any method will display the '''Choose version''' dialogue. From this screen you can choose to either play the movie or select Extras for the '''Choose extra''' dialogue.

{{top}}

{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Settings/System/Audio

2024-10-09T00:02:53Z

Crystalp:

{{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 installation and may differ from other hardware platforms. Some options change depending on which audio output device has been selected.

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. This option disables passthrough.
* '''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'''
|}

== Volume ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Adjust the volume of GUI sounds. Does not affect music or video playback volume. <ref>https://github.com/xbmc/xbmc/pull/21258</ref>
|}

== GUI sounds ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Select the preferred sound theme. Use the '''Get more''' button to download other sounds from the {{kodi}} repository.
|}

= 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. When the AVR display shows '''Multi-Channel In''', this indicates {{kodi}} is decoding the stream and sending the ''Raw'' stream to the AVR. This is normal for ''*.aac'' audio, and for music formats such as ''*.flac, *.mp3'' and others.

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 is not 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|21}}

[[Category:Settings]]

Databases/MyVideos

2024-05-27T21:26:31Z

Crystalp: /* videoversion */

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo, actor or videoversion|| || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the relations between media "parents" (movies, episodes, ...) and their video assets (versions, extras) for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || The video asset. Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || id of the media
|-
|media_type || text || The type of media this asset is linked with (v21: the only supported value is "movie")
|-
|itemType || integer || Type of video asset. 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Name of the video asset. Foreign key to the [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

Databases/MyVideos

2024-05-27T21:24:34Z

Crystalp: /* art */

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo, actor or videoversion|| || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the relations between media "parents" (movies, episodes, ...) and their video assets (versions, extras) for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || The video asset. Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || id of the media
|-
|media_type || text || The type of media this asset is linked with (v21: movies only)
|-
|itemType || integer || Type of video asset. 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Name of the video asset. Foreign key to the [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

Databases/MyVideos

2024-05-27T21:22:44Z

Crystalp: /* videoversion */

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor || || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the relations between media "parents" (movies, episodes, ...) and their video assets (versions, extras) for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || The video asset. Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || id of the media
|-
|media_type || text || The type of media this asset is linked with (v21: movies only)
|-
|itemType || integer || Type of video asset. 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Name of the video asset. Foreign key to the [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

Databases/MyVideos

2024-05-27T21:09:59Z

Crystalp: /* videoversiontype */

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor || || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the versioning data for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|-
|itemType || integer || 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Foreign key to a videoversiontype table
|}

== videoversiontype ==
This table stores the version types/names and extras names for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Name / type of the version or extra
|-
|owner || integer || 0 = prepopulated by the system; 1 = added by library scan; 2 = added by user
|-
|itemType || integer || type of asset the record applies to. 0 = Version; 1 = Extras
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

Databases/MyVideos

2024-05-27T20:02:51Z

Crystalp:

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]]}} | [[Databases]] }}

= MyVideos# =
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi.

The current stable release of {{kodi}} is using the following version of the database:

;Kodi v20 - MyVideos121.db

'''{{red|Warning: The databases are critical components of {{kodi}}. We strongly urge that you do not interfere with them, unless you have knowledge and experience with database designs.}}'''

= Views =
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

== episode_view ==
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || Not Used
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || Thumbnail URL Spoof
|-
|c08 || text || Not Used
|-
|c09 || text || Runtime
|-
|c10 || text || Director
|-
|c11 || text || Production Code
|-
|c12 || varchar(24) || Season Number
|-
|c13 || tvarchar(24)ext || Episode Number
|-
|c14 || text || Original Title
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || varchar(24) || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]]
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]]
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]]
|-
|userrating || integer || User Rating
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|}

== movie_view ==
A view that joins movie to file, path, videoversion and videoversiontype. One record per movie version. Most values are the same for all versions of a movie.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] for the default version of the movie.
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Not Used
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]]
|-
|c06 || text || Writers
|-
|c07 || text || Not Used
|-
|c08 || text || Image URL
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]]
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || Thumb URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country
|-
|c22 || text || Path to playable file
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|playerState || text ||
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|hasVideoVersions || integer || 0 = the movie has a single version; 1 = the movie has additional versions
|-
|hasVideoExtras || integer || 0 = No Extras; 1 = has Extras
|-
|isDefaultVersion || integer || 0 = Not the default / parent version; 1 = Default / parent version
|-
|videoVersionIdFile || integer || [version specific] Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|videoVersionTypeId || integer || [version specific] Foreign Key to [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|videoVersionTypeName || text || [version specific] Descriptive name of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|-
|VideoVersionTypeItemType || integer || [version specific] Type of the version, see [[Databases/MyVideos#videoversiontype|videoversiontype table]]
|}

== musicvideo_view ==
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumb URL
|-
|c02 || text || Thumb URL spoof
|-
|c03 || text || Not Used
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Not Used
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder
|-
|c15 || text || Not Used
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || Not Used
|-
|c21 || text || Not Used
|-
|c22 || text || Not Used
|-
|c23 || text || Not Used
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|playerState || text ||
|}

== season_view ==
A view that joins seasons to the tvshow.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#files|tv show table]]
|-
|Season || integer || Season number
|-
|name || text || User modified Season name
|-
|userrating || integer || User rating for season
|-
|strPath || text || Path to tv show
|-
|showTitle || text || TV Show name
|-
|Plot || text || TV Show plot
|-
|premiered || text || TV Show premiered date
|-
|genre || text || genre
|-
|studio || text || Studio
|-
|mpaa || text || Certification
|-
|episodes || text || Season episode count
|-
|playCount || integer || Number of play times. Each played episode increases the count
|-
|aired || text || Aired date of the first episode in the season
|-
|inProgressCount || integer || Show watched/in progress/total counts in home screen listings and video window listings<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshow_view ==
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Trailer
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text || Default UniqueID ( default="true" )
|-
|uniqueid_type || text || Provider of the default UniqueID. eg... <uniqueid type="tmdb" default="true">
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowcounts ==
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|-
|inProgressCount || integer || Show in progress episodes count along with watched episodes and total episodes count in home screen listings and video window listings.<ref>https://github.com/xbmc/xbmc/pull/23658</ref>
|}

== tvshowlinkpath_minview ==
Joins TV Show to Path
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|idPath || || Foreign key to [[Databases/MyVideos#path|path table]]
|}

{{top}}

= Tables =
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases/MyVideos#episode|episode]], [[Databases/MyVideos#movie|movie]], [[Databases/MyVideos#settings|settings]], and [[Databases/MyVideos#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

== actor ==
This table stores actor, artist, director, and writer information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Primary Key || ||
|-
|name || integer || Name of the actor, artist, director, or writer
| rowspan="2" style="text-align: left;" |
<actor>
<name></name>
<thumb></thumb>
</actor>
| rowspan="2" style="text-align: left;" |
<artist></artist>
|-
|art_urls|| text || Image URL
|}

== actor_link ==
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actor|actors table]] || ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]] || ||
|-
|media_type || text || Movie, TV Show, Episode, Music Video || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails> || <musicvideo></musicvideo>
|-
|role || text || Role the actor played
| rowspan="2" style="text-align: left;" |
<actor>
<role></role>
<order></order>
</actor>
| rowspan="2" style="text-align: left;" |
n/a
|-
|cast_order || integer || Order actors will be displayed
|}

== art ==
This table stores URLs for video art metadata.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
! rowspan="1" style="text-align: centre;" | TV Shows
! rowspan="1" style="text-align: centre;" | TV Episode
! rowspan="1" style="text-align: centre;" | Music Videos
|-
|art_id || integer || Primary Key || || || ||
|-
|media_id || integer || The id of the media this piece of art is for || || || ||
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor || || || ||
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart |||| || ||
|-
|url || text || Image URL
| rowspan="1" style="text-align: left;" |
<thumb aspect="poster" preview=""></thumb>
and<br />
<fanart>
<thumb preview=""></thumb>
</fanart>
| rowspan="1" style="text-align: left;" |
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
and<br />
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb aspect="" type="" season=""></thumb>
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
and
<actor>
<thumb></thumb>
</actor>
and<br />
<thumb></thumb>
| rowspan="1" style="text-align: left;" |
<art>
<fanart></fanart>
<poster></poster>
</art>
|}

== bookmark ==
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies<br />TV Show<br />TV Episode
|-
|idBookmark || integer || Primary Key ||
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]] ||
|-
|timeInSeconds || double || Time in seconds of bookmark location
| rowspan="2" style="text-align: left;" |
<resume>
<position></position>
<total></total>
</resume>
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark ||
|-
|player || text || Player used to store bookmark ||
|-
|playerState || text || Player's internal state in XML ||
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode) ||
|}

== country ==
This table lists countries.

{|class="prettytable"
! Column Name || Data Type || Description || Movies
|-
|country_id || integer || Primary Key ||
|-
|name || text || Country Name || <country></country>
|}

== country link ==
This table links countries to movies.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases/MyVideos#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|media_type || text || Media Class
|}

== director_link ==
This table links directors to Movies, TV show episodes and Music Videos

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#movie|movie table]],[[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

== episode ==
This table stores television episode information. Information concerning the series is stored in [[Databases/MyVideos#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | TV Episode
|-
|idEpisode || integer || Primary Key ||
|-
|idFile || integer || Foreign key to the [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Episode Title || <title></title>
|-
|c01 || text || Plot Summary || <plot></plot>
|-
|c02 || text || Not Used ||
|-
|c03 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c04 || text || Writer || <credits></credits>
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb></thumb>
|-
|c07 || text || Thumbnail URL Spoof ||
|-
|c08 || text || Not Used ||
|-
|c09 || text || Runtime || <runtime></runtime>
|-
|c10 || text || Director || <director></director>
|-
|c11 || text || Production Code || <code></code>
|-
|c12 || varchar(24) || Season Number || <season></season>
|-
|c13 || varchar(24) || Episode Number || <episode></episode>
|-
|c14 || text || Original Title || <originaltitle></originaltitle>
|-
|c15 || text || Season Number- Specials Sorting || <displayseason></displayseason>
|-
|c16 || text || Episode Number- Specials Sorting || <displayepisode></displayepisode>
|-
|c17 || varchar(24) || Bookmark ||
|-
|c18 || text || Path to episode file ||
|-
|c19 || text || Link to [[Databases/MyVideos#path|Path Table]] ||
|-
|c20 || text || Link to [[Databases/MyVideos#uniqueid|UniqueID Table]] ||
|-
|c21 || text || Not used ||
|-
|c22 || text || Not used ||
|-
|c23 || text || Not used ||
|-
|idShow || integer || Foreign key to the [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|userrating || integer || User Rating || <userrating></userrating>
|-
|idSeason || integer || Foreign key to the [[Databases/MyVideos#seasons|seasons table]] ||
|}

== files ==
This table stores filenames and links the path.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|idFile || integer || Primary Key ||
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]] ||
|-
|strFilename || text || Full name of file including extension ||
|-
|playCount || integer || # of Times Played || <playcount></playcount>
|-
|lastPlayed || text || Date & Time Last Played || <lastplayed></lastplayed>
|-
|dateAdded || text || Date & Time Added to Library || <dateadded></dateadded>
|}

== genre ==
This table stores genre information. For convenience the contents are duplicated in [[Databases/MyVideos#movie|movie]] and [[Databases/MyVideos#tvshow|tvshow]], so a join isn't necessary.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|genre_id || integer || Primary Key ||
|-
|name || text || Genre label || <genre></genre>
|}

== genre_link ==
This table links genres to movies. (The contents are also stored in movies.c14, though.)

{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases/MyVideos#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== movie ==
This table stores movie information.

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idMovie || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Local Movie Title || <title></title>
|-
|c01 || text || Movie Plot || <plot></plot>
|-
|c02 || text || Movie Plot Outline || <outline></outline>
|-
|c03 || text || Movie Tagline || <tagline></tagline>
|-
|c04 || text || Not Used ||
|-
|c05 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c06 || text || Writers || <credits></credits>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Image URL || <thumb aspect="poster" preview=""></thumb>
|-
|c09 || text || Link to [[Databases/MyVideos#uniqueid|uniqueid Table]] ||
|-
|c10 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c11 || text || Runtime || <runtime></runtime> **
|-
|c12 || text || MPAA Rating || <mpaa></mpaa>
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking || <top250></top250>
|-
|c14 || text || Genre || <genre></genre>
|-
|c15 || text || Director ||<director></director>
|-
|c16 || text || Original Movie Title || <originaltitle></originaltitle>
|-
|c17 || text || Thumb URL Spoof ||
|-
|c18 || text || Studio || <studio></studio>
|-
|c19 || text || Trailer URL || <trailer></trailer>
|-
|c20 || text || Fanart URLs
| rowspan="1" style="text-align: left;" |
<fanart>
<thumb preview=""></thumb>
</fanart>
|-
|c21 || text || Country || <country></country>
|-
|c22 || text || Path to playable file ||
|-
|c23 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder ||
|-
|idSet || integer || Foreign Key to [[Databases/MyVideos#sets|sets table]] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Overwritten on Play
|}

== movielinktvshow ==
This table links movies to TV shows.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases/MyVideos#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|}

== musicvideo ==

{|class="prettytable"
! Column Name || Data Type || Description || Music Videos
|-
|idMVideo || integer || Primary Key ||
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] ||
|-
|c00 || text || Title || <title></title>
|-
|c01 || text || Thumb URL || <thumb preview=""></thumb>
|-
|c02 || text || Thumb URL spoof ||
|-
|c03 || text || Not Used ||
|-
|c04 || text || Run time || <runtime></runtime>
|-
|c05 || text || Director || <director></director>
|-
|c06 || text || Studios || <studio></studio>
|-
|c07 || text || Not Used ||
|-
|c08 || text || Plot || <plot></plot>
|-
|c09 || text || Album || <album></album>
|-
|c10 || text || Artist || <artist></artist>
|-
|c11 || text || Genre || <genre></genre>
|-
|c12 || text || Track ||
|-
|c13 || text || Path to playable file || <filenameandpath></filenameandpath>
|-
|c14 || text || Link to [[Databases/MyVideos#path|path table]] for Source folder || <basepath></basepath>
|-
|c15 || text || Not Used ||
|-
|c16 || text || Not Used ||
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || Not Used ||
|-
|c21 || text || Not Used ||
|-
|c22 || text || Not Used ||
|-
|c23 || text || Not Used ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|premiered || text || Date movie premiered || <premiered></premiered>
|}

== path ==
This table stores path information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || addon ID
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||
|-
|allAudio || bool || Skip filename matching for external audio tracks<br>0 = Disabled<br>1 = Enabled
|-
|dateAdded || text ||
|-
|idParentPath || integer ||
|}

== rating ==
This table stores the ratings for TV Shows, Episodes and Movies

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies <br />TV Shows<br />TV Episode
|-
|rating_id || integer || Primary Key ||
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#episode|episode table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#movie|movie table]], ||
|-
|media_type || text || Movies, TV Show, TV Episode || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|rating_type || text || default ||
|-
|rating || float || rating from scraper site
| rowspan="2" style="text-align: left;" |
<ratings>
<rating name="default" max="10" default="true">
<value></value>
<votes></votes>
</rating>
</ratings>
|-
|votes || integer || votes from scraper site
|}

== seasons ==
This table stores the links between tv show and seasons.

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idSeason || integer || Primary Key ||
|-
|idShow|| integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]] ||
|-
|season || integer || Season number || <season></season>
|-
|name || text || Season Name || <namedseason number="n"></namedseason><br/> n = season number
|-
|userrating || integer || Season level User Rating ||
|}

== sets ==
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies
|-
|idSet || integer || Primary Key ||
|-
|strSet || text || The name of the set
| rowspan="2" style="text-align: left;" |
<set>
<name></name>
<overview></overview>
</set>
|-
|strOverview || text || The description of the set
|}

== settings ==
This table stores settings for individual files.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || float || Brightness
|-
|Contrast || float || Contrast
|-
|Gamma || float || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|ResumeTime || integer || ResumeTime
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|-
|TonemapMethod || integer ||
|-
|TonemapParam || float ||
|-
|Orientation || integer ||
|-
|CenterMixLevel || integer ||
|}

== stacktimes ==
This table stores playing times for files (used for playing multi-file videos).

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases/MyVideos#files|files table]]
|-
|times|| text || Times
|}

== streamdetails ==
This table contains information regarding codecs used, aspect ratios etc

{|class="prettytable"
! Column Name || Data Type || Description
! rowspan="1" style="text-align: centre;" | Movies **<br />TV Episode **
! rowspan="1" style="text-align: centre;" | Music Videos **
! Version<br/>Added
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]] || || ||
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles || || ||
|-
|strVideoCodec|| text || Video codex (xvid etc)
| rowspan="6" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds>5311</durationinseconds>
<stereomode></stereomode>
</video>
</streamdetails>
</fileinfo>
| rowspan="6" style="text-align: left;" |
|-
|fVideoAspect|| float || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|iVideoDuration|| integer || Actual runtime in sec
|-
|strStereoMode || text || Stereo Mode
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
| rowspan="3" style="text-align: left;" |
<fileinfo>
<streamdetails>
<audio>
<codec></codec>
<channels></channels>
<language></language>
</audio>
</streamdetails>
</fileinfo>
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
| rowspan="1" style="text-align: left;" |
<fileinfo>
<streamdetails>
<video>
<subtitle>
<language>en</language>
</subtitle>
</video>
</streamdetails>
</fileinfo>
| rowspan="1" style="text-align: left;" |
|-
|strVideoLanguage|| text || Language of the Video || || ||
|-
|strHdrType|| text || hdr type of the video || <hdrtype></hdrtype> || || v20 <ref>https://github.com/xbmc/xbmc/pull/19983</ref>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || Settings Will be overwritten on first play
|}

== studio ==
This table stores studio information.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes<br />Music Videos
|-
|studio_id || integer || Primary Key ||
|-
|name || text || Studio Label || <studio></studio>
|}

== studio link ==
This table links studios to movies, music videos and tv shows

{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases/MyVideos#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases/MyVideos#movie|movie table]], [[Databases/MyVideos#tvshow|tv show table]], [[Databases/MyVideos#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

== tag ==
This stores tags.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />Music Videos
|-
|tag_id || integer || Primary Key ||
|-
|name || integer || Tag || <tag></tag>
|}

== tag_link ==
This table links tags to various media.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases/MyVideos#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== tvshow ==
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases/MyVideos#episode|episode]]. To link a TV show to its episodes, use [[Databases/MyVideos#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description || TV Show
|-
|idShow || integer || Primary Key ||
|-
|c00 || text || Show Title || <showtitle></showtitle>
|-
|c01 || text || Show Plot Summary || <plot>plot>
|-
|c02 || text || Status || <status></status>
|-
|c03 || text || Unknown ||
|-
|c04 || text || Link to [[Databases/MyVideos#rating|Rating Table]] ||
|-
|c05 || text || First Aired || <premiered></premiered>
|-
|c06 || text || Thumbnail URL || <thumb aspect="" type="" season=""></thumb>
|-
|c07 || text || [unknown - Spoof Thumbnail URL?] ||
|-
|c08 || text || Genre || <genre></genre>
|-
|c09 || text || Original Title || <originaltitle></originaltitle>
|-
|c10 || text || Episode Guide URL ||
<episodeguide>
<url cache=""></url>
</episodeguide>
|-
|c11 || text || Fan Art URL ||
<fanart url="">
<thumb dim="" colors="" preview=""></thumb>
</fanart>
|-
|c12 || text || Unique ID issued by Kodi based on Scraper ID's ||
|-
|c13 || text || Content Rating || <mpaa></mpaa>
|-
|c14 || text || Studio || <studio></studio>
|-
|c15 || text || Title formatted for sorting || <sorttitle></sorttitle>
|-
|c16 || text || Trailer || <trailer></trailer>
|-
|c17 || text || Not Used ||
|-
|c18 || text || Not Used ||
|-
|c19 || text || Not Used ||
|-
|c20 || text || [unknown] ||
|-
|c21 || text || [unknown] ||
|-
|c22 || text || [unknown] ||
|-
|c23 || text || [unknown] ||
|-
|userrating || integer || Rating applied by user || <userrating></userrating>
|-
|duration || integer || Length of Episodes || <runtime></runtime>
|}

== tvshowlinkpath ==
This table links a TV show to its path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases/MyVideos#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases/MyVideos#path|path table]]
|}

== uniqueid ==
This table holds the UniqueID's for Movies, TV shows and Episodes. Normally the UniqueID's are the ID's used at the scraper sites. For user created nfo files for say, home movies, the ID's are user nominated. Music Videos do not require a UniqueID.

{|class="prettytable"
! Column Name || Data Type || Description || Movies<br />TV Shows<br />TV Episodes
|-
|uniqueid || integer || Primary Key ||
|-
|media_id || integer || Foreign key to a media table ||
|-
|media_type || text || Media type for link || <movie></movie><br /><tvshow></tvshow><br /><episodedetails></episodedetails>
|-
|value || text || ID at scraper site || <id></id>
|-
|type || text || Scraper site ||
|}

== version ==
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== videoversion ==
This table stores the versioning data for the Video Versions feature. <ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases/MyVideos#files|files table]]
|-
|idMedia || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|-
|itemType || integer || 0 = VideoVersion; 1 = Extras
|-
|idType || integer || Foreign key to a videoversiontype table
|}

== videoversiontype ==
This table stores the versioning data for the Video Versions feature.<ref>https://github.com/xbmc/xbmc/pulls?page=4&q=is%3Apr+label%3A%22Feature%3A+Video+Versions%2FExtras%22+is%3Aclosed</ref>
{|class="prettytable"
! Column Name || Data Type || Description
|-
|id || integer || Primary Key
|-
|name || text || Description of version type
|-
|owner || integer || 0 = {{Kodi}} default; 1 = User added
|-
|idType || integer || 0 = default VideoVersion type; 1 = Extras; 2 = User added VideoVersion type
|}

== writer_link ==
This table links writers stored in the actors table to movies and episodes.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases/MyVideos#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

= References =
<references />

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Skin_development]]

External players

2024-04-14T16:06:12Z

Crystalp:

{{cleanup}}
<section begin="intro" />While the built in video and audio players are capable, out of the box, to handle a huge variety of content, users might find themselves in need of using a different playback software but still using Kodi for scraping and organizing content. Reasons might include improved post-processing abilities, DRM restricted media that requires a specific player (such as encrypted Blu-ray discs), special player-specific features, etc. Kodi has a powerful tool to achieve this, the '''external player'''. The current method involves the configuration of a '''playercorefactory.xml''' file.<section end="intro" />

== Set up ==
Kodi comes with a default playercorefactory.xml file, located under the ''Kodi/System'' folder (where Kodi is the chosen installation folder).

To customize playback behaviour, users need to create an extra playercorefactory.xml file inside their '''[[userdata]]''' folder.<br />

Let's start with an example playercorefactory.xml file:
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>
<player name="MPC-HC" type="ExternalPlayer" audio="false" video="true">
<filename>C:\Program Files\MPC-HC\mplayerc.exe</filename>
<args>"{1}" /fullscreen /close</args>
<hidexbmc>false</hidexbmc>
<hideconsole>false</hideconsole>
<warpcursor>none</warpcursor>
</player>
</players>
<rules action="prepend">
<rule filetypes="mkv" filename=".*720p.*" player="MPC-HC"/>
</rules>
</playercorefactory>
</syntaxhighlight>

The <code><players/></code> node (i.e. <code><players>...<players/></code>) defines all the different players that you wish to add to Kodi. Inside you can have any number of <code><player/></code> nodes, defining as many external players as you wish (the builtin ones being '''dvdplayer''' and '''paplayer''', you can also use the aliases ''audiodefaultplayer'', ''videodefaultplayer'', ''videodefaultdvdplayer'').

The player <code>name</code> attribute can be anything you like and will appear in the [[Media:Playusing.png|"Play using..." menu]], accessible from the [[Basic_controls#Context_Menu|context menu]].
For an external player the <code>type</code> attribute ''must'' be '''ExternalPlayer'''. The other possible values being ''dvdplayer'' and ''paplayer'', although there's no point defining one of those as they already exist and don't accept any configuration. The <code>audio</code> and <code>video</code> (boolean; true/false) attributes when <code>true</code> will cause the player to ''always'' appear in the "Play using..." menu even if you don't define any rules for the player, or no rules match the currently selected media item (e.g. video file) for the player.
You could, for instance, define a player with <code>video="true"</code> and then ''not'' tie it to any specific rule, thus creating some sort of "safety net", always available in the context menu, should you ever need it.

The only ''required'' node for a player with <code>type</code> ''ExternalPlayer'' is the <code><filename/></code> node, this should contain the path of the external player executable. The other, optional, nodes are

{| class="prettytable"
|-
! Name
! Value
! Use
|-
! args
|
| Arguments to pass to the external player executable.<br />
If this contains the token '''{0}''' then this is replaced with the full URI of the item to be played (note that this is, in many cases, Kodi-specific and your external player won't understand it).<br />A '''{1}''' token is also replaced with the URI of the item to be played, but with the following differences<br />
* For rar and zip files '''{1}''' is the path of the archive and '''{2}''' will be the relative path to the file in the archive
* On win32 smb-URIs (smb://host/path) are converted into UNCs (\\host\path)<br />
* For LiveTV streams/files the pvr:// type url is not translated and {1} still returns the Kodi-specific URI which will not be interpretable by the external player
'''NOTE you should surround these tokens with double-quotes (e.g. '''"{1}"''') unless you know what you're doing and have a good reason not to, as they may contain spaces.'''<br />
If none of these tokens are present then it's equivalent to having '''"{1}''' at the end.
|-
! hidexbmc
| style="white-space:nowrap" | '''false''' ''(default)''<br />'''true'''
| whether to hide the Kodi window whilst the external player is active
|-
! hideconsole
| style="white-space:nowrap" | '''false''' ''(default)''<br />'''true'''
| ''Win32 only'' - whether the external player process is started with the initial window hidden (useful for hiding the console when the external player is a batch file)
|-
! warpcursor
| style="white-space:nowrap" | '''none''' ''(default)''<br />'''topleft'''<br />'''topright'''<br />'''bottomleft'''<br />'''bottomright'''
| ''Win32 only'' - whether and where to move the cursor to before the external player is launched
|-
! playcountminimumtime
| style="white-space:nowrap" | ''number of seconds''
| the time the extplayer process needs to run for before the item's playcount will be incremented (i.e. it will be marked as watched)
|-
! playonestackitem
| style="white-space:nowrap" | '''false''' ''(default)''<br />'''true'''
| whether playback should stop after playing one item that's part of a stack
|}

Once a user has defined one or more external player, they have the option of adding ''rules'' to customize ''which files'' are handled by ''which players''. The above example, for instance, defines the MPC-HC external player as the default player for MKV files with "720p" in their filename. <code>.*</code> before and after "720p" is a [http://en.wikipedia.org/wiki/Regular_expression#Standards regular expression] (regex).
* <code>.</code> "Matches any single character."
* <code>*</code> "Matches the preceding element zero or more times."<br />
Together they mean "Matches any single character (.) zero or more times (*)".

A <code><rules/></code> node contains a set of rules. An (optional) <code>action</code> attribute can have a value of <code>prepend</code>, <code>append</code> or <code>overwrite</code> which specifies whether the rules should be prepended, appended (the default if no action is specified) or replace all existing rules. Appended rules will take precedence over default players (i.e. DVDPlayer for video and PAPlayer for audio) but not over Kodis builtin rules. '''[needs better/more complete explanation]'''

A <code><rule/></code> node compares its attributes against the attributes of a media item and if everything matches then the player names in the player attribute is the default player for the media item (you can still select another using the "Play using..." menu). The attributes are listed below. Order of <code><rule/></code>s is significant '''[needs clarification]''', the first match defines the player so order them from more-to-less specific.

<code><rule/></code>s can be nested with inner rules inheriting attributes from outer rules, with inner rules being checked before outer rules. For example:

<syntaxhighlight lang=xml enclose="div">
<rules action="prepend">
<rule video="true" player="wmplayer">
<rule dvd="true" player="dvdplayer"/>
<rule filetypes="mkv" player="VLC">
<rule filename=".*720.*|.*1080.*" player="MPC-HC"/>
</rule>
</rule>
</rules>
</syntaxhighlight>

says that all video should be played by wmplayer, except DVDs, that are played with (the builtin) dvdplayer, and .mkv files that are played with VLC, however .mkv files with "720{{"}} or "1080" in their names are played with MPC-HC (all assuming wmplayer, VLC and MPC-HC players are defined in the players section).

The following attributes can be used to build rules:
{| class="prettytable"
|-
! Attribute
! Type
! Value
|-
| name || string
| name of the rule
|-
| internetstream || boolean
| when '''true''' the rule applies to internet streams
|-
| remote || boolean
| when '''true''' the rule applies to remote-only (non-local) media
|-
| audio || boolean
| when '''true''' the rule applies to audio-only media
|-
| video || boolean
| when '''true''' the rule applies to video media
|-
| dvd || boolean
| when '''true''' the rule applies to DVDs
|-
| dvdimage || boolean
| when '''true''' the rule applies to DVD images (iso)
|-
| dvdfile || boolean
| when '''true''' the rule applies to DVD folder structures
|-
| protocols || regexp
| when defined the rule applies to items whose (URI) protocol matches; as well as "real" protocols like daap, rtv, rtsp Kodi also uses the URI protocol for things like zip, rar etc.
|-
| filetypes || regexp
| when defined the rule applies to items whose file extension matches
|-
| mimetypes || regexp
| when defined the rule applies to items whose mime-type matches
|-
| filename || regexp
| when defined the rule applies to items whose filename matches
|-
| player || string
| the name of the player defined in the <players> section this rule invokes
|}
For the regexp attributes you can specify alike with a |-separator, e.g. '''mkv|avi|divx''' ("The choice operator matches either the expression before or the expression after the operator").

The following attributes are also available for video items with metadata (a.k.a. flagging):
{| class="prettytable"
|-
! Attribute
! Type
! Value
|-
| videocodec || regexp
| matched against the video codec so, a rule could used '''<nowiki>xvid|divx|div3|div4|div5</nowiki>'''
|-
| videoresolution || regexp
| matched against the video resolution, which will be one of '''480''', '''540''', '''720''' or '''1080'''
|-
| videoaspect || boolean
| matched against the video aspect ratio, which will be one of '''1.33''', '''1.66''', '''1.78''', '''1.85''', '''2.20''' or '''2.35'''
|-
| hdrtype || regexp
| matched against the video hdr type, which could be one of '''none''' (=sdr video), '''hdr10''', '''hlg''' or '''dolbyvision''' - ''v22 and above''
|-
| audiocodec || regexp
| matched against the audio codec, e.g. '''ac3<nowiki>|</nowiki>dts'''
|-
| audiochannels || regexp
| matched against the number of channels in the audio which will be an integer (i.e. '''6''' rather than '''5.1''')
|}

{{divbox|orange||'''Note:''' There's currently no way to get a resume point if an external player is in use. After a specific duration (which can be modified via the [[Advancedsettings.xml|advancedsettings.xml]]) the specific video will be marked as watched. But Kodi will not set a resume point for it.}}

== Examples ==
On Kodi for Android running on TI OMAP pandaboard I was able to take advantage of hw acceleration by changing /data/data/org.xbmc.kodi/cache/apk/assets/system/playercorefactory.xml to launch Gallery on mp4 files as follows:

=== Android ===
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>

<player name="Gallery" type="ExternalPlayer" audio="true" video="true">
<filename>am</filename>
<args>start -n com.android.gallery3d/.app.MovieActivity -d {1}</args>
<hidexbmc>true</hidexbmc>
<hideconsole>true</hideconsole>
</player>
<player name="DVDPlayer" audio="true" video="true" />
</players>
<rules name="system rules">
<rule name="rtv" protocols="rtv" player="DVDPlayer" />
<rule name="hdhomerun/myth/mms/udp" protocols="hdhomerun|myth|cmyth|mms|mmsh|udp" player="DVDPlayer" />
<rule name="lastfm/shout" protocols="lastfm|shout" player="PAPlayer" />

<rule name="rtsp" protocols="rtsp" filetypes="!(rm|ra)" player="PAPlayer" />

<rule name="streams" internetstream="true">
<rule name="aacp/sdp" mimetypes="audio/aacp|application/sdp" player="DVDPlayer" />
<rule name="mp2" mimetypes="application/octet-stream" filetypes="mp2" player="PAPlayer" />
</rule>

<rule name="dvd" dvd="true" player="DVDPlayer" />
<rule name="dvdimage" dvdimage="true" player="DVDPlayer" />

<rule name="sdp/asf" filetypes="sdp|asf" player="DVDPlayer" />

<rule name="nsv" filetypes="nsv" player="DVDPlayer" />
<rule name="dgb" filetypes="*.mp4" player="Gallery"/>

<rule name="radio" filetypes="pvr" filename=".*/radio/.*" player="DVDPlayer" />
</rules>
</playercorefactory>
</syntaxhighlight>

I tested this only very lightly but it improved playback smoothness and obviously reduced cpu load. ymmv.

=== Ubuntu ===

{{divbox|orange||'''Note:''' The Ubuntu OS has a long-lasting NFS bug which prevents Kodi from playing files directly via its own internal NFS sources using an external video player. You will have to set up NFS mounts directly via the Ubuntu OS to have this work correctly.}}

In GNU/Linux the location of the file should be: <code>~/.kodi/userdata/playercorefactory.xml</code>

There are cross-platform standalone video players which are supported by Kodi. Hereunder are two of them. The Full-screen option has been added, otherwise you will have a windowed video player.

==== VLC ====
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>
<player name="VLC" type="ExternalPlayer" audio="false" video="true">
<filename>/usr/bin/vlc</filename>
<args>--fullscreen "{1}"</args>
<hidexbmc>false</hidexbmc>
</player>
</players>
<rules action="prepend">
<rule video="true" player="VLC"/>
</rules>
</playercorefactory>
</syntaxhighlight>

==== MPV ====
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>
<player name="MPV" type="ExternalPlayer" audio="false" video="true">
<filename>/usr/bin/mpv</filename>
<args>--fs=yes "{1}"</args>
<hidexbmc>false</hidexbmc>
</player>
</players>
<rules action="prepend">
<rule video="true" player="MPV"/>
</rules>
</playercorefactory>
</syntaxhighlight>

== See also ==
;Windows
* [[forum:43511|Forums:External Player Support Thread on the Kodi forums]]
* [[forum:116724|Forums:Working External Player Solution]]

;Android
* [[HOW-TO:Use external players on Android]]

{{updated|18}}
[[Category:Players]]
[[Category:Manual]]
[[Category:Advanced topics]]

External players

2024-04-14T16:05:04Z

Crystalp:

{{cleanup}}
<section begin="intro" />While the built in video and audio players are capable, out of the box, to handle a huge variety of content, users might find themselves in need of using a different playback software but still using Kodi for scraping and organizing content. Reasons might include improved post-processing abilities, DRM restricted media that requires a specific player (such as encrypted Blu-ray discs), special player-specific features, etc. Kodi has a powerful tool to achieve this, the '''external player'''. The current method involves the configuration of a '''playercorefactory.xml''' file.<section end="intro" />

== Set up ==
Kodi comes with a default playercorefactory.xml file, located under the ''Kodi/System'' folder (where Kodi is the chosen installation folder).

To customize playback behaviour, users need to create an extra playercorefactory.xml file inside their '''[[userdata]]''' folder.<br />

Let's start with an example playercorefactory.xml file:
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>
<player name="MPC-HC" type="ExternalPlayer" audio="false" video="true">
<filename>C:\Program Files\MPC-HC\mplayerc.exe</filename>
<args>"{1}" /fullscreen /close</args>
<hidexbmc>false</hidexbmc>
<hideconsole>false</hideconsole>
<warpcursor>none</warpcursor>
</player>
</players>
<rules action="prepend">
<rule filetypes="mkv" filename=".*720p.*" player="MPC-HC"/>
</rules>
</playercorefactory>
</syntaxhighlight>

The <code><players/></code> node (i.e. <code><players>...<players/></code>) defines all the different players that you wish to add to Kodi. Inside you can have any number of <code><player/></code> nodes, defining as many external players as you wish (the builtin ones being '''dvdplayer''' and '''paplayer''', you can also use the aliases ''audiodefaultplayer'', ''videodefaultplayer'', ''videodefaultdvdplayer'').

The player <code>name</code> attribute can be anything you like and will appear in the [[Media:Playusing.png|"Play using..." menu]], accessible from the [[Basic_controls#Context_Menu|context menu]].
For an external player the <code>type</code> attribute ''must'' be '''ExternalPlayer'''. The other possible values being ''dvdplayer'' and ''paplayer'', although there's no point defining one of those as they already exist and don't accept any configuration. The <code>audio</code> and <code>video</code> (boolean; true/false) attributes when <code>true</code> will cause the player to ''always'' appear in the "Play using..." menu even if you don't define any rules for the player, or no rules match the currently selected media item (e.g. video file) for the player.
You could, for instance, define a player with <code>video="true"</code> and then ''not'' tie it to any specific rule, thus creating some sort of "safety net", always available in the context menu, should you ever need it.

The only ''required'' node for a player with <code>type</code> ''ExternalPlayer'' is the <code><filename/></code> node, this should contain the path of the external player executable. The other, optional, nodes are

{| class="prettytable"
|-
! Name
! Value
! Use
|-
! args
|
| Arguments to pass to the external player executable.<br />
If this contains the token '''{0}''' then this is replaced with the full URI of the item to be played (note that this is, in many cases, Kodi-specific and your external player won't understand it).<br />A '''{1}''' token is also replaced with the URI of the item to be played, but with the following differences<br />
* For rar and zip files '''{1}''' is the path of the archive and '''{2}''' will be the relative path to the file in the archive
* On win32 smb-URIs (smb://host/path) are converted into UNCs (\\host\path)<br />
* For LiveTV streams/files the pvr:// type url is not translated and {1} still returns the Kodi-specific URI which will not be interpretable by the external player
'''NOTE you should surround these tokens with double-quotes (e.g. '''"{1}"''') unless you know what you're doing and have a good reason not to, as they may contain spaces.'''<br />
If none of these tokens are present then it's equivalent to having '''"{1}''' at the end.
|-
! hidexbmc
| style="white-space:nowrap" | '''false''' ''(default)''<br />'''true'''
| whether to hide the Kodi window whilst the external player is active
|-
! hideconsole
| style="white-space:nowrap" | '''false''' ''(default)''<br />'''true'''
| ''Win32 only'' - whether the external player process is started with the initial window hidden (useful for hiding the console when the external player is a batch file)
|-
! warpcursor
| style="white-space:nowrap" | '''none''' ''(default)''<br />'''topleft'''<br />'''topright'''<br />'''bottomleft'''<br />'''bottomright'''
| ''Win32 only'' - whether and where to move the cursor to before the external player is launched
|-
! playcountminimumtime
| style="white-space:nowrap" | ''number of seconds''
| the time the extplayer process needs to run for before the item's playcount will be incremented (i.e. it will be marked as watched)
|-
! playonestackitem
| style="white-space:nowrap" | '''false''' ''(default)''<br />'''true'''
| whether playback should stop after playing one item that's part of a stack
|}

Once a user has defined one or more external player, they have the option of adding ''rules'' to customize ''which files'' are handled by ''which players''. The above example, for instance, defines the MPC-HC external player as the default player for MKV files with "720p" in their filename. <code>.*</code> before and after "720p" is a [http://en.wikipedia.org/wiki/Regular_expression#Standards regular expression] (regex).
* <code>.</code> "Matches any single character."
* <code>*</code> "Matches the preceding element zero or more times."<br />
Together they mean "Matches any single character (.) zero or more times (*)".

A <code><rules/></code> node contains a set of rules. An (optional) <code>action</code> attribute can have a value of <code>prepend</code>, <code>append</code> or <code>overwrite</code> which specifies whether the rules should be prepended, appended (the default if no action is specified) or replace all existing rules. Appended rules will take precedence over default players (i.e. DVDPlayer for video and PAPlayer for audio) but not over Kodis builtin rules. '''[needs better/more complete explanation]'''

A <code><rule/></code> node compares its attributes against the attributes of a media item and if everything matches then the player names in the player attribute is the default player for the media item (you can still select another using the "Play using..." menu). The attributes are listed below. Order of <code><rule/></code>s is significant '''[needs clarification]''', the first match defines the player so order them from more-to-less specific.

<code><rule/></code>s can be nested with inner rules inheriting attributes from outer rules, with inner rules being checked before outer rules. For example:

<syntaxhighlight lang=xml enclose="div">
<rules action="prepend">
<rule video="true" player="wmplayer">
<rule dvd="true" player="dvdplayer"/>
<rule filetypes="mkv" player="VLC">
<rule filename=".*720.*|.*1080.*" player="MPC-HC"/>
</rule>
</rule>
</rules>
</syntaxhighlight>

says that all video should be played by wmplayer, except DVDs, that are played with (the builtin) dvdplayer, and .mkv files that are played with VLC, however .mkv files with "720{{"}} or "1080" in their names are played with MPC-HC (all assuming wmplayer, VLC and MPC-HC players are defined in the players section).

The following attributes can be used to build rules:
{| class="prettytable"
|-
! Attribute
! Type
! Value
|-
| name || string
| name of the rule
|-
| internetstream || boolean
| when '''true''' the rule applies to internet streams
|-
| remote || boolean
| when '''true''' the rule applies to remote-only (non-local) media
|-
| audio || boolean
| when '''true''' the rule applies to audio-only media
|-
| video || boolean
| when '''true''' the rule applies to video media
|-
| dvd || boolean
| when '''true''' the rule applies to DVDs
|-
| dvdimage || boolean
| when '''true''' the rule applies to DVD images (iso)
|-
| dvdfile || boolean
| when '''true''' the rule applies to DVD folder structures
|-
| protocols || regexp
| when defined the rule applies to items whose (URI) protocol matches; as well as "real" protocols like daap, rtv, rtsp Kodi also uses the URI protocol for things like zip, rar etc.
|-
| filetypes || regexp
| when defined the rule applies to items whose file extension matches
|-
| mimetypes || regexp
| when defined the rule applies to items whose mime-type matches
|-
| filename || regexp
| when defined the rule applies to items whose filename matches
|-
| player || string
| the name of the player defined in the <players> section this rule invokes
|}
For the regexp attributes you can specify alike with a |-separator, e.g. '''mkv|avi|divx''' ("The choice operator matches either the expression before or the expression after the operator").

The following attributes are also available for video items with metadata (a.k.a. flagging):
{| class="prettytable"
|-
! Attribute
! Type
! Value
|-
| videocodec || regexp
| matched against the video codec so, a rule could used '''<nowiki>xvid|divx|div3|div4|div5</nowiki>'''
|-
| videoresolution || regexp
| matched against the video resolution, which will be one of '''480''', '''540''', '''720''' or '''1080'''
|-
| videoaspect || boolean
| matched against the video aspect ratio, which will be one of '''1.33''', '''1.66''', '''1.78''', '''1.85''', '''2.20''' or '''2.35'''
|-
| hdrtype || regexp
| matched against the video hdr type, which could be one of '''none''' (=sdr video), '''hdr10''', '''hlg''', '''dolbyvision''' - ''v22 and above''
|-
| audiocodec || regexp
| matched against the audio codec, e.g. '''ac3<nowiki>|</nowiki>dts'''
|-
| audiochannels || regexp
| matched against the number of channels in the audio which will be an integer (i.e. '''6''' rather than '''5.1''')
|}

{{divbox|orange||'''Note:''' There's currently no way to get a resume point if an external player is in use. After a specific duration (which can be modified via the [[Advancedsettings.xml|advancedsettings.xml]]) the specific video will be marked as watched. But Kodi will not set a resume point for it.}}

== Examples ==
On Kodi for Android running on TI OMAP pandaboard I was able to take advantage of hw acceleration by changing /data/data/org.xbmc.kodi/cache/apk/assets/system/playercorefactory.xml to launch Gallery on mp4 files as follows:

=== Android ===
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>

<player name="Gallery" type="ExternalPlayer" audio="true" video="true">
<filename>am</filename>
<args>start -n com.android.gallery3d/.app.MovieActivity -d {1}</args>
<hidexbmc>true</hidexbmc>
<hideconsole>true</hideconsole>
</player>
<player name="DVDPlayer" audio="true" video="true" />
</players>
<rules name="system rules">
<rule name="rtv" protocols="rtv" player="DVDPlayer" />
<rule name="hdhomerun/myth/mms/udp" protocols="hdhomerun|myth|cmyth|mms|mmsh|udp" player="DVDPlayer" />
<rule name="lastfm/shout" protocols="lastfm|shout" player="PAPlayer" />

<rule name="rtsp" protocols="rtsp" filetypes="!(rm|ra)" player="PAPlayer" />

<rule name="streams" internetstream="true">
<rule name="aacp/sdp" mimetypes="audio/aacp|application/sdp" player="DVDPlayer" />
<rule name="mp2" mimetypes="application/octet-stream" filetypes="mp2" player="PAPlayer" />
</rule>

<rule name="dvd" dvd="true" player="DVDPlayer" />
<rule name="dvdimage" dvdimage="true" player="DVDPlayer" />

<rule name="sdp/asf" filetypes="sdp|asf" player="DVDPlayer" />

<rule name="nsv" filetypes="nsv" player="DVDPlayer" />
<rule name="dgb" filetypes="*.mp4" player="Gallery"/>

<rule name="radio" filetypes="pvr" filename=".*/radio/.*" player="DVDPlayer" />
</rules>
</playercorefactory>
</syntaxhighlight>

I tested this only very lightly but it improved playback smoothness and obviously reduced cpu load. ymmv.

=== Ubuntu ===

{{divbox|orange||'''Note:''' The Ubuntu OS has a long-lasting NFS bug which prevents Kodi from playing files directly via its own internal NFS sources using an external video player. You will have to set up NFS mounts directly via the Ubuntu OS to have this work correctly.}}

In GNU/Linux the location of the file should be: <code>~/.kodi/userdata/playercorefactory.xml</code>

There are cross-platform standalone video players which are supported by Kodi. Hereunder are two of them. The Full-screen option has been added, otherwise you will have a windowed video player.

==== VLC ====
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>
<player name="VLC" type="ExternalPlayer" audio="false" video="true">
<filename>/usr/bin/vlc</filename>
<args>--fullscreen "{1}"</args>
<hidexbmc>false</hidexbmc>
</player>
</players>
<rules action="prepend">
<rule video="true" player="VLC"/>
</rules>
</playercorefactory>
</syntaxhighlight>

==== MPV ====
<syntaxhighlight lang=xml enclose="div">
<playercorefactory>
<players>
<player name="MPV" type="ExternalPlayer" audio="false" video="true">
<filename>/usr/bin/mpv</filename>
<args>--fs=yes "{1}"</args>
<hidexbmc>false</hidexbmc>
</player>
</players>
<rules action="prepend">
<rule video="true" player="MPV"/>
</rules>
</playercorefactory>
</syntaxhighlight>

== See also ==
;Windows
* [[forum:43511|Forums:External Player Support Thread on the Kodi forums]]
* [[forum:116724|Forums:Working External Player Solution]]

;Android
* [[HOW-TO:Use external players on Android]]

{{updated|18}}
[[Category:Players]]
[[Category:Manual]]
[[Category:Advanced topics]]

Sources.xml

2024-04-09T13:35:13Z

Crystalp:

{{mininav|[[Settings]]|[[Kodi data folder]]|[[Userdata]]}}

{{warning|This page is for reference. Users should not edit sources.xml directly, but instead manage sources via the Kodi GUI.}}

'''sources.xml''' is the configuration file where Kodi stores your media source locations. In this section we will concentrate on xml syntax of sources and the various options that are available.<br />

The configuration file ''sources.xml'' exists in the ''userdata folder''. It depends on your Operating System (Linux, Mac, XP, Vista) and if you changed the default settings during installation, where you can find your ''userdata folder''. See [[Userdata|Userdata Folder]] to find out where you have to look.<br />

==== XML Syntax and Source Breakdown ====
XML syntax is very similar to html syntax, but can be less forgiving. Lets first take a look at a source:
<code>
<music>
<default>Main Music Collection</default>
<source>
<name>Main Music Collection</name>
<path>smb://username:password@server.com/share/music/</path>
<allowsharing>true</allowsharing>
</source>
</music>
</code>

===== Some basics to cover first =====
:; Tags : Each word inside of <> symbols is called a 'tag'. Tags can either be starting, or ending tags. To make an ending tag you simply add a forward slash / to the beginning of the tag name. <tag> is a starting tag </tag> is an ending tag. Developers try to make tag names as self explanatory as possible. <name> for example is the name of the source.

:; Data : Between two tags is where any data associated with that source is stored. <tag>DATA</tag>. You can also store other tags inside of each other

'''Example:'''
<code>
<music>
<default>Main Music Collection</default>
<source>
<name>Main Music Collection</name>
<path>smb://username:password@server.com/share/music/</path>
<thumbnail>E:\Apps\XBMC\media\music.png</thumbnail>
<allowsharing>true</allowsharing>
<lockmode>1</lockmode>
<lockcode>12345678</lockcode>
</source>
</music>
</code>

===== Required Fields =====
:; <music></music>
:: This tag defines which section your source belongs to. Other valid sections are <programs> <video> <pictures> and <files>. You cannot have multiple <music> sections in your xml file.

:; <name></name>
:: The Name of the source. This will accept any characters in the current character set.

:; <path></path>
:: The path of the source. This can be a local path such as "e:\media\images\" or remote url such as "smb://username:password@serverip/path/". You may have more than one <path> tag in a single source, called multipaths. in Multipaths the directory listings will be combined. See [[Sources.xml/Types|Types of Media Sources]] for more information concerning paths.
:: '''*''' Multipath sources are restricted to local (PC or Xbox built-in hard drive), smb/samba, and xbms paths.
:: '''*''' The path can not be a playable object or an executable file, (ie a video, audio or .xbe file), it must be a share or a sub folder under a share.

'''Multipath Example:'''
<code>
<music>
<source>
<name>Main Music Collection</name>
<path>F:\Music</path>
<path>smb://username:password@server.com/share/music/</path>
<allowsharing>true</allowsharing>
</source>
</music>
</code>

'''Podcast Example:'''
<code>
<video>
<source>
<name>podcast_Tekzilla Weekly</name>
<path pathversion="1">rss://revision3.com/tekzilla/feed/quicktime-high-definition/?subshow=false</path>
</source>
</video>
</code>

===== Optional Fields =====
<br>

::'''Thumbnails'''
:: All sources can have a custom thumbnail icon.
<code>
<thumbnail>e:\media\images\videos.png</thumbnail>
</code>

::'''Sharing / Remote access'''
<code>
<allowsharing>true</allowsharing>
</code>
::This parameter configures the permission to access the content of the source from Kodi Webserver and UPnP.
::If set to true (Default value when source is added from GUI) then the content of the source can be accessed.
::Set this value to false to disable remote access, while still allowing playback inside Kodi.

{{DISPLAYTITLE:sources.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]

Advancedsettings.xml

2024-04-04T16:18:49Z

Crystalp:

{{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 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang=xml enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang=xml enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
</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 text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</video>
</syntaxhighlight>
|
|}

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang=xml enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang=xml enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>

<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>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}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of regular expressions. For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang=xml enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|Naming_video_files/Movies}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang=xml enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a Regular Expression

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\[\]\-]|[^0-9]$)?</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of Regular Expressions. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of Regular Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.
:* A [https://forum.kodi.tv/showthread.php?tid=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of Regular Expressions.

Default:
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of Regular Expressions. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang=xml enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of Regular Expressions

Defaults:
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

<syntaxhighlight lang=xml enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang=xml enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

== Library artwork ==

{{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/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 Available image scaling algorithms]

<syntaxhighlight lang=text enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang=xml enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang=xml enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== sorttokens ===
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/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> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>}}<section end="MusicLibrary" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng
</pre>

Examples:
<syntaxhighlight lang=xml enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of Regular Expressions

<syntaxhighlight lang=xml enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang=xml enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang=xml enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang=xml enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== 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> 
<chunksize>65536</chunksize> 
</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}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang=xml enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang=xml enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang=xml enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang=xml enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== 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?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Advanced topics]]
[[Category:Manual]]
[[Category:Settings]]
[[Category:Karellen]]