https://kodi.wiki/api.php?action=feedcontributions&feedformat=atom&user=Jjd-ukOfficial Kodi Wiki - User contributions [en]2026-06-21T03:19:23ZUser contributionsMediaWiki 1.43.8https://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232752Advancedsettings.xml2021-08-04T15:34:11Z<p>Jjd-uk: /* Removed tags */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music<br />
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music<br />
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music<br />
* '''<fanart>''' Removed in v19<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232751Advancedsettings.xml2021-08-04T15:26:34Z<p>Jjd-uk: /* Library artwork */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music<br />
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music<br />
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music<br />
* '''<fanart>''' Removed<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232750Advancedsettings.xml2021-08-04T15:25:46Z<p>Jjd-uk: /* Removed tags */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== fanart ===<br />
{{anchor|.3Cfanart.3E}}<br />
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)<br />
*Used for '''music only'''<br />
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanart><br />
<remove>fanart.jpg</remove><br />
<add>backdrop.jpg</add><br />
</fanart><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music<br />
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music<br />
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music<br />
* '''<fanart>''' Removed<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232749Advancedsettings.xml2021-08-04T15:09:28Z<p>Jjd-uk: /* musiclibrary */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== fanart ===<br />
{{anchor|.3Cfanart.3E}}<br />
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)<br />
*Used for '''music only'''<br />
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanart><br />
<remove>fanart.jpg</remove><br />
<add>backdrop.jpg</add><br />
</fanart><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music<br />
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music<br />
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232748Advancedsettings.xml2021-08-04T15:08:42Z<p>Jjd-uk: /* Removed tags */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== fanart ===<br />
{{anchor|.3Cfanart.3E}}<br />
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)<br />
*Used for '''music only'''<br />
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanart><br />
<remove>fanart.jpg</remove><br />
<add>backdrop.jpg</add><br />
</fanart><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
==== Music library extra artwork ====<br />
<br />
New for Kodi v18.<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "thumb" for artists and albums, and "fanart" for artists.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musiclibrary><br />
<!-- ... combine with "musiclibrary" section above --><br />
<!-- Additional artwork to add for artists --><br />
<artistextraart><br />
<arttype>banner</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>clearart</arttype><br />
<arttype>landscape</arttype><br />
</artistextraart><br />
<!-- Additional artwork to add for albums --><br />
<albumextraart><br />
<arttype>discart</arttype><br />
<arttype>spine</arttype><br />
<arttype>back</arttype><br />
</albumextraart><br />
</musiclibrary><br />
</syntaxhighlight><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music<br />
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music<br />
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232747Advancedsettings.xml2021-08-04T13:47:10Z<p>Jjd-uk: /* Removed tags */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== fanart ===<br />
{{anchor|.3Cfanart.3E}}<br />
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)<br />
*Used for '''music only'''<br />
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanart><br />
<remove>fanart.jpg</remove><br />
<add>backdrop.jpg</add><br />
</fanart><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
==== Music library extra artwork ====<br />
<br />
New for Kodi v18.<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "thumb" for artists and albums, and "fanart" for artists.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musiclibrary><br />
<!-- ... combine with "musiclibrary" section above --><br />
<!-- Additional artwork to add for artists --><br />
<artistextraart><br />
<arttype>banner</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>clearart</arttype><br />
<arttype>landscape</arttype><br />
</artistextraart><br />
<!-- Additional artwork to add for albums --><br />
<albumextraart><br />
<arttype>discart</arttype><br />
<arttype>spine</arttype><br />
<arttype>back</arttype><br />
</albumextraart><br />
</musiclibrary><br />
</syntaxhighlight><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Advancedsettings.xml&diff=232746Advancedsettings.xml2021-08-04T13:43:52Z<p>Jjd-uk: /* Library artwork */</p>
<hr />
<div>{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}<br />
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}<br />
<br />
<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[Userdata|userdata folder]]'''.<br />
<br />
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" /><br />
<br />
The following page will describe the structure of the advancedsettings.xml file and the various individual settings.<br />
<br />
{{note|<br />
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.<br />
# 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.<br />
# 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>}}<br />
<br />
== Layout ==<br />
<br />
The layout of <code>advancedsettings.xml</code> is as follows:<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings version="1.0"><br />
<setting>value</setting><br />
...<br />
<setting>value</setting><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
where "setting" gives the name of the setting, and "value" gives its value.<br />
<br />
A list of the available "setting" strings and their values is given below.<br />
<br />
= List of available settings =<br />
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><br />
<br />
Recommended: Use the table of contents or the search function in your browser to locate items.<br />
<br />
<br />
== Troubleshooting settings ==<br />
<br />
<br />
=== loglevel ===<br />
{{Anchor|.3Cloglevel.3E}}<br />
<br />
<section begin="loglevel" /><br />
Sets the logging level used to log errors and information. The "hide" attribute is optional. <br />
<br />
<syntaxhighlight lang=xml><br />
<loglevel hide="attribute">options</loglevel><br />
</syntaxhighlight><br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Attribute<br />
! style="width:500px;" | Action<br />
|-<br />
! '''true''' <br />
| Hides the "enable debugging" setting in the Settings page. (default)<br />
|-<br />
! '''false'''<br />
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Option<br />
! style="width:500px;" | Action<br />
|-<br />
! '''-1'''<br />
| No logging, suppresses all log output <br />
|-<br />
! '''0'''<br />
| Normal logging, only logging errors (default)<br />
|-<br />
! '''1'''<br />
| Debug logging with freemem, fps and cpu usage (no on screen)<br />
|-<br />
! '''2''' <br />
| Same as 1 (with on screen display)<br />
|-<br />
! '''3''' <br />
| Same as 2 + full smb logging (no on screen display)<br />
|}<br />
<br />
{| class="mw-collapsible mw-collapsed wikitable" <br />
|-<br />
! style="width:100px;" | Example <br />
! style="width:500px;" | <br />
|-<br />
! Example 1:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel>2</loglevel> <br />
</advancedsettings><br />
</syntaxhighlight><br />
|-<br />
! Example 2:<br />
|<syntaxhighlight lang=xml enclose="div"><br />
<advancedsettings><br />
<loglevel hide="true">2</loglevel><br />
</advancedsettings><br />
</syntaxhighlight><br />
|}<br />
<br />
'''Note:''' The setting is persistent through shutdown and restarts.<br><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 /><br />
<section end="loglevel" /><br />
:''{{see also|Log_file|label 1=Debug Log}}''<br />
<br />
=== jsonrpc ===<br />
{{Anchor|.3Cjsonrpc.3E}}<br />
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.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<jsonrpc><br />
<compactoutput>false</compactoutput><br />
<tcpport>9999</tcpport><br />
</jsonrpc><br />
</syntaxhighlight><br />
<br />
== Audio/video playback settings ==<br />
<br />
=== skiploopfilter ===<br />
{{anchor|.3Cskiploopfilter.3E}}<br />
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)<br />
* -16 None<br />
* 0 Skip only empty frames (default)<br />
* 8 Skip non-reference frames<br />
* 16 Skip bi-dir frames<br />
* 32 Skip all non-key frames<br />
* 48 Skip all frames<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<skiploopfilter>8</skiploopfilter><br />
</syntaxhighlight><br />
<br />
=== video ===<br />
{{anchor|.3Cvideo.3E}}<br />
<br />
The <video> section also includes the following child-tags, which have their own sections:<br />
*[[#cleandatetime]]<br />
*[[#cleanstrings]]<br />
*[[#excludefromscan]]<br />
*[[#excludefromlisting]]<br />
*[[#excludetvshowsfromscan]]<br />
<br />
<br />
{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}<br />
<br />
{| class="prettytable"<br />
! Tag !! Description<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<video><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<subsdelayrange>10</subsdelayrange><br />
</syntaxhighlight><br />
| Delay range for subtitles, in seconds.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<maxtempo>2.1</maxtempo><br />
</syntaxhighlight><br />
| Allow further increase of playback speed over the default of 1.5<br><br />
maxtempo must be in the range of 1.5 to 2.1 <br><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 />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<audiodelayrange>10</audiodelayrange><br />
</syntaxhighlight><br />
| Delay range for audio/video sync, in seconds.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<usetimeseeking>true</usetimeseeking><br />
</syntaxhighlight><br />
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<timeseekforwardbig>600</timeseekforwardbig><br />
<timeseekbackwardbig>-600</timeseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforward>2</percentseekforward><br />
<percentseekbackward>-2</percentseekbackward><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<percentseekforwardbig>10</percentseekforwardbig><br />
<percentseekbackwardbig>-10</percentseekbackwardbig><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<fullscreenonmoviestart>true</fullscreenonmoviestart><br />
</syntaxhighlight><br />
| Whether to go to fullscreen or not when starting a movie. Defaults to true.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<defaultplayer>VideoPlayer</defaultplayer><br />
</syntaxhighlight><br />
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromscan><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromscan><br />
</syntaxhighlight><br />
| 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<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<excludefromlisting><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</syntaxhighlight><br />
| Regular expressions that if evaluated to true won't be displayed in files view.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<playcountminimumpercent>90</playcountminimumpercent><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignoresecondsatstart>180</ignoresecondsatstart><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ignorepercentatend>8</ignorepercentatend><br />
</syntaxhighlight><br />
| 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]] }}''<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<vdpauscaling>true</vdpauscaling><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<enablehighqualityhwscalers>true</enablehighqualityhwscalers><br />
</syntaxhighlight><br />
| Allow turning on the spline36 and lanczos3 shader (for GL builds).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<dxvaallowhqscaling>false</dxvaallowhqscaling><br />
</syntaxhighlight><br />
| Enables high quality video upscaling for Windows.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing><br />
</syntaxhighlight><br />
| Override the deinterlacing options passed to libpostproc.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing><br />
</syntaxhighlight><br />
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<autoscalemaxfps>30</autoscalemaxfps><br />
</syntaxhighlight><br />
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<adjustrefreshrate> <br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fps>23.976</fps><br />
<refresh>60.0</refresh><br />
</override><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''fps''' - if the fps is between 23.966 and 23.986<br />
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<override><br />
<fpsmin>29.96</fpsmin><br />
<fpsmax>30.01</fpsmax><br />
<refreshmin>59.0</refreshmin><br />
<refreshmax>61.0</refreshmax><br />
</override><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' <br />
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.<br />
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refresh>50.0</refresh><br />
</fallback><br />
</syntaxhighlight><br />
| 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.<br />
<br />
* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fallback><br />
<refreshmin>49.0</refreshmin><br />
<refreshmax>51.0</refreshmax><br />
</fallback><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.<br />
<br />
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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</adjustrefreshrate><br />
</syntaxhighlight><br />
| style="background:#CADCFB;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<checkdxvacompatibility>value</checkdxvacompatibility><br />
</syntaxhighlight><br />
| 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.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<useocclusionquery>-1</useocclusionquery><br />
</syntaxhighlight><br />
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<fpsdetect>1</fpsdetect><br />
</syntaxhighlight><br />
| FPS detection for video playback<br />
* 0 = trust codec fps<br />
* 1 = recalculate from video timestamps with uniform spacing<br />
* 2 = recalculate from video timestamps always<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.<br />
|- <br />
|<br />
<syntaxhighlight lang=xml><br />
<delay>0</delay><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | Global default display latency.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh></refresh><br />
</syntaxhighlight><br />
| 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.<br />
<br />
Syntax of an override entry:<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>, <max> refresh rate range, OR<br />
<rate> exact refresh rate<br />
<delay> display latency for the given refresh rate<br />
</refresh><br />
</syntaxhighlight><br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<min>23</min><br />
<max>24</max><br />
<delay>125</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<refresh><br />
<rate>50</rate><br />
<delay>50</delay><br />
</refresh><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</latency><br />
</syntaxhighlight><br />
| style="background:#F0E68C;" | <br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d><br />
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs><br />
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab><br />
</syntaxhighlight><br />
| Filename triggers for 3D (stereoscopic) mode.<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
<assfixedworks>false</assfixedworks><br />
</syntaxhighlight><br />
| 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).<br />
|-<br />
|<br />
<syntaxhighlight lang=xml><br />
</video><br />
</syntaxhighlight><br />
| <br />
|}<br />
<br />
=== audio ===<br />
{{anchor|.3Caudio.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<audio><br />
<!-- Amount of headroom Kodi should use above the maximum volume level, in decibels. Defaults to 0, valid values 0, 6, 12. --><br />
<headroom>0</headroom><br />
<!-- Default audio player: paplayer or videoplayer --><br />
<defaultplayer>paplayer</defaultplayer><br />
<!-- Regular expressions that if evaluated to true won't be added to library. --><br />
<excludefromscan> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromscan><br />
<!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<excludefromlisting> <br />
<regexp>[-\._ ](podcast)[-\._ ]</regexp><br />
</excludefromlisting><br />
<!-- Amount of gain (dB) to be applied to AC3 streams that have been mixed-down to 2 channels. Default is 12.0. Valid values are: -96.0 to 96.0. --><br />
<ac3downmixgain>12.0</ac3downmixgain><br />
<!-- Whether to use time based or percentage based seeking. --><br />
<usetimeseeking>true</usetimeseeking><br />
<!-- Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekforwardbig>600</timeseekfowardbig><br />
<!-- Time to seek backward in seconds when doing a long seek back. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. --><br />
<timeseekbackwardbig>-600</timeseekbackward><br />
<!-- Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal --><br />
<playcountminimumpercent>99</playcountminimumpercent> <br />
<!-- Whether to use Dynamic Range Compression (DRC) on AC3 streams. 1.0 is "full" compression, as defined by the audio track's metadata, which is recommended for "basic" sound systems such as the internal speakers on a TV. 0.0 is no compression at all, which is recommended for people with nice multi-speaker sound systems. -1.0 (default) defaults to whatever ffmpeg uses, which is currently the same as 1.0. This has no effect if passthrough is enabled for AC3. --><br />
<applydrc>-1.0</applydrc> <br />
<!-- default values for limiter/compressor --><br />
<limiterhold>0.025</limiterhold> <br />
<!-- default values for limiter/compressor --><br />
<limiterrelease>0.1</limiterrelease> <br />
</audio><br />
</syntaxhighlight><br />
<br />
<br />
=== forcedswaptime ===<br />
{{anchor|.3Cforcedswaptime.3E}}<br />
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). <br />
<br />
Default: Off<br />
<br />
<br />
=== edl ===<br />
{{anchor|.3Cedl.3E}}<br />
{{main|Edit_decision_list}}<br />
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.<br />
<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<edl><br />
<!-- if true, commercial breaks will be merged according to the remaining options. --><br />
<mergeshortcommbreaks>false</mergeshortcommbreaks><br />
<!-- Commercial breaks won't be merged if the total length of the commercial break would be greater than this (seconds) --><br />
<maxcommbreaklength>250</maxcommbreaklength><br />
<!-- After merging, commercial breaks shorter than this will be removed (seconds) --><br />
<mincommbreaklength>90</mincommbreaklength><br />
<!-- Commercial breaks that are further apart than this won't be merged (seconds) --><br />
<maxcommbreakgap>120</maxcommbreakgap><br />
<!-- How long to wait before automatically skipping when the start of a commercial break reached (seconds). Possible values: from -60 to 60--><br />
<commbreakautowait>0</commbreakautowait><br />
<!-- How long to rewind after automatically skipping to the end of the commercial break (seconds). Possible values: from -60 to 60 --><br />
<commbreakautowind>0</commbreakautowind><br />
</edl><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== PVR & Live TV ==<br />
{{anchor|.3Cpvr.3E}}<br />
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.<br />
<br />
<br />
=== pvr ===<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<timecorrection>0</timecorrection> <!-- Correct all times (epg tags, timer tags, recording tags) by this amount of minutes. --><br />
<infotoggleinterval>3000</infotoggleinterval> <!-- If there is more than one pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. --><br />
<channeliconsautoscan>true</channeliconsautoscan> <!-- Automatically scan user defined folder for channel icons when loading internal channel groups. --><br />
<autoscaniconsuserset>false</autoscaniconsuserset> <!-- Mark channel icons populated by auto scan as "user set". --><br />
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> <!-- Time in ms before the numeric dialog auto closes when confirmchannelswitch is disabled. --><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
==== pvrrecordings ====<br />
{{Future|19|'''pvrrecordings''' describes features that are a future part of the Kodi v19 release, codename "Matrix"}}<br />
Allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref><br />
<br />
;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<pvr><br />
<pvrrecordings><br />
<sortmethod>2</sortmethod> <!-- 1=Name 2=Date 3=Size 4=File --><br />
<sortorder>2</sortorder> <!-- 1=Ascending 2=Descending --><br />
</pvrrecordings><br />
</pvr><br />
</syntaxhighlight><br />
<br />
<br />
=== epg ===<br />
{{anchor|.3Cpvr.3E}}<br />
<syntaxhighlight lang="xml" line='line'><br />
<epg><br />
<updatecheckinterval>300</updatecheckinterval> <!-- Check every X seconds, if EPG data need to be updated. This does not mean that every X seconds an EPG update is actually triggered, it's just the interval how often to check whether an update should be triggered. If this value is greater than GUI setting 'epg.epgupdate' value, then EPG updates will done with the value specified for 'updatecheckinterval', effectively overriding the GUI setting's value. --><br />
<updateemptytagsinterval>60</updateemptytagsinterval> <!-- If a TV channel has no EPG data, try to obtain data for that channel every X seconds. This overrides the GUI setting 'epg.epgupdate' value, but only for channels without EPG data. If this value is less than 'updatecheckinterval' value, then data update will be done with the interval specified by 'updatecheckinterval'. Example 1: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 60 => trigger an EPG update for every channel without EPG data every 5 minutes and trigger an EPG update for every channel with EPG data every 2 hours. Example 2: epg.epgupdate = 120 (minutes!), updatecheckinterval = 300, updateemptytagsinterval = 3600 => trigger an EPG update for every channel without EPG data every 2 hours and trigger an EPG update for every channel with EPG data every 1 hour. --><br />
<cleanupinterval>900</cleanupinterval> <!-- remove old entries from the EPG every X seconds --><br />
<activetagcheckinterval>60</activetagcheckinterval> <!-- check for updated active tags every X seconds --><br />
<retryinterruptedupdateinterval>60</retryinterruptedupdateinterval> <!-- retry an interrupted EPG update after X seconds --><br />
<displayupdatepopup>true</displayupdatepopup> <!-- display a progress popup while updating EPG data from clients --><br />
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> <!-- also display a progress popup while doing incremental EPG updates --><br />
</epg><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Video library settings ==<br />
<br />
=== videoextensions ===<br />
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" /><br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.<br />
<br />
Default extensions for VIDEOS:<br />
<pre><br />
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid<br />
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4<br />
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts<br />
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv<br />
.bdm .wtv .trp .f4v<br />
</pre><br />
Examples:<br />
<pre><br />
<videoextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</videoextensions><br />
</pre><br />
<section end="videoextensions" /><br />
<br />
=== discstubextensions ===<br />
{{main|Media stubs}}<br />
<br />
<section begin="discstubextensions" /><br />
The default filename extension for Disc Stubs is:<br />
<syntaxhighlight lang=xml enclose="div"><br />
.disc<br />
</syntaxhighlight><br />
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.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<discstubextensions><br />
<add>.disk|.stub</add><br />
<remove>.disc</remove><br />
</discstubextensions><br />
</syntaxhighlight><br />
<section end="discstubextensions" /><br />
<br />
=== languagecodes ===<br />
{{anchor|.3Clanguagecodes.3E}}<br />
Translation table for subtitle and audio names. Contains entries of the form<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<languagecodes><br />
<code><br />
<short>alt</short><br />
<long>Alternate</long><br />
</code><br />
</languagecodes><br />
</syntaxhighlight><br />
<br />
<br />
=== moviestacking ===<br />
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" /><br />
{{main|Naming_video_files/Movies}}<br />
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of "''[[RegEx_tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''<br />
<br />
As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking><br />
<!-- <cd/dvd/part/pt/disk/disc> <0-N> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp><br />
<!-- <cd/dvd/part/pt/disk/disc> <a-d> --><br />
<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
<!-- movienamea-xvid.avi, movienameb-xvid.avi --><br />
<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="append"><br />
<!-- This expression will match movename1-xvid.avi, moviename2-xvid.avi.<br />
Be warned that it will likely stack sequels in a flat directory layout,<br />
so it is only recommend in a dir-per-video layout. --><br />
<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
<br />
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. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<moviestacking action="prepend"><br />
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp><br />
</moviestacking><br />
</syntaxhighlight><br />
<br />
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.<br />
<section end="moviestacking" /><br />
<br />
=== folderstacking ===<br />
{{main|Naming_video_files/Movies}}<br />
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).<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<folderstacking><br />
<!-- <cd/dvd/disk/disc> <0-N> --><br />
<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp><br />
</folderstacking><br />
</syntaxhighlight><br />
<br />
=== cleandatetime ===<br />
{{anchor|.3Ccleandatetime.3E}}<br />
Matches a year number in a string using a ''[[RegEx_tutorial|Regular Expression]]'' <br />
<br />
Default expression:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleandatetime>(.*[^ _\,\.\(\)\[\]\-])[ _\.\(\)\[\]\-]+(19[0-9][0-9]|20[0-9][0-9])([ _\,\.\(\)\[\]\-]|[^0-9]$)?</cleandatetime><br />
</video><br />
</syntaxhighlight><br />
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions. <br />
:* By default date formats like MM:YY are ignored.<br />
<br />
=== cleanstrings ===<br />
{{anchor|.3Ccleanstrings.3E}}<br />
Clean unwanted characters from filenames or folders by using a list of ''[[RegEx_tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.<br />
<br />
Default expressions:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<cleanstrings><br />
<regexp>[ _\,\.\(\)\[\]\-](ac3|dts|custom|dc|remastered|divx|divx5|dsr|dsrip|dutch|dvd|dvd5|dvd9|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|extended|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|3d|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\(\)\[\]\-]|$)</regexp><br />
<regexp>(\[.*\])</regexp><br />
</cleanstrings><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== tvshowmatching ===<br />
{{anchor|.3Ctvshowmatching.3E}}<br />
Matches the season and episode numbers in file paths by using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvshowmatching><br />
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> <!-- foo.s01.e01, foo.s01_e01, S01E02 foo, S01 - E02, S01xE02 --><br />
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> <!-- foo.ep01, foo.EP_01 --><br />
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> <!-- foo.yyyy.mm.dd.* (byDate=true) --><br />
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> <!-- foo.mm.dd.yyyy.* (byDate=true) --><br />
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> <!-- foo.1x09* or just /1x09* --><br />
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> <!-- foo.103*, 103 foo --><br />
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> <!-- Part I, Pt.VI --><br />
</tvshowmatching><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
:* Paths are converted to lower case before matching.<br />
:* Examples of matching regexps for certain filenames can be found on the [[Naming_video_files/TV_shows|TV shows]] page.<br />
<br />
:* 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.<br />
<br />
:* 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.<br />
<br />
==== Filenames without Season ====<br />
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<br />
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.<br />
<br />
; Simple Method ''(XBMC v9.11 onwards and Kodi)''<br />
: Use only one pair of parentheses<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight><br />
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''<br />
: Supports multi-episode files without season<br />
: Use an empty pair of parentheses for the season<br />
<syntaxhighlight lang=xml enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''<br />
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.<br />
: Works with both the simple method and advanced method<br />
: If not used, the season will be set to '1'<br />
: Useful for setting specials to season '0'<br />
<syntaxhighlight lang=xml enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp><br />
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight><br />
<br />
=== tvmultipartmatching ===<br />
{{anchor|.3Ctvmultipartmatching.3E}}<br />
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[RegEx_tutorial|Regular Expressions]]''.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching><br />
</syntaxhighlight><br />
:* Text matching is compared case-insensitive.<br />
:* Specifying this option '''replaces''' the default value<br />
<br />
=== excludefromscan ===<br />
{{anchor|.3Cexcludefromscan.3E}}<br />
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[RegEx_tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludefromscan><br />
<regexp>-trailer</regexp><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludefromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== excludefromlisting ===<br />
{{anchor|.3Cexcludefromlisting.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video> <br />
<excludefromlisting> <!-- Regular expressions that if evaluated to true won't be displayed in Files View --><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</excludefromlisting><br />
</video><br />
</syntaxhighlight><br />
<br />
=== excludetvshowsfromscan ===<br />
{{anchor|.3Cexcludetvshowsfromscan.3E}}<br />
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
Defaults:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<video><br />
<excludetvshowsfromscan><br />
<regexp>[!-._ \\/]sample[-._ \\/]</regexp><br />
</excludetvshowsfromscan><br />
</video><br />
</syntaxhighlight><br />
<br />
:* 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)<br />
<br />
=== trailermatching ===<br />
{{anchor|.3Ctrailermatching.3E}}<br />
Contains "''[[RegEx_tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[RegEx_tutorial|RegEx]]''" or "''[[RegEx_tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<trailermatching><br />
<!-- This regexp will match moviename_Trailer.avi --><br />
<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp><br />
</trailermatching><br />
</syntaxhighlight><br />
<br />
=== videolibrary ===<br />
{{anchor|.3Cvideolibrary.3E}}<br />
Options specific to the Video Library<br />
<br />
<syntaxhighlight lang="xml" line='line'><br />
<videolibrary><br />
<allitemsonbottom>false</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<usefasthash>true</usefasthash> <!-- defaults to true. Set to false in order to skip hashing based on the folders modification time. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* --><br />
<exportautothumbs>false</exportautothumbs> <!-- export auto-generated thumbs. Defaults to false --><br />
<importwatchedstate>false</importwatchedstate> <!-- import previously exported playdate and playcount from .nfo files. Defaults to false --><br />
<importresumepoint>false</importresumepoint> <!-- import previously exported resume point from .nfo files. Defaults to false --><br />
<dateadded>1</dateadded> <!-- 0 results in using the current datetime when adding a video;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
==== Extra artwork ====<br />
<br />
Applies to Kodi v18 only.<br />
<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "poster" and "fanart" for movies, movie sets, TV shows, seasons, and music videos; "banner" for TV shows and seasons; and "thumb" for episodes.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videolibrary><br />
<!-- ... combine with "videolibrary" settings above --><br />
<!-- Additional artwork to add for TV shows --><br />
<tvshowextraart><br />
<arttype>characterart</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</tvshowextraart><br />
<!-- Additional artwork to add for TV show seasons --><br />
<tvseasonextraart><br />
<arttype>landscape</arttype><br />
</tvseasonextraart><br />
<!-- Additional artwork to add for TV show episodes --><br />
<episodeextraart><br />
<arttype>fanart</arttype><br />
</episodeextraart><br />
<!-- Additional artwork to add for movies --><br />
<movieextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</movieextraart><br />
<!-- Additional artwork to add for movie sets / collections --><br />
<moviesetextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
<arttype>keyart</arttype><br />
</moviesetextraart><br />
<!-- Additional artwork to add for musicvideos --><br />
<musicvideoextraart><br />
<arttype>banner</arttype><br />
<arttype>clearart</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>discart</arttype><br />
<arttype>landscape</arttype><br />
</musicvideoextraart><br />
</videolibrary><br />
</syntaxhighlight><br />
<br />
=== videoscanner ===<br />
{{anchor|.3Cvideoscanner.3E}}<br />
Options specific to the Video scanner<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videoscanner><br />
<ignoreerrors>true</ignoreerrors> <!-- Set to true to silently ignore errors while scanning videos. This prevents the error dialogue box, so you don't have to keep hitting "yes" to keep scanning.--><br />
</videoscanner><br />
</syntaxhighlight><br />
<br />
== Library artwork ==<br />
<br />
{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}<br />
<br />
=== imageres ===<br />
{{anchor|.3Cimageres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<imageres>720</imageres><br />
</syntaxhighlight><br />
<br />
=== fanartres ===<br />
{{anchor|.3Cfanartres.3E}}<br />
<br />
<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" /><br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanartres>1080</fanartres><br />
</syntaxhighlight><br />
<br />
=== fanart ===<br />
{{anchor|.3Cfanart.3E}}<br />
A list of additional files to scan when searching for local fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)<br />
*Used for '''music only'''<br />
*Cannot be used in conjunction with ''[[Advancedsettings.xml#Music_library_extra_artwork|2.6.5.1 Music library extra artwork]]'' to rename extra fanart.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fanart><br />
<remove>fanart.jpg</remove><br />
<add>backdrop.jpg</add><br />
</fanart><br />
</syntaxhighlight><br />
<br />
=== imagescalingalgorithm ===<br />
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.<br />
<br /><br />
<syntaxhighlight lang=xml enclose="div"><br />
<imagescalingalgorithm>bicubic</imagescalingalgorithm><br />
</syntaxhighlight><br />
<br />
[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]<br />
<br />
<syntaxhighlight lang=text enclose="div"><br />
fast_bilinear<br />
bilinear<br />
bicubic<br />
experimental<br />
nearest_neighbor<br />
averaging_area<br />
bicublin<br />
gaussian<br />
sinc<br />
lanczos<br />
bicubic_spline<br />
</syntaxhighlight><br />
<br />
== Video and music library settings ==<br />
<br />
=== playlistasfolders ===<br />
{{anchor|.3Cplaylistasfolders.3E}}<br />
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.<br />
<br />
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.<br />
<br />
:{{note|This setting will not affect smart playlists, they will always show as folders.}}<br />
<br />
;Example<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistasfolders>true</playlistasfolders><br />
</syntaxhighlight><br />
<br />
=== playlistretries ===<br />
{{anchor|.3Cplaylistretries.3E}}<br />
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.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlistretries>100</playlistretries><br />
</syntaxhighlight><br />
<br />
=== playlisttimeout ===<br />
{{anchor|.3Cplaylisttimeout.3E}}<br />
The timeout, in seconds, before item failure.<br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<playlisttimeout>20</playlisttimeout> <br />
</syntaxhighlight><br />
<br />
<br />
=== sorttokens ===<br />
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.<br />
{{note|Sort tokens are case sensitive.}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token>the</token><br />
</sorttokens><br />
</syntaxhighlight><br />
<br />
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<br />
<syntaxhighlight lang=xml enclose="div"><br />
<sorttokens><br />
<token separators="'">L</token><br />
</sorttokens><br />
</syntaxhighlight><br />
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".<br />
<br />
<br />
=== musicdatabase/videodatabase ===<br />
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}<br />
{{main|MySQL}}<br />
<section begin="videodatabase" /><br />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.<br />
<br />
:{{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.'''}}<br />
<br />
<br />
'''Parent tags:'''<br />
<br />
<br />
* '''<videodatabase>'''<br />
* '''<musicdatabase>'''<br />
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''<br />
{{MySQL warning}}<br />
<br />
<br />
'''Child tags: '''<br />
<br />
<br />
;<type><br />
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)<br />
<br />
<br />
;<host><br />
:''Required'' - <br />
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).<br />
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)<br />
<br />
<br />
;<port><br />
: ''Optional'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the port of the mysql socket (default: 3306)<br />
<br />
<br />
;<name><br />
: ''Optional'' -<br />
:by default "MyVideos"+DB number will be used.<br />
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.<br />
* mysql: defines the name of the database to use<br />
<br />
<br />
;<user><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the user with privileged access to the database<br />
<br />
<br />
;<pass><br />
: ''Required for MySQL'' -<br />
* sqlite3: silently ignored<br />
* mysql: defines the password for the user with privileged access to the database<br />
<br />
<br />
;<compression><br />
: ''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]<br />
: {{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}}<br />
<br />
<br />
<br />
;<key><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<cert><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ca><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<capath><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
;<ciphers><br />
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]<br />
<br />
<br />
'''Examples:'''<br />
<br />
1) Configure a database for MySQL.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<videodatabase><br />
<type>mysql</type><br />
<host>192.168.0.10</host><br />
<name>kodi_video</name><br />
<user>kodi</user><br />
<pass>kodi</pass><br />
</videodatabase><br />
</syntaxhighlight><br />
<br />
2) Configure a database for an sqlite database.<br />
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicdatabase><br />
<type>sqlite3</type><br />
<host>/usr/local/share/kodi/databases</host><br />
</musicdatabase><br />
</syntaxhighlight><br />
<br />
<section end="videodatabase" /><br />
<br />
=== externalplayer ===<br />
{{anchor|.3Cexternalplayer.3E}}<br />
{{see|External players}}<br />
<br />
== Music settings ==<br />
<br />
=== musicextensions ===<br />
{{anchor|.3Cmusicextensions.3E}}<br />
<section begin="musicextensions" /><br />
Default extensions for MUSIC:<br />
<pre><br />
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx<br />
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav<br />
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8<br />
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd<br />
</pre><br />
<br />
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.<br />
<br />
<musicextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</musicextensions><br />
<br />
<section end="musicextensions" /><br />
<br />
=== cddbaddress ===<br />
{{anchor|.3Ccddbaddress.3E}}<br />
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. <br />
<br />
Default: <br />
<syntaxhighlight lang=xml enclose="div><br />
<cddbaddress>freedb.freedb.org</cddbaddress><br />
</syntaxhighlight><br />
<br />
=== songinfoduration ===<br />
{{anchor|.3Csonginfoduration.3E}}<br />
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. <br />
<br />
Default:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<songinfoduration>10</songinfoduration><br />
</syntaxhighlight><br />
<br />
=== musicfilenamefilters ===<br />
{{anchor|.3Cmusicfilenamefilters.3E}}<br />
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:<br />
<br />
<pre><br />
%A - Artist<br />
%T - Title<br />
%B - Album<br />
%N - Track number<br />
%S - Part of set (disk number)<br />
%D - Duration<br />
%G - Genre<br />
%Y - Year<br />
%R - Rating<br />
</pre><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musicfilenamefilters><br />
<filter>%A - %T</filter><br />
</musicfilenamefilters><br />
</syntaxhighlight><br />
<br />
=== musiclibrary ===<br />
Options specific to the Music Library<br />
<section begin="MusicLibrary" /><br />
<syntaxhighlight lang="xml" line='line'><br />
<musiclibrary><br />
<allitemsonbottom>true</allitemsonbottom> <!-- sorts the "*All" items at the bottom of the list when in Ascending order --><br />
<cleanonupdate>false</cleanonupdate> <!-- default set to false to prevent Kodi from removing items from the database while updating. --><br />
<recentlyaddeditems>35</recentlyaddeditems> <!-- number of recently added items. Defaults to 25 --><br />
<albumformat>%B - %Y</albumformat> <!-- album label template, default is "%B" --><br />
<prioritiseapetags>true</prioritiseapetags> <!-- prioritise APEv2 tags over ID3v1/2 tags, default is false. --><br />
<itemseparator> / </itemseparator> <!-- separator used for multiple artists/genres in tags. Note, this is *space* *slash* *space* See Note below--><br />
<artistseparators> <!-- separator used for multiple artists. Note that spaces are used for some separators. See Note below--><br />
<separator>;</separator><br />
<separator>:</separator><br />
<separator>|</separator><br />
<separator> feat. </separator><br />
<separator> ft. </separator><br />
</artistseparators><br />
<dateadded>1</dateadded> <!--0 results in using the current datetime when adding a song;<br />
1 (default) results in prefering to use the files mtime (if it's valid) and only using the file's ctime if the mtime isn't valid;<br />
2 results in using the newer datetime of the file's mtime and ctime --><br />
<br />
<!-- New for v19 and later releases --><br />
<useisodates>false</useisodates> <!-- When "true" all dates displayed in the music library will be in ISO 8601 format (YYYY-MM-DD or part thereof).<br />
Defaults to "false" (use localized dates) --> <br />
</musiclibrary><br />
</syntaxhighlight><br />
{{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" /><br />
<br />
==== Music library extra artwork ====<br />
<br />
New for Kodi v18.<br />
Configuration to expand the artwork automatically added by Kodi to media items in the library, either from local files or online scrapers.<br />
<br />
The original basic artwork types are still hardcoded so they don't need to be configured here (and can't be removed). "thumb" for artists and albums, and "fanart" for artists.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<musiclibrary><br />
<!-- ... combine with "musiclibrary" section above --><br />
<!-- Additional artwork to add for artists --><br />
<artistextraart><br />
<arttype>banner</arttype><br />
<arttype>clearlogo</arttype><br />
<arttype>clearart</arttype><br />
<arttype>landscape</arttype><br />
</artistextraart><br />
<!-- Additional artwork to add for albums --><br />
<albumextraart><br />
<arttype>discart</arttype><br />
<arttype>spine</arttype><br />
<arttype>back</arttype><br />
</albumextraart><br />
</musiclibrary><br />
</syntaxhighlight><br />
<br />
== Photos settings ==<br />
<br />
=== pictureextensions ===<br />
{{anchor|.3Cpictureextensions.3E}}<br />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.<br />
<br />
Default extensions for PICTURES:<br />
<pre><br />
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .rss .webp .jp2 .apng<br />
</pre><br />
<br />
Examples:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureextensions><br />
<add>.ex1|.ex2</add><br />
<remove>.ex3|.ex4</remove><br />
</pictureextensions><br />
</syntaxhighlight><br />
<br />
=== pictureexcludes ===<br />
{{anchor|.3Cpictureexcludes.3E}}<br />
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[RegEx_tutorial|Regular Expressions]]''<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pictureexcludes> <!-- Regular expressions that if evaluated to true won't be displayed in My Pictures --><br />
<regexp>small</regexp><br />
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp><br />
</pictureexcludes><br />
</syntaxhighlight><br />
<br />
=== slideshow ===<br />
{{anchor|.3Cslideshow.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<slideshow><br />
<!-- Amount to pan images as a percentage of the screen --><br />
<panamount>2.5</panamount><br />
<!-- Amount to zoom images as a percentage of the screen --><br />
<zoomamount>5.0</zoomamount><br />
<!-- Amount to compensate (zoom) images to attempt to reduce black bars. --><br />
<!-- Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image. --><br />
<!-- Defaults to 20. --><br />
<blackbarcompensation>20</blackbarcompensation> <br />
</slideshow><br />
</syntaxhighlight><br />
<br />
== Network settings ==<br />
<br />
=== ftp ===<br />
{{anchor|.3Cftp.3DE}}<br />
Specific settings if a ftp server is in use as a source<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<ftp><br />
<remotethumbs>true</remotethumbs> <!-- enable extraction of flag and thumb for ftp --><br />
</ftp><br />
</syntaxhighlight><br />
<br />
=== samba ===<br />
{{anchor|.3Csamba.3E}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<samba><br />
<doscodepage></doscodepage> <!-- code page to use for filenames --><br />
<clienttimeout>10</clienttimeout> <!-- timeout (in seconds) --><br />
<statfiles>true</statfiles> <!-- Set to false to disable smb stat() on files to speed up listings of large directories (over slow links) --><br />
</samba><br />
</syntaxhighlight><br />
<br />
=== hosts ===<br />
{{anchor|.3Cfhosts.3E}}<br />
Static dns entries which take precedence over your dns server.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<hosts><br />
<entry name="HOSTNAME">IPADDRESS</entry><br />
</hosts><br />
</syntaxhighlight><br />
<br />
=== network ===<br />
{{anchor|.3Cnetwork.3E}}<br />
<br />
<syntaxhighlight lang=xml line='line'><br />
<network><br />
<curlclienttimeout>10</curlclienttimeout> <!-- Timeout in seconds for libcurl (http/ftp) connections --><br />
<curllowspeedtime>20</curllowspeedtime> <!-- Time in seconds for libcurl to consider a connection lowspeed --><br />
<curlretries>2</curlretries> <!-- Amount of retries for certain failed libcurl operations (e.g. timeout) --><br />
<httpproxyusername></httpproxyusername> <!-- username for Basic Proxy Authentication --><br />
<httpproxypassword></httpproxypassword> <!-- password for Basic Proxy Authentication --><br />
<disableipv6>false</disableipv6> <!-- Certain hardware/OS combinations have trouble with ipv6. Set "true" to disable --><br />
<disablehttp2>false</disablehttp2> <!-- Added in v19- Allows disabling HTTP2 for broken Curl / HTTP2 servers --><br />
<nfstimeout>30</nfstimeout> <!-- Added in v19- Timeout in seconds for NFS access, 0 = wait forever (previous behaviour) default is 5s --><br />
<catrustfile>filepath</catrustfile> <!-- Added in v19- Allows specifying a custom SSL CA trust store bundle. e.g. special://masterprofile/cacerts.pem --><br />
</network><br />
</syntaxhighlight><br />
<br />
{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}<br />
<br />
=== cache ===<br />
{{see also|HOW-TO:Modify_the_video_cache}}<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cache><br />
<memorysize>0</memorysize> <!-- Number of bytes used for buffering streams in memory when set to 0 the cache will be written to disk instead of RAM --><br />
<buffermode>0</buffermode> <!-- Choose what to buffer:<br />
0) Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) <br />
1) Buffer all filesystems (including local) (default since Kodi 19)<br />
2) Only buffer true internet filesystems (streams) (http, https, etc.)<br />
3) No buffer<br />
4) Buffer all network filesystems (incl. smb, nfs, etc.) --><br />
<readfactor>4.0</readfactor> <!-- This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. <br />
This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value 4.0. --><br />
</cache><br />
</syntaxhighlight><br />
<br />
=== airtunesport ===<br />
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" /><br />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).<br />
<section end="airtunesport" /><br />
<br />
=== airplayport ===<br />
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" /><br />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).<br />
<section end="airplayport" /><br />
<br />
== File system settings ==<br />
<br />
=== packagefoldersize ===<br />
<section begin="packagefoldersize" /><br />
{{anchor|.3Cpackagefoldersize.3E}}<br />
{{xml setting<br />
| tag name = packagefoldersize<br />
| option type = numerical<br />
| option values = <br />
| default values = 200<br />
| platform = all<br />
| XBMC version = 12<br />
| 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.<br />
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> <!-- this example would keep up to 200MB of add-on packages. --></syntaxhighlight><br />
}}<br />
<section end="packagefoldersize" /><br />
<br />
=== detectasudf ===<br />
{{anchor|.3Cdetectasudf.3E}}<br />
Set to true if you wish to detect joint ISO9660/UDF disks as UDF. <br />
<br />
Default: False<br />
<br />
=== pathsubstitution ===<br />
{{anchor|.3Cpathsubstitution.3E}}<br />
{{main|Path substitution}}<br />
<br />
{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}<br />
<br />
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. <br />
<br />
Default: No path substitutions defined. <br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<pathsubstitution><br />
<substitute><br />
<from>G:\dvds\</from><br />
<to>smb://somecomputer/g-share/dvds/</to> <!-- Note the difference between the usage of forward and backslashes --><br />
</substitute><br />
</pathsubstitution><br />
</syntaxhighlight><br />
<br />
== Input control settings ==<br />
<br />
=== remotedelay ===<br />
{{anchor|.3Cremotedelay.3E}}<br />
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). <br />
<br />
Default: 3<br />
<syntaxhighlight lang=xml enclose="div"><br />
<remotedelay>10</remotedelay><br />
</syntaxhighlight><br />
<br />
<br />
=== controllerdeadzone ===<br />
{{anchor|.3Ccontrollerdeadzone.3E}}<br />
This advanced settings has been removed. <br />
Since v17, the [[Advancedsettings.xml#controllerdeadzone|&lt;controllerdeadzone&gt;]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.<br />
<br />
<br />
=== enablemultimediakeys ===<br />
{{anchor|.3Cenablemultimediakeys.3E}}<br />
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<enablemultimediakeys>true</enablemultimediakeys><br />
</syntaxhighlight><br />
<br />
<br />
=== seeksteps ===<br />
{{Main|Skip steps}}<br />
<br />
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.<br />
<br />
'''Default:'''<br />
<syntaxhighlight lang=xml enclose="div"><br />
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps><br />
</syntaxhighlight><br />
<br />
{{editor note|the defaults need to be updated for seeksteps.}}<br />
<br />
<br />
=== touchscreen ===<br />
{{anchor|.3Ctouchscreen.3E}}<br />
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.<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<touchscreen><br />
<x_offset>0</x_offset> <!-- set pixel x offset to align it to the used display--><br />
<y_offset>0</y_offset> <!-- set pixel y offset to align it to the used display--><br />
<x_stretch_factor>1.0</x_stretch_factor> <!-- stretch/compress the touch x axis--><br />
<y_stretch_factor>1.0</y_stretch_factor> <!-- stretch/compress the touch y axis--><br />
</touchscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== scanirserver ===<br />
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref><br />
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.<br />
<br />
The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<scanirserver>true</scanirserver><br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Other interface settings ==<br />
<br />
=== window ===<br />
{{anchor|.3Cwindow.3E}}<br />
{{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}}<br />
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.<br />
<br />
WIDTH and HEIGHT are the values for each dimension, in pixels.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<window><br />
<width>WIDTH</width><br />
<height>HEIGHT</height><br />
</window><br />
</syntaxhighlight><br />
<br />
<br />
=== restrictcapsmask ===<br />
{{anchor|.3Crestrictcapsmask.3E}}<br />
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.<br />
<br />
1: prevent the use of compressed textures (DXT1, DXT3, DXT5)<br />
2: prevent the use of non-power-of-two dimensions for textures<br />
4: prevent the use of compressed textures with non-power-of-two dimensions.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<restrictcapsmask>0</restrictcapsmask><br />
</syntaxhighlight><br />
<br />
<br />
=== algorithmdirtyregions ===<br />
{{anchor|.3Calgorithmdirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<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.}}<br />
<br />
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.<br />
<br />
{| class="prettytable"<br />
! value !! result !! description<br />
|-<br />
! 0<br />
| Off<br />
| The entire viewport is always rendered.<br />
|-<br />
! 1<br />
|Union<br />
|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.<br />
|-<br />
! 2<br />
| {{nowrap|Cost reduction}}<br />
| Each dirty region is presented separately, in as many passes as there are regions.<br />
|-<br />
! 3<br />
| {{nowrap|Whole Screen}}<br />
| 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'''<br />
|}<section end="algorithmdirtyregions" /><br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<algorithmdirtyregions>1</algorithmdirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== visualizedirtyregions ===<br />
{{anchor|.3Cvisualizedirtyregions.3E}}<br />
{{see also|HOW-TO:Modify dirty regions}}<br />
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
{{note|This is only a development mode and isn't of use to normal users.}}<br />
<section end="visualizedirtyregions" /><br />
Example: <br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<visualizedirtyregions>true</visualizedirtyregions><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== smartredraw ===<br />
<br />
{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}<br />
<br />
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<br />
<br />
* true: on<br />
* false: off '''(Default)'''<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gui> <br />
<smartredraw>true</smartredraw><br />
</gui><br />
</syntaxhighlight><br />
<br />
<br />
=== showexitbutton ===<br />
{{anchor|.3Cshowexitbutton.3E}}<br />
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)<br />
<br />
Example:<br />
<syntaxhighlight lang=xml enclose="div"><br />
<showexitbutton>true</showexitbutton><br />
</syntaxhighlight><br />
<br />
<br />
=== fullscreen ===<br />
{{anchor|.3Cfullscreen.3E}}<br />
Starts Kodi in full screen (check resolutions!).<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<fullscreen>false</fullscreen><br />
</syntaxhighlight><br />
<br />
<br />
=== splash ===<br />
{{anchor|.3Csplash.3E}}<br />
Set to false if you wish to disable the startup splash image. Defaults to true.<br />
<br />
<syntaxhighlight lang=xml enclose="div"><br />
<splash>true</splash><br />
</syntaxhighlight><br />
<br />
<br />
=== cputempcommand ===<br />
{{anchor|.3Ccputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia and Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sed -e 's/\([0-9]*\)[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]\([0-9]\+\).*/\1 C/p"</cputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== gputempcommand ===<br />
{{anchor|.3Cgputempcommand.3E}}<br />
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 /><br />
;<u>For Nvidia</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand><br />
</syntaxhighlight><br />
or<br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand><br />
</syntaxhighlight><br />
;<u>For ATI/AMD</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand><br />
</syntaxhighlight><br />
<br />
;<u>For Raspberry Pi</u><br />
<syntaxhighlight lang=xml enclose="div"><br />
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand><br />
</syntaxhighlight><br />
<br />
<br />
=== glrectanglehack ===<br />
{{anchor|.3Cglrectanglehack.3E}}<br />
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<glrectanglehack>yes</glrectanglehack><br />
</syntaxhighlight><br />
<br />
<br />
=== alwaysontop ===<br />
{{anchor|.3Calwaysontop.3E}}<br />
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<alwaysontop>yes</alwaysontop><br />
</syntaxhighlight><br />
<br />
There is also a fake fullscreen GUI option in Kodi's settings.<br />
<br />
<br />
=== minimizetotray ===<br />
{{anchor|.3Cminimizetotray.3E}}<br />
{{note|Available in Kodi v20 and above.}}<br />
<br />
Windows only. Minimizes Kodi to the system tray. Defaults to false.<br />
<syntaxhighlight lang=xml enclose="div"><br />
<minimizetotray>true</minimizetotray><br />
</syntaxhighlight><br />
<br />
= Removed tags =<br />
{{anchor|Recently removed tags}}<br />
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo<br />
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo<br />
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo<br />
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham<br />
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham<br />
* '''<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.<br />
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix<br />
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix<br />
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard<br />
* '''<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]].<br />
* '''<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.<br />
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.<br />
* '''<useddsfanart>''' - removed in v17 Krypton.<br />
* '''<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.<br />
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.<br />
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.<br />
* '''<nofliptimeout>''' - Removed in v17<br />
* '''<blackbarcolour>''' - Removed in v17 (maybe?)<br />
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)<br />
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?<br />
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18<br />
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed<br />
* '''<backgroundupdate>''' - Removed<br />
* '''<hideemptyseries>''' - Replaced by a GUI option.<br />
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed<br />
* '''<albumssortbyartistthenyear'''> - Removed<br />
* '''<albumformatright>''' - Removed<br />
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed<br />
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18<br />
* '''<lingertime>''' - Replaced by a GUI setting in v18<br />
* '''<forcevaapienabled>''' - Removed in v18<br />
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.<br />
* '''<controllerdeadzone>''' - Removed in v17<br />
* '''<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<br />
<br />
<br />
<br />
= guisettings.xml Setting Conversion =<br />
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.<br />
<br />
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.<br />
<br />
Why would I need to do this?<br />
* 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<br />
* You need to hide settings to prevent those settings from being modified<br />
<br />
<br />
To convert a guisetting to advancedsettings.xml follow these steps:<br />
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.<br />
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file<br />
# Locate the guisettings.xml file in the [[Userdata]] folder and open it<br />
# 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<br />
# Using the following setting as an example:<br />
<syntaxhighlight lang="xml"><br />
<setting id="videolibrary.showemptytvshows">true</setting><br />
</syntaxhighlight><br />
: Breaking down the string:<br />
::'''videolibrary'''- parent tag<br />
::'''showemptytvshows'''- child tag<br />
::'''true'''- value<br />
: The conversion is as follows and place this in the advancedsettings.xml file<br />
<syntaxhighlight lang="xml"><br />
<advancedsettings version="1.0"><br />
<videolibrary><br />
<showemptytvshows>true</showemptytvshows><br />
</videolibrary><br />
</advancedsettings><br />
</syntaxhighlight><br />
<br />
'''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.<br />
<br />
<br />
<br />
= References =<br />
<references /><br />
<br />
<br />
{{Updated|18}}<br />
{{DISPLAYTITLE:advancedsettings.xml}}<br />
<br />
[[Category:Advanced topics]]<br />
[[Category:Manual]]<br />
[[Category:Settings]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Basic_controls&diff=221963Basic controls2020-11-17T19:19:20Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[First time user]]}}<br />
<br />
<br />
= Introduction =<br />
'''Welcome new user!!''' <section begin="intro" />You have finally installed Kodi on your equipment, launched it, and then probably sat there for a few minutes scratching your head thinking what is this?? This page will describe the commonly used screens and basic navigation around Kodi. Its aim is to allow you to become familiar with Kodi and prepare you for the upcoming setup pages.<section end="intro" /><br />
<br />
This page will not describe how to load your media. That task is covered in the following pages. As with most pages of the wiki, this page assumes you are using the default skin '''[[Add-on:Estuary|Estuary]]'''. If you are using another skin, then you have run before learning to walk, so you should change back until you have at least set up Kodi.<br />
<br />
Kodi has been designed around the ''[https://en.wikipedia.org/wiki/10-foot_user_interface 10 foot interface]'' principle. This means that Kodi is best used with a remote control while sitting on your couch looking at your TV. It was not designed for use on a computer sitting at a desk with keyboard and mouse. '''If you choose to use it this way, then be aware that the navigatione experience won't be as smooth as a remote control.'''<br />
<br />
{{red|Although this guide applies to all parts of Kodi, some portions have been based on the Video/Movies/TV Shows section of Kodi. To see the specific Basic Controls for Music, see '''''[http://kodi.wiki/view/Music_navigation Music Navigation & Playback]}}'''''<br />
<br />
<br />
The following image is a screenshot of the Home Screen when Kodi launches. In this case there is media in the library, but you may not have media in your library yet.<br />
<br />
<gallery mode="packed" widths="900px" heights="506px"><br />
File:HomeScreenGuide.jpg<br />
</gallery><br />
{{-}}<br />
<br />
<br />
= Power Options =<br />
[[File:Estuary-power-menu.jpg|right|300px]]<br />
Pressing {{keypress|S}} on the keyboard, or by selecting the Power icon in the top left corner of the home screen calls up the Power Options menu. Depending on your hardware, your Power Options may have more or less options to that shown in the image.<br />
<br />
The options on this menu are from top to bottom:<br />
<br />
;Exit<br />
:Exits Kodi to your operating system.<br />
;Power off system<br />
:Powers down your computer<br />
;Custom Shutdown Timer<br />
:Kodi will shutdown your computer after you enter the countdown time. Enter the time interval in minutes.<br />
;Suspend<br />
:Suspends your computer.<br />
;Hibernate<br />
:Hibernates your computer.<br />
;Reboot<br />
:Restarts your computer.<br />
;Log off <ProfileName> user<br />
:If using Profiles, the option to log out the current user and login as a new user is this option. <ProfileName> will display the name of the currently logged in Profile/User.<br />
<br />
<br />
<br />
= Settings =<br />
The Settings Icon in the top left of the screen provides access to the Kodi Settings pages. Most general use settings are contained in these pages. During your travels with Kodi, you will come across mention of the advancedsettings.xml file. This holds advanced Settings for Kodi and can be modified by the user.<br />
<br />
For more information on the Settings pages, {{See|Settings}}<br />
<br />
For more information on the advancedsettings.xml file, {{see|Advancedsettings.xml}}<br />
<br />
<br />
<br />
= Search & Filter =<br />
[[File:GlobalSearch.jpg|right|300px]]<br />
The Global Search function allows you to search your library, add-ons or some on-line sources for information. <br />
<br />
Some of the pictured options will require installation of an add-on. Simply confirm the installation of the add-on when prompted.<br />
<br />
{{see|Add-on:Global Search}}<br />
{{see|Add-on:YouTube}}<br />
{{see|Add-on:ExtendedInfo Script}}<br />
<br />
<br />
There are also Search functions inside each of the Main Menu options which are accessible from the [[Basic_controls#Sideblade_Menu|Sideblade Menu]]. These are called '''Filters'''. The function "filters" the currently displayed list to match your query. When using the Filter function, be aware of the following:<br />
*The Filter will only filter that class of media, so performing the Filter in Movies will only return Movie results.<br />
*The Filter only works when you have a listing of media displayed. If you do not have a listing of the media to Filter, then the filter will return a ''Not Found'' result. <br />
<br />
{{see|Advanced library filtering}}<br />
{{-}}<br />
<br />
<br />
<br />
= Main Menu =<br />
All classes of media are separated into their own menu options. The default classes are listed below. Other skins allow you to add additional menu items for, say, Home Movies, Cartoons, Disney etc.<br />
<br />
It is possible to remove unwanted menu options and to re-add them at a later date. Very useful for those options that remain unused in your setup such as Live TV, Radio etc. See: '''''[[Add-on:Estuary/Settings#Main_Menu_Items_Settings|Hiding Menu items]]'''''<br />
<br />
As each Main Menu option is selected, the Home Page will dynamically update with information relevant for the selected menu option. The full list of available menu options are as follows:<br />
<br />
* '''[[Video_library|Movies]]''' - This is a short cut to the "All movies, by title" node in the video library.<br />
* '''[[Video_library|TV shows]]''' - This is a short cut to the "All TV shows, by title" node in the video library.<br />
* '''[[Music_library|Music]]''' - This is a shortcut to a file manager view, which when viewed, can show your music files either by genre, Artist, Album, Song, or by year.<br />
* '''[[Music_library|Music Videos]]''' - This is a shortcut to a file manager view, which when viewed can show your music video files either by Genre, Title, Artist, Albums, Directors, Studio or Tags<br />
* '''[[Live_TV|Live TV]]''' - With a PVR add-on, this can give you Free To Air Television channels with an EPG (Electronic Program Guide) with Pause/Rewind/Fast Forward and Record facilities<br />
* '''[[Live_TV|Radio]]''' - With a PVR add-on, this can give you Free To Air Radio Channels with an EPG (Electronic Program Guide)<br />
* '''[[Games]]''' (not available before Kodi v18 Leia) - This is a shortcut to a file manager view, which when viewed, can show your games. <br />
* '''[[Add-ons]]''' - This shortcut takes you to a secondary menu that lists your installed add-ons by type, such as 'Video-addons', Music add-ons, Program add-ons. In this menu you can install add-ons from the official Kodi repository. '''''See: [[Add-ons]]'''''<br />
* '''[[Pictures]]''' - Shows a basic file-based image viewer, as well as picture-related add-ons.<br />
* '''[[Video_library|Vidoes]]''' - Allows you to access the file system of your Sources. It includes file views, movie library, TV show library, music video library, playlists, and video related add-ons. Users can also use this to navigate to more '''[[video nodes|nodes]]''' in the library, showing movies or TV shows by year, genre, actor, or even custom created nodes for specific people, moods, etc.<br />
* '''[[Favourites]]''' - Shows all your meda that has been tagged as a ''Favourite'' in one easily accessible location.<br />
* '''[[Weather]]''' - Once set up, this will show the weather forecast in your local area<br />
<br />
= Home Screen =<br />
The term '''Home Screen''' can be used to mean the entire screen as depicted in the image in Section 1 above. If it is prefixed by a menu item, say ''Movies Home Screen'' or ''TV Show Home Screen'', then it refers to the section to the right of the Main Menu. The following information refers to the latter.<br />
<br />
The Home Screen contains a dynamic list of media relevant for the selected main menu item. The image above displays the following items:<br />
<br />
;Categories- also known as Nodes<br />
:A quick link to the available Movie Nodes. It allows you to navigate your Movie library via Genres, Title, Year, Country Actors, Directors, Studios, Sets, Tags and Recently added<br />
:{{see also|Video_nodes|Music_nodes}}<br />
<br />
;Poster views<br />
:Displays movie titles that fit into the following criteria:<br />
:*In-progress<br />
:*Recently added<br />
:*Unwatched movies<br />
:*Random selection<br />
:*Movie Sets<br />
<br />
;Genres<br />
:Quck icon selection of available Genre's in the library.<br />
<br />
;Studios<br />
:Quick icon selection of available Studios in the library.<br />
<br />
<br />
The other classes in the main menu have a similar selection but designed and named to be most relevant for their class of media.<br />
<br />
<br />
<br />
= '''Sideblade Menu''' =<br />
[[File:EstuarySideBarMenu_small.gif|right]]<br />
[[File:Estuary-player-sidebar-video.jpg|210px|right]]<br />
<br />
'''{{resize|1.4em|{{red|The Sideblade Menu is a critical menu that holds numerous options. It is available in most locations.}}}}'''<br />
<br />
The Sideblade Menu is accessible from '''most''' screens in Kodi.<br />
<br />
{{red|The menu options shown below are for the Movies section. The options will vary for the other media classes}}<br />
<br />
<section begin="SidebladeMenu" />You can invoke the sideblade using one of the following methods:<br />
* pressing the {{keypress|left}} key on your remote control<br />
* pressing the {{keypress|left}} key on a keyboard<br />
* bringing the mouse cursor to the left border of the screen.<section end="SidebladeMenu" /><br />
<br />
<br />
The options in the Sideblade Menu vary. The following is the menu in the Movies listing.<br />
<br />
<br />
'''Available Options'''<br />
<br />
;ViewType<br />
:Change current library view.<br />
<br />
;Sort by<br />
:Select how the list of Movies/TV Shows/Episodes are sorted- eg ''Title, PlayCount'' etc<br />
<br />
;Order<br />
:Once the ''Sort by'' is selected, do you want the order ''Ascending'' or ''Descending''<br />
<br />
;Filter<br />
:Allows you to filter your list on certain criteria- eg ''Director, Actor, Ratings, Tags'' etc '''''See: [[Advanced library filtering]]'''''<br />
<br />
;All Videos / Watched / Unwatched<br />
:Global toggle that allows you to select what is shown in the list - ''All Videos, Watched'' or ''Unwatched'' videos only<br />
<br />
;Update library<br />
:Scans the library for newly added Movies, TV Shows, Episodes and Music Videos in the Video Library.<br />
<br />
;Go to playlists<br />
:Will open the currently playing Party Mode playlist<br />
<br />
;Bottom Icons- From Left to right<br />
*Pause<br />
*Stop<br />
*Skip to next video<br />
*Open Fullscreen mode - for video this returns you to the playing video and for music this opens the Now Playing/Visualisation window.<br />
<br />
<br />
To see the Sidebar Menu for '''Music''' see '''''[[Music_navigation#Sideblade_Menu|Music Sideblade Menu]]'''''<br />
{{-}}<br />
<br />
<br />
<br />
= '''Context Menu''' =<br />
'''{{resize|1.4em|{{red|The Context Menu is a critical menu that holds numerous options. It is available in most locations.}}}}'''<br />
<br />
The '''Context Menu''' allows quick access to a limited set of functions relevant for the currently selected item. <br />
<br />
<section begin="ContextMenu" />After highlighting an item (eg a movie) the Context Menu can be invoked by:<br />
* long press the {{keypress|OK}} key<br />
* Press letter {{keypress|C}} on a keyboard<br />
* right-clicking with the mouse<section end="ContextMenu" /><br />
<br />
References to Context Menus are scattered throughout the wiki on relevant pages and can be found easily enough in Kodi. As there are many, many types of context menus, it would be uneconomical to list them all here.<br />
<br />
The following are a few examples of the context menu.<br />
<gallery mode="packed-overlay" widths="500px" heights="283px"><br />
File:MovieSets02.jpg|The context menu in the ''Movie library''.<br />
File:EstuaryContextmenu3.png|The context menu in the ''Video file browser''.<br />
File:EstuaryContextmenu2.png|The context menu in the [[Add-on:YouTube|YouTube]] add-on.<br />
</gallery><br />
<br />
<br />
<br />
= '''Information Page''' =<br />
[[File:Artwork-Actors01.jpg|right|500px]]<br />
<section begin="InformationPage" />For each title in the Movies, TV Shows and Music Videos library, an Information Page is available as displayed in the image.<br />
<br />
This screen will display the metadata for the title. A number of options are available along the bottom of the page. What is displayed will depend on the skin in use and which class of media is displayed (Movie, TV Show, Music Video)<section end="InformationPage" /><br />
<br />
This is a Library only feature and will not work on titles not in the library. Attempting to perform this in the File Browser using Videos>Files will commence the scrape process for that individual title. '''''See: [[Updating_or_removing_videos|Update Video Library]]'''''<br />
<br />
<br />
To access the Information Page, navigate to, and highlight the required Movie, TV Show or Music Video title. Once highlighted use one of the following methods to view the Information Page:<br />
*Press {{keypress|i}} on a remote control, or Press {{keypress|i}} on a keyboard<br />
*Using the '''''[[Basic_controls#Context_Menu|Context Menu]]''''', select '''Information'''<br />
<br />
<br />
Available option buttons (not all are displayed in the image)<br />
;Actors image<br />
:Clicking on the image of an actor will bring up a listing of other titles, in your library, the actor appears in<br />
:Installing the '''''[[Add-on:ExtendedInfo_Script|ExtendedInfo add-on]]''''' will provide extended actor information from online sources<br />
;Play<br />
:Commence playback of the title<br />
;Your Rating<br />
:Use this option to apply your personal rating to your media. The display of the User Rating depends upon the library view in use. It is displayed at the top of the Poster as a blue star containing the rating in Poster View. Each type of view displays it differently.<br />
;Trailer<br />
:Commence playback of the '''''[[Trailers|Trailer]]'''''. If no trailer is available, either the button will not be displayed or you will be offered to install the YouTube add-on to view online trailers.<br />
;Show Fanart<br />
:Full screen display of the fanart attached to the title<br />
;Same director<br />
:Displays a listing of other titles in the library from the same director <br />
;Movie Set<br />
:Open the '''''[[Movie_sets|Movie Set]]''''' that the current movie belongs to. Only visible when the movie is part of a set.<br />
;Choose art <br />
:Settings page that allows the manual selection of '''''[[Artwork]]'''''<br />
;Refresh<br />
:Allows you to rescan or rescrape the title. Useful if you have modified information in the NFO File, or you would like to re-scrape updated information from the site of the Information provider. '''''See: [[Updating_or_removing_videos|Update Video Library]]'''''<br />
:Highlighting this button will also display the path to the playable file that {{kodi}} has recorded in the library database. Useful to track down duplicate entries.<br />
<br />
<br />
<br />
= Now Playing Controls =<br />
The Now Playing Controls are covered in more detail in the following two sections...<br />
<br />
;Music Player Controls<br />
:'''''See: [[Music_navigation|Music Navigation & Playback]]'''''<br />
<br />
;Video Player Controls<br />
:'''''See: [[Video_playback|Video Playback]]'''''<br />
<br />
<br />
<br />
= On Screen Keyboard =<br />
[[File:OnScreenKeyboard.jpg|right|500px]]<br />
When required, Kodi will display an on-screen keyboard to facilitate data entry. No special selection is required by the user as the keyboard will appear where required.<br />
<br />
The on-screen keyboard can be used in the following ways:<br />
*Remote control<br />
*Mouse presses<br />
*Using a physical keyboard.<br />
{{-}}<br />
<br />
<br />
<br />
= Remote Controls =<br />
Kodi is best used with a Remote Control. Many types of Remote Controls can be used as listed on the following page.<br />
{{see|Remote_controls}}<br />
<br />
<br />
<br />
= Keyboard Controls =<br />
If you are using a physical keyboard, the following page lists available keystrokes to control Kodi.<br />
{{see|Keyboard_controls}}<br />
<br />
<br />
<br />
= See also = <br />
=== Favourites ===<br />
{{main|Favourites}}<br />
{{#lst:Favourites|intro}}<br />
<br />
<br />
<br />
=== File Manager ===<br />
{{main|File manager}}<br />
{{#lst:File manager|intro}}<br />
<br />
<br />
<br />
=== Profiles ===<br />
{{main|Profiles}}<br />
{{#lst:Profiles|intro}}<br />
<br />
<br />
<br />
{{top}}<br />
<br />
<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">{{next|[[Video_library|Video Library Main Menu]]}} </div><br />
<br /><br />
<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Music_library|Music Library Main Menu]]}} </div><br />
<br />
<br />
{{updated|18}}<br />
[[Category:FAQ]]<br />
[[Category:Index]]<br />
[[Category:Guides]]<br />
[[Category:Manual]]<br />
[[Category:Karellen]]<br />
[[Category:Video library]]<br />
[[Category:Music library]]<br />
[[Category:First time user]]<br />
[[Category:Quick Start Guide]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official_talk:Forum_rules&diff=184621Official talk:Forum rules2019-10-15T14:19:35Z<p>Jjd-uk: </p>
<hr />
<div><big>'''PROPOSED CHANGE'''</big><br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. <br />
<br />
===Unacceptable usernames===<br />
# We aim to make the the forum a welcoming place for people of all ages and backgrounds. Thus any user account registered using a name that is deemed inappropriate for a public forum or liable to offend, for example: sexual or racial references, could result in that account receiving an immediate permanent ban. <br />
# The username you want to register '''shall not''' contain "XBMC" / "Kodi" <br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).<br />
<br />
''Note - If a username is deemed unacceptable then the decision of the forum moderators is final. However if your account has been banned due to your choice of username this does not mean you are not welcome, so you are free to try registration again using a more appropriate username, just be sure you are more careful in your username selection.''</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official_talk:Forum_rules&diff=184620Official talk:Forum rules2019-10-15T14:18:53Z<p>Jjd-uk: </p>
<hr />
<div><big>'''PROPOSED CHANGE'''</big><br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. <br />
<br />
===Unacceptable usernames===<br />
# We aim to make the the forum a welcoming place for people of all ages and backgrounds. Thus any user account registered using a name that is deemed inappropriate for a public forum or liable to offend, for example: sexual or racial references, could result in that account receiving an immediate permanent ban. <br />
# The username you want to register '''shall not''' contain "XBMC" / "Kodi" <br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).<br />
<br />
''Note - If a username is deemed unacceptable then the decision of the forum moderators is final. However if your account has been banned due to your choice of user name this does not mean you are not welcome, so you are free to try registration again using a more appropriate username, just be sure you are more careful in your username selection.''</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official_talk:Forum_rules&diff=184619Official talk:Forum rules2019-10-15T14:13:34Z<p>Jjd-uk: </p>
<hr />
<div><big>'''PROPOSED CHANGE'''</big><br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. <br />
<br />
===Unacceptable usernames===<br />
# We aim to make the the forum a welcoming place for people of all ages and backgrounds. Thus any user account registered using a name that is deemed inappropriate for a public forum or liable to offend, for example: sexual or racial references, could result in that account receiving an immediate permanent ban. <br />
# The username you want to register '''shall not''' contain "XBMC" / "Kodi" <br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).<br />
<br />
''Note - If a user name is deemed unacceptable then the decision of the forum moderators is final. However if your account has been banned due to your choice of user name this does not mean you are not welcome, so you are free to try registration again using a more appropriate username, just be sure you are more careful in your username selection.''</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official:Forum_rules&diff=184618Official:Forum rules2019-10-15T13:59:32Z<p>Jjd-uk: </p>
<hr />
<div>Kodi.tv provides http://forum.kodi.tv (the forums) for development, support, and discussion relating to Kodi Media Center.<br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. The username you want to register '''shall not''' contain "XBMC" / "Kodi" or any other trademarked, product or company names, unless you represent a non-profit organization or are an official Kodi sponsor. In these cases you must still add your own name to these trademarked, product or company names to differentiate yourself as individual representative.<br />
<br />
== General forum rules ==<br />
Violation of any of the following General Forum rules will result in a preliminary warning. If violations continue, the forum user will be banned for one week with a note explaining the reason for the ban. If violations continue, the user will suffer a permanent ban. Additionally, if necessary, a Forum Moderator or Administrator may delete or edit posts or signatures at will and without warning. These enforcement policies are slightly different than the Piracy rules, so you are encouraged to read both policies thoroughly before posting.<br />
<br />
<br />
''Forums are not static entities. As need arises, these rules may be altered or added to. Exemptions to any of these rules may be granted by forum moderators.''<br />
<br />
<br />
{{note|While called the "forum rules", they also applies to other official Kodi websites such as the Kodi wiki.}}<br />
=== General conduct ===<br />
# Be civil.<br />
# Polite language is required.<br />
# Respect the coding efforts of Kodi devs and other coders. Calling a program or add-on “worthless” will be automatically deemed as disrespect.<br />
# Respect the efforts of the forum moderators and those answering questions or writing guides. They are working for free in a fairly thankless job.<br />
# Make an effort to read any sticky threads in the forum you're posting in, along with FAQs and Online Manuals.<br />
# Be patient. Kodi's user base is global and there are many more forum users asking questions than writing answers. Please wait at least 24 hours before bumping your own post unless you have new information to add.<br />
<br />
=== No selling or promoting of services for money ===<br />
# Do not try to sell services or hardware to individuals on our forums. <br />Exception: If you own a company and want to run a special discount or promotion for Kodi forum members in your shop, contact a member of Team Kodi for permission first.<br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).<br />
# Do not post donation links directly to Paypal or any other donation collections website. <br /> Exception: If you are the author of an original work relating to Kodi, you may include one (1) direct donation link in your forum post concerning this work. The link must be written with this exact wording: "Donations for this [addon/skin/guide/etc] gratefully accepted." <br />You are allowed to post links to other websites, even if those websites have links to donation sites. For example; Wikipedia requests donations regularly, but you are still welcome to post links to Wikipedia. If you’ve written a guide or created an Kodi addon on your site that’s applicable to a discussion, and your site includes a donation option, you are still welcome to post a link to your website.<br />
<br />
=== Posting ===<br />
# One topic per thread for ease of management.<br />
# All posts should be written in English to ensure uniformity and to make the post accessible to the maximum number of people.<br />
# Choose a descriptive thread title. Descriptive thread titles are not only far more likely to be read, but will rank higher in searches and be more helpful to others with the same problem in the future. Use some of the terms you used in your search queries as a base for the thread title.<br />
# Be as descriptive and detailed as possible. Assume nothing, there are no mind readers on the Kodi Community Forum.<br />
# Post all the the information requested in forum stickies, everything you've tried so far, any suspicions you have. Show that you've made an effort on your own. And remember “the latest release” can mean many different things, so be descriptive in what version of Kodi you are using.<br />
# When posting a problem you are encouraged to post a [[debug log]] from when the problem occurred. When posting a log or other lengthy code in the forum, please use a paste site, as described in the '''[[debug log]]''' wiki page. Do not post log snippets on the forum, if you want to point out a specific part refer to the line number.<br />
# No cross-posting. Do not cross-post or double-post.<br />
# Don't misrepresent the work of others as your own.<br />
<br />
=== Signatures ===<br />
# Don’t try to draw excessive attention to your signature through use of large characters, unusual fonts, or colors.<br />
# Signatures are to be limited to 4 lines of text plus 1 image with a max-height of 40px.<br />
# Images and links advertising addons that violate Kodi's piracy policy will be removed.<br />
# Links in signatures are to be limited to XBMC.org / Kodi.tv domains and sites related to Kodi (For example, a site dedicated to a dev’s Kodi addon).<br />
# Forum moderators may, at any time, delete or alter your signature to be less distracting and spammy without warning.<br />
<br />
=== Piracy Policy ===<br />
;[[forum:119117|{{kodi}}'s Official Piracy Policy]]<br />
<section begin="piracy policy" /><br />
# All discussions dealing directly with or linking to add-ons, websites, or services that violate US copyright laws ("pirated content") will be closed when a forum moderator has been made aware of them. The original poster or add-on creator may provide a link to a website not hosted by {{kodi}} for further discussion and inquiries.<br />
# Discussions for add-ons that link directly to pirated content and enables the user to access that content through the add-on will be shut down.<br />
# All links to pirated content will be removed. Requests on where to obtain pirated content will also removed.<br />
# "Pirated content" add-ons, websites, and services typically do not include the following (to be determined on a case-by-case basis if necessary):<br />
#: '''A.''' The add-on does not actually perform the act of accessing pirated content ("mistaken identity") [For example, Sickbeard, which performs no actual downloading or streaming.]<br />
#: '''B.''' The add-on has the potential to access pirated content, but is potentially useful for downloading legal content as well. [For example, an add-on that downloads torrents is not, itself, a problem, since a torrent can cover a wide variety content, including legally distributed videos.]<br />
#: '''C.''' The add-on links/accesses content in a similar way to a normal web browser. This is done under the assumption that if the content owner did not want the content streamed, the owner should have not made the content available to be streamed in their site. [For example, the Bluecop Repository.]<br />
#: '''D.''' The add-on accesses content with permission of the content owner, the content is "[[w:copyleft|copyleft]]", or the add-on accesses content without the clear disapproval of the content owner. {{kodi}} will do its best to comply with DMCA-related takedown requests.<br />
#: ''Thread originators or add-on developers may petition Forum Moderators to re-open a thread that was closed if he or she believes one of the above exceptions applies.''<br />
# [[w:Fair use|Fair use]] exceptions apply for issues such as small video samples for testing and debugging, fanart and related artwork, video and audio summaries, subtitles, etc.<br />
# These rules apply only to the XBMC.org/Kodi.tv websites. At no point will any user be prevented from using {{kodi}} as they so choose, nor will they be prevented from adding additional add-ons from any source they choose to use.<br />
<section end="piracy policy" /><br />
<br />
{{bigger|''Examples include those seen on this list: '''[[Official:Forum rules/Banned add-ons|banned add-ons]]'''.''}}<br />
<br />
=== VPN Policy ===<br />
;[[Official:VPN_policy|VPN Policy]]<br />
{{#lst:Official:VPN_policy|VPN_policy}}<br />
<br />
== ADVICE: How do I ask a question in a smart way? ==<br />
{{#lst:Troubleshooting|how to ask a question}}<br />
<br />
== Disclaimer ==<br />
<br />
Please remember that we are not responsible for any messages posted. We do not vouch for or warrant the accuracy, completeness or usefulness of any message, and are not responsible for the contents of any message. The messages express the views of the author of the message, not necessarily the views of this bulletin-board. Any user who feels that a posted message is objectionable is encouraged to contact us immediately by email. We have the ability to remove objectionable messages and we will make every effort to do so, within a reasonable time frame, if we determine that removal is necessary.<br />
<br />
You agree, through your use of this service, that you will not use this forum to post any material which is knowingly false and/or defamatory, inaccurate, abusive, vulgar, hateful, harassing, obscene, profane, sexually oriented, threatening, invasive of a person's privacy, or otherwise violate any law. You agree not to post any copyrighted material unless the copyright is owned by you or by this forum or is being used in a fair-use context for development.<br />
<br />
== See also ==<br />
* [[Members|Members+]]<br />
* [[FAQs]]<br />
* [[HOW-TO:Submit a proper bug report]]<br />
* [[Troubleshooting]]<br />
* [[Debug log]]<br />
* https://docs.mybb.com/1.6/MyCode/<br />
<br />
[[Category:Forum]]<br />
[[Category:Team Kodi specific notes]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official:Forum_rules&diff=184617Official:Forum rules2019-10-15T13:59:21Z<p>Jjd-uk: </p>
<hr />
<div>Kodi.tv provides http://forum.kodi.tv (the forums) for development, support, and discussion relating to Kodi Media Center..<br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. The username you want to register '''shall not''' contain "XBMC" / "Kodi" or any other trademarked, product or company names, unless you represent a non-profit organization or are an official Kodi sponsor. In these cases you must still add your own name to these trademarked, product or company names to differentiate yourself as individual representative.<br />
<br />
== General forum rules ==<br />
Violation of any of the following General Forum rules will result in a preliminary warning. If violations continue, the forum user will be banned for one week with a note explaining the reason for the ban. If violations continue, the user will suffer a permanent ban. Additionally, if necessary, a Forum Moderator or Administrator may delete or edit posts or signatures at will and without warning. These enforcement policies are slightly different than the Piracy rules, so you are encouraged to read both policies thoroughly before posting.<br />
<br />
<br />
''Forums are not static entities. As need arises, these rules may be altered or added to. Exemptions to any of these rules may be granted by forum moderators.''<br />
<br />
<br />
{{note|While called the "forum rules", they also applies to other official Kodi websites such as the Kodi wiki.}}<br />
=== General conduct ===<br />
# Be civil.<br />
# Polite language is required.<br />
# Respect the coding efforts of Kodi devs and other coders. Calling a program or add-on “worthless” will be automatically deemed as disrespect.<br />
# Respect the efforts of the forum moderators and those answering questions or writing guides. They are working for free in a fairly thankless job.<br />
# Make an effort to read any sticky threads in the forum you're posting in, along with FAQs and Online Manuals.<br />
# Be patient. Kodi's user base is global and there are many more forum users asking questions than writing answers. Please wait at least 24 hours before bumping your own post unless you have new information to add.<br />
<br />
=== No selling or promoting of services for money ===<br />
# Do not try to sell services or hardware to individuals on our forums. <br />Exception: If you own a company and want to run a special discount or promotion for Kodi forum members in your shop, contact a member of Team Kodi for permission first.<br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).<br />
# Do not post donation links directly to Paypal or any other donation collections website. <br /> Exception: If you are the author of an original work relating to Kodi, you may include one (1) direct donation link in your forum post concerning this work. The link must be written with this exact wording: "Donations for this [addon/skin/guide/etc] gratefully accepted." <br />You are allowed to post links to other websites, even if those websites have links to donation sites. For example; Wikipedia requests donations regularly, but you are still welcome to post links to Wikipedia. If you’ve written a guide or created an Kodi addon on your site that’s applicable to a discussion, and your site includes a donation option, you are still welcome to post a link to your website.<br />
<br />
=== Posting ===<br />
# One topic per thread for ease of management.<br />
# All posts should be written in English to ensure uniformity and to make the post accessible to the maximum number of people.<br />
# Choose a descriptive thread title. Descriptive thread titles are not only far more likely to be read, but will rank higher in searches and be more helpful to others with the same problem in the future. Use some of the terms you used in your search queries as a base for the thread title.<br />
# Be as descriptive and detailed as possible. Assume nothing, there are no mind readers on the Kodi Community Forum.<br />
# Post all the the information requested in forum stickies, everything you've tried so far, any suspicions you have. Show that you've made an effort on your own. And remember “the latest release” can mean many different things, so be descriptive in what version of Kodi you are using.<br />
# When posting a problem you are encouraged to post a [[debug log]] from when the problem occurred. When posting a log or other lengthy code in the forum, please use a paste site, as described in the '''[[debug log]]''' wiki page. Do not post log snippets on the forum, if you want to point out a specific part refer to the line number.<br />
# No cross-posting. Do not cross-post or double-post.<br />
# Don't misrepresent the work of others as your own.<br />
<br />
=== Signatures ===<br />
# Don’t try to draw excessive attention to your signature through use of large characters, unusual fonts, or colors.<br />
# Signatures are to be limited to 4 lines of text plus 1 image with a max-height of 40px.<br />
# Images and links advertising addons that violate Kodi's piracy policy will be removed.<br />
# Links in signatures are to be limited to XBMC.org / Kodi.tv domains and sites related to Kodi (For example, a site dedicated to a dev’s Kodi addon).<br />
# Forum moderators may, at any time, delete or alter your signature to be less distracting and spammy without warning.<br />
<br />
=== Piracy Policy ===<br />
;[[forum:119117|{{kodi}}'s Official Piracy Policy]]<br />
<section begin="piracy policy" /><br />
# All discussions dealing directly with or linking to add-ons, websites, or services that violate US copyright laws ("pirated content") will be closed when a forum moderator has been made aware of them. The original poster or add-on creator may provide a link to a website not hosted by {{kodi}} for further discussion and inquiries.<br />
# Discussions for add-ons that link directly to pirated content and enables the user to access that content through the add-on will be shut down.<br />
# All links to pirated content will be removed. Requests on where to obtain pirated content will also removed.<br />
# "Pirated content" add-ons, websites, and services typically do not include the following (to be determined on a case-by-case basis if necessary):<br />
#: '''A.''' The add-on does not actually perform the act of accessing pirated content ("mistaken identity") [For example, Sickbeard, which performs no actual downloading or streaming.]<br />
#: '''B.''' The add-on has the potential to access pirated content, but is potentially useful for downloading legal content as well. [For example, an add-on that downloads torrents is not, itself, a problem, since a torrent can cover a wide variety content, including legally distributed videos.]<br />
#: '''C.''' The add-on links/accesses content in a similar way to a normal web browser. This is done under the assumption that if the content owner did not want the content streamed, the owner should have not made the content available to be streamed in their site. [For example, the Bluecop Repository.]<br />
#: '''D.''' The add-on accesses content with permission of the content owner, the content is "[[w:copyleft|copyleft]]", or the add-on accesses content without the clear disapproval of the content owner. {{kodi}} will do its best to comply with DMCA-related takedown requests.<br />
#: ''Thread originators or add-on developers may petition Forum Moderators to re-open a thread that was closed if he or she believes one of the above exceptions applies.''<br />
# [[w:Fair use|Fair use]] exceptions apply for issues such as small video samples for testing and debugging, fanart and related artwork, video and audio summaries, subtitles, etc.<br />
# These rules apply only to the XBMC.org/Kodi.tv websites. At no point will any user be prevented from using {{kodi}} as they so choose, nor will they be prevented from adding additional add-ons from any source they choose to use.<br />
<section end="piracy policy" /><br />
<br />
{{bigger|''Examples include those seen on this list: '''[[Official:Forum rules/Banned add-ons|banned add-ons]]'''.''}}<br />
<br />
=== VPN Policy ===<br />
;[[Official:VPN_policy|VPN Policy]]<br />
{{#lst:Official:VPN_policy|VPN_policy}}<br />
<br />
== ADVICE: How do I ask a question in a smart way? ==<br />
{{#lst:Troubleshooting|how to ask a question}}<br />
<br />
== Disclaimer ==<br />
<br />
Please remember that we are not responsible for any messages posted. We do not vouch for or warrant the accuracy, completeness or usefulness of any message, and are not responsible for the contents of any message. The messages express the views of the author of the message, not necessarily the views of this bulletin-board. Any user who feels that a posted message is objectionable is encouraged to contact us immediately by email. We have the ability to remove objectionable messages and we will make every effort to do so, within a reasonable time frame, if we determine that removal is necessary.<br />
<br />
You agree, through your use of this service, that you will not use this forum to post any material which is knowingly false and/or defamatory, inaccurate, abusive, vulgar, hateful, harassing, obscene, profane, sexually oriented, threatening, invasive of a person's privacy, or otherwise violate any law. You agree not to post any copyrighted material unless the copyright is owned by you or by this forum or is being used in a fair-use context for development.<br />
<br />
== See also ==<br />
* [[Members|Members+]]<br />
* [[FAQs]]<br />
* [[HOW-TO:Submit a proper bug report]]<br />
* [[Troubleshooting]]<br />
* [[Debug log]]<br />
* https://docs.mybb.com/1.6/MyCode/<br />
<br />
[[Category:Forum]]<br />
[[Category:Team Kodi specific notes]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official_talk:Forum_rules&diff=184616Official talk:Forum rules2019-10-15T12:31:04Z<p>Jjd-uk: </p>
<hr />
<div><big>'''PROPOSED CHANGE'''</big><br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. <br />
<br />
===Unacceptable usernames===<br />
# We aim to make the the forum a welcoming place for people of all ages and backgrounds. Thus any user account registered using a name that is deemed inappropriate for a public forum or liable to offend, for example: sexual or racial references, could result in that account receiving an immediate permanent ban. <br />
# The username you want to register '''shall not''' contain "XBMC" / "Kodi" <br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official_talk:Forum_rules&diff=184615Official talk:Forum rules2019-10-15T12:30:41Z<p>Jjd-uk: </p>
<hr />
<div>'''PROPOSED CHANGE'''<br />
<br />
== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. <br />
<br />
===Unacceptable usernames===<br />
# We aim to make the the forum a welcoming place for people of all ages and backgrounds. Thus any user account registered using a name that is deemed inappropriate for a public forum or liable to offend, for example: sexual or racial references, could result in that account receiving an immediate permanent ban. <br />
# The username you want to register '''shall not''' contain "XBMC" / "Kodi" <br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).</div>Jjd-ukhttps://kodi.wiki/index.php?title=Official_talk:Forum_rules&diff=184614Official talk:Forum rules2019-10-15T12:18:37Z<p>Jjd-uk: </p>
<hr />
<div>== Registration ==<br />
<br />
By following the link to the forum, you will be able to create a new username. After registration you will receive a confirmation e-mail, which you must accept before being able to post on our forum. <br />
<br />
===Unacceptable usernames===<br />
# We aim to make the the forum a welcoming place for people of all ages and backgrounds. Thus any user account registered using a name that is deemed inappropriate for a public forum or liable to offend, for example: sexual or racial references, could result in that account receiving an immediate permanent ban. <br />
# The username you want to register '''shall not''' contain "XBMC" / "Kodi" <br />
# Do not use usernames to promote your business, product, or website.<br /> Exception: We make an exception when the username is in relation to a legal non-profit or the company you represent is an official XBMC Foundation sponsor. Allowed group names must include a personal identifier (e.g. KodiSponsor-Nate or Nonprofit-Nate).</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:TV-Show_artwork&diff=139860Talk:TV-Show artwork2018-08-14T11:17:44Z<p>Jjd-uk: </p>
<hr />
<div>{{Artwork_Contents}}<br />
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}<br />
<br />
<br />
<section begin="intro" />TV Show artwork are images directly related to a TV Show, preferably of high quality, that are displayed when viewing the entry in the library. The TV Show section in Kodi has the impressive ability to display up to 13 types of artwork. This page will describe the different types of artwork available in the TV Show category of Kodi.<section end="intro" /><br />
<br />
{{red|'''It is important to note the following:'''}}<br />
*Artwork is totally skin dependent. This means that some skins display a small number of artwork types, while other skins will display most or all of the available artwork types.<br />
*In previous versions of Kodi and in older wiki pages, the term Thumbnails was used to describe Artwork. Kodi has now moved away from referring to thumbnails due to the amount of confusion and concern it caused users.<br />
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork.<br />
*While high resolution do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware<br />
<br />
<br />
= Basic TV Show Artwork =<br />
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
<br />
<br />
== Banner ==<br />
[[File:Artwork-Banner01.jpg|400px|right]]<br />
Also known as Wide Banner Icons. The image to the right shows the Banner view. They are images that normally contain recognisable characters or moments in the show. The banner image normally displays the movie logo which is of a size that is clearly legible. There should be no written advertising of Actors, Studios etc.<br />
<br />
'''EXPERIMENT WITH ESTUARY BACKGROUND COLOURS'''<br />
<br />
<div style="color:#F0F0F0; {{linear-gradient|top|#0E597E, #0BAA8E}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:0.185}}<br />
| width=200px | {{nowrap|1000x185}}<br />
|}<br />
</div><br /><br />
<br />
<div style="color:#F0F0F0; {{linear-gradient|top|#0E597E, #0BAA8E}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season banner is '''''season01-banner.jpg''''' where 01 is the season number and '''''season-all-banner.jpg''''' for the All season poster and '''''season-specials-banner.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved TV Show Episodes as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |banner.jpg/png<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Main ==<br />
[[File:Artwork-PosterView02.jpg|400px|right]]<br />
<br />
Also known as ''Cover Art'' and ''Folder Image''. It normally includes the name of the TV Show, along with images of the main character or recognisable scenes from the show.<br />
;{{see also|wikipedia:Poster|l1=Poster on Wikipedia}}<br />
<br />
The image to the right is displaying Poster View of the shows in the Kodi library. They are portrait, high quality images which use a small portion of the screen allowing movie information or other items to be displayed alongside.<br />
<br />
'''EXPERIMENT WITH ESTUARY BLUE'''<br />
<div style="background:#7ACAFE "><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="background:#7ACAFE "><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
<big><div style="color:white; background:#008080">1.3 Poster- Season</div></big><br />
----<br />
[[File:Artwork-SeasonPoster01.jpg|400px|right]]<br />
;{{See also|Season rename}}<br />
<br />
<br />
The Season Poster has the same properties as the TV Show Poster. The season poster is used to display each season in the TV Show. The image to the right shows the Shift view in Estuary which displays the available seasons for the selected TV Show.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained<br /></small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="color:white; "{{linear-gradient|top|#f5f5a1, #a1f5e4}}""><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season posters is '''''season01-poster.jpg''''' where 01 is the season number and '''''season-all-poster.jpg''''' for the All season poster and '''''season-specials-poster.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |season01-poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Fanart ==<br />
[[File:Artwork-FanartView03.jpg|400px|right]]<br />
Fanart can be defined as images, depicting iconic scenes in a tv show, that have been created by fans. They are also known as Wallpapers or Backdrops.<br />
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}<br />
<br />
For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. <br />
<br />
<br />
The image to the right is a typical example of a TV Show fanart. It is specifically designed to match the 16:9 ratio of current generation televisions and monitors. This allows the screen to be completely filled by the image. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season fanart is '''''season01-fanart.jpg''''' where 01 is the season number and '''''season-all-fanart.jpg''''' for the All season fanart and '''''season-specials-fanart jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart.jpg/png<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Animated Artwork ==<br />
[[File:Artwork-Animated01.gif|right]]<br />
Animated Artwork are image files that contain movement. A creator starts with a static image and adds additional frames (images) to the file, each one slightly different to the previous and next image. The images are saved as a gif file, which is recognised as an animated file.<br />
<br />
Kodi has the ability to display animated Fanart and animated Posters. If you have located an animated fanart or poster that you would like to display, simply replace the existing Fanart or Poster artwork using the [[Artwork#Importing.2FScraping_Artwork|Kodi- Choose Art]] procedure.<br />
<br />
To the right is an example of Animated Fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080 --''' for Fanart'''}}<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500 --''' for Poster'''}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=200px |See above<br />
| width=250px |See above<br />
| width=600px |Use Naming and Saving conventions as described in Poster and Fanart above:<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Episode Thumbnail ==<br />
[[File:Artwork-EpisodeThumb01.jpg|400px|right]]<br />
The Episode Thumbnail is an individual and specific image to a particular episode. It usually is a snapshot of a memorable scene in that particular episode.<br />
<br />
These images are often shown in a small box with several on screen at once, so for HD episodes using a resolution smaller than the video file they were captured from can be a good idea.<br />
<br />
The image to the right shows the episode listing using the Episode Thumb view.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1280x720}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
|- valign="top"<br />
| width=300px |''also'':<br />
----<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\Dominion S01E01-thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01-thumb.jpg<br />
|}<br />
</div><br />
<br />
== Actor Image ==<br />
[[File:Artwork-Actors01.jpg|400px|right]]<br />
<br />
The Actor artwork is a portrait of an actor for easy identification.<br />
<br />
The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.<br />
<br />
{{Red|It is important to note the following limitation with actor artwork. Kodi cannot download actor images for every listed actor in the show. This is due to a limitation with the TMDB and TVDB scraper sites. Those sites list only biographical data and images for the '''main cast actors''' only. Episode actors (those actors that appear in only one or two episodes) are line entries at the scraper sites, which means that the actor has no profile page or image attached to them.}}<br />
<br />
{{red|If that episode actor is a main cast actor in another tv show or movie listed within your Kodi library, then an Actor Image and biographical data will be available for display. When viewing the actors for a tv show in Kodi, it is normal to see missing actor artwork. These limitations are being worked on and should become available when the relevant sites update their API's. For TVDB this should become available when they finalise their v2 API. It will then be possible to link episode actors to their profile pages on IMDB. This is beyond the control of Kodi.}}<br />
<!--https://forums.thetvdb.com/viewtopic.php?f=86&t=38214&p=116408#p116380 --><br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Source Folder Artwork ==<br />
[[File:Artwork-VideoFolder01.jpg|400px|right]]<br />
<br />
The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your tv show sources in the Video menu. You will not see this artwork in the TV Show menu. This image file is saved directly within the Source directory.<br />
<br />
To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved the image in the correct location, it will be available to select immediately. If not, you will need to navigate to locate and select it. The image must remain in its original location once selected as it will not be cached. Deleting the image will remove it from view in the folder icon.<br />
<br />
You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows<br />
<br />
<pre><nowiki><br />
<source><br />
<name>tv show</name><br />
<path>xbms://192.168.1.100:1400/tv show/</path><br />
<thumbnail>F:\My TV Shows\folder.jpg</thumbnail><br />
</source><br />
</nowiki></pre><br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|640x360}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=200px |Folder Artwork:<br />
| width=250px |folder.jpg<br />
| width=600px |f:\TVShows\folder.jpg<br />
|- valign="top"<br />
| width=200px |Alternative name:<br />
| width=250px |<foldername>.jpg<br />
| width=600px |f:\TVShows\MyMovies.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
= Extended TV Show Artwork =<br />
To display the Extended artwork, you will need to change to a skin that supports the additional types of artwork. Add-ons are available to automate the download and caching of the extended artwork listed below. This is usually downloaded and installed with the skin. If not, you can manually download and install the add-on separately. The downloader can then be used to automatically scrape the extended artwork from either online or local sources. If you do not want to automate the process, it is possible to perform this procedure manually using the [[Artwork#Kodi-_Choose_Art|Kodi- Choose Art]] procedure detailed in the main Artwork page.<br />
<br />
Two examples are below. <br />
; {{see also|Add-on:Artwork_Downloader}}<br />
:'''''See also: [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
*If using the Artwork Downloader add-on, it is important to note the following<br />
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. This can be selected in the settings page of the add-on<br />
**If you have more than one episode in a single directory, the add-on will scrape the online and also the local artwork if correctly named and saved.<br />
**Using the Kodi scraper will not download extended artwork. The artwork downloader is required to be run after the Kodi scrape process. i.e. you are performing two scrapes.<br />
<br />
<br />
== ClearArt ==<br />
[[File:Artwork-ClearArt02.jpg|400px|right]]<br />
<br />
ClearArt are images that are saved on a transparent background. This allows the image to be overlayed on another image or playing video. The images normally include the tv show name or logo, along with an iconic prop or scene from the tv show, or an actors image.<br />
<br />
The image to the right is displaying ClearArt at the bottom right corner of the image.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.562}}<br />
| width=200px | {{nowrap|500*281}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearart.png<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Clearlogo ==<br />
[[File:Artwork-ClearLogo02.jpg|400px|right]]<br />
<br />
This is the basic tv show logo or name on a transparent background. The logo uses the distinctive font of the tv show and is uncluttered by images from the show or actors. The transparent background allows it to be overlayed on other images or video with minimal impact. This image is sometimes saved as "logo.png", but "clearlogo.png" is preferred to match the library naming convention.<br />
<br />
The image on the right is displaying the tv show listing using the Logo view in the Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.388}}<br />
| width=200px | {{nowrap|400x155}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearlogo.png<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Character Art ==<br />
[[File:Artwork-CharacterArt01.jpg|400px|right]]<br />
Character Art, also known simply as Character, is an image of the main or prominent character in a tv show. It uses a transparent background in a similar fashion to Clear Logo and Clear Art. There are very few skins that display this artwork.<br />
<br />
The image to the right displays the Clear Logo and Character Art in the top right corner.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|800x310}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |characterart.png<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Landscape ==<br />
[[File:Artwork-Landscape01.jpg|400px|right]]<br />
Landscape, also known as TV Show Thumbs (as distinct from Episode Thumbs), are specially made small fanart images. The main differences between Landscape and Fanart images is that Landscape image contains the tv show logo. They are used in certain page layouts for movie browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.<br />
<br />
The image to the right displays the Landscape view in Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1000x562}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |landscape.jpg<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
|}<br />
</div><br />
<br />
= Skin Dependent & Other Artwork =<br />
The following artwork requires a skin that supports that type of artwork.<br />
;{{see also|skin}}<br />
:'''''See also: [https://kodi.tv/addons/browse?keyword=&category=1192&author=&sort=title+ASC<nowiki>Add-on Search</nowiki>]'''''<br />
<br />
<br />
== DiscArt ==<br />
[[File:Artwork-DiscArt01.jpg|400px|right]]<br />
<br />
DiscArt requires the use of a supporting skin. It replicates the picture on the physical DVD and Bluray disc. Although the disc artwork is round, the image itself is square and the disc image is placed on a transparent background. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1000}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |discart.png<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
|}<br />
</div><br />
<br />
== Keyart ==<br />
Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |keyart.jpg<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
|}<br />
</div><br />
<br />
== Extra fanart ==<br />
It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard Fanart described above. These images are not cached, and are directly accessed by the skin.<br />
<br />
Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the TV Show ''(eg f:\TV Shows\Californication\extrafanart)''. Each Extra Fanart must be named ''fanartX.jpg'' where ''X'' is a sequential number starting with 0 ''(fanart0.jpg, fanart1.jpg, fanart2.jpg, etc)''. There is a limit of 10 fanart images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrafanart Folder is as follows.<br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced Extra Fanart:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
<br />
{{Top}}<br />
<br />
<br />
{{updated|17}}<br />
[[Category:Guides]]<br />
[[Category:First time user]]<br />
[[Category:FAQ]]<br />
[[Category:Manual]]<br />
[[Category:Index]]<br />
[[Category:Karellen]]<br />
[[Category:Video library]]<br />
[[Category:Quick Start Guide]]<br />
[[Category:Advanced topics]]<br />
[[User:Karellen|Karellen]] ([[User talk:Karellen|talk]]) 01:57, 29 June 2017 (EDT)</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:TV-Show_artwork&diff=139858Talk:TV-Show artwork2018-08-14T09:50:17Z<p>Jjd-uk: Created page with "{{Artwork_Contents}} {{mininav|Video Library Index |Artwork}} <section begin="intro" />TV Show artwork are images directly related to a TV Sh..."</p>
<hr />
<div>{{Artwork_Contents}}<br />
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}<br />
<br />
<br />
<section begin="intro" />TV Show artwork are images directly related to a TV Show, preferably of high quality, that are displayed when viewing the entry in the library. The TV Show section in Kodi has the impressive ability to display up to 13 types of artwork. This page will describe the different types of artwork available in the TV Show category of Kodi.<section end="intro" /><br />
<br />
{{red|'''It is important to note the following:'''}}<br />
*Artwork is totally skin dependent. This means that some skins display a small number of artwork types, while other skins will display most or all of the available artwork types.<br />
*In previous versions of Kodi and in older wiki pages, the term Thumbnails was used to describe Artwork. Kodi has now moved away from referring to thumbnails due to the amount of confusion and concern it caused users.<br />
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork.<br />
*While high resolution do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware<br />
<br />
<br />
= Basic TV Show Artwork =<br />
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
<br />
<br />
== Banner ==<br />
[[File:Artwork-Banner01.jpg|400px|right]]<br />
Also known as Wide Banner Icons. The image to the right shows the Banner view. They are images that normally contain recognisable characters or moments in the show. The banner image normally displays the movie logo which is of a size that is clearly legible. There should be no written advertising of Actors, Studios etc.<br />
<br />
'''EXPERIMENT WITH ESTUARY BACKGROUND COLOURS'''<br />
<br />
<div style="color:#F0F0F0; {{linear-gradient|top|#0E597E, #0BAA8E}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:0.185}}<br />
| width=200px | {{nowrap|1000x185}}<br />
|}<br />
</div><br /><br />
<br />
<div style="color:#F0F0F0; {{linear-gradient|top|#0E597E, #0BAA8E}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season banner is '''''season01-banner.jpg''''' where 01 is the season number and '''''season-all-banner.jpg''''' for the All season poster and '''''season-specials-banner.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved TV Show Episodes as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |banner.jpg/png<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Main ==<br />
[[File:Artwork-PosterView02.jpg|400px|right]]<br />
<br />
Also known as ''Cover Art'' and ''Folder Image''. It normally includes the name of the TV Show, along with images of the main character or recognisable scenes from the show.<br />
;{{see also|wikipedia:Poster|l1=Poster on Wikipedia}}<br />
<br />
The image to the right is displaying Poster View of the shows in the Kodi library. They are portrait, high quality images which use a small portion of the screen allowing movie information or other items to be displayed alongside.<br />
<br />
'''EXPERIMENT WITH ESTUARY BLUE'''<br />
<div style="background:#7ACAFE "><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="background:#7ACAFE "><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Season ==<br />
[[File:Artwork-SeasonPoster01.jpg|400px|right]]<br />
;{{See also|Season rename}}<br />
<br />
<br />
The Season Poster has the same properties as the TV Show Poster. The season poster is used to display each season in the TV Show. The image to the right shows the Shift view in Estuary which displays the available seasons for the selected TV Show.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained<br /></small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="color:white; "{{linear-gradient|top|#f5f5a1, #a1f5e4}}""><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season posters is '''''season01-poster.jpg''''' where 01 is the season number and '''''season-all-poster.jpg''''' for the All season poster and '''''season-specials-poster.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |season01-poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Fanart ==<br />
[[File:Artwork-FanartView03.jpg|400px|right]]<br />
Fanart can be defined as images, depicting iconic scenes in a tv show, that have been created by fans. They are also known as Wallpapers or Backdrops.<br />
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}<br />
<br />
For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. <br />
<br />
<br />
The image to the right is a typical example of a TV Show fanart. It is specifically designed to match the 16:9 ratio of current generation televisions and monitors. This allows the screen to be completely filled by the image. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season fanart is '''''season01-fanart.jpg''''' where 01 is the season number and '''''season-all-fanart.jpg''''' for the All season fanart and '''''season-specials-fanart jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart.jpg/png<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Animated Artwork ==<br />
[[File:Artwork-Animated01.gif|right]]<br />
Animated Artwork are image files that contain movement. A creator starts with a static image and adds additional frames (images) to the file, each one slightly different to the previous and next image. The images are saved as a gif file, which is recognised as an animated file.<br />
<br />
Kodi has the ability to display animated Fanart and animated Posters. If you have located an animated fanart or poster that you would like to display, simply replace the existing Fanart or Poster artwork using the [[Artwork#Importing.2FScraping_Artwork|Kodi- Choose Art]] procedure.<br />
<br />
To the right is an example of Animated Fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080 --''' for Fanart'''}}<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500 --''' for Poster'''}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=200px |See above<br />
| width=250px |See above<br />
| width=600px |Use Naming and Saving conventions as described in Poster and Fanart above:<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Episode Thumbnail ==<br />
[[File:Artwork-EpisodeThumb01.jpg|400px|right]]<br />
The Episode Thumbnail is an individual and specific image to a particular episode. It usually is a snapshot of a memorable scene in that particular episode.<br />
<br />
These images are often shown in a small box with several on screen at once, so for HD episodes using a resolution smaller than the video file they were captured from can be a good idea.<br />
<br />
The image to the right shows the episode listing using the Episode Thumb view.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1280x720}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
|- valign="top"<br />
| width=300px |''also'':<br />
----<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\Dominion S01E01-thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01-thumb.jpg<br />
|}<br />
</div><br />
<br />
== Actor Image ==<br />
[[File:Artwork-Actors01.jpg|400px|right]]<br />
<br />
The Actor artwork is a portrait of an actor for easy identification.<br />
<br />
The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.<br />
<br />
{{Red|It is important to note the following limitation with actor artwork. Kodi cannot download actor images for every listed actor in the show. This is due to a limitation with the TMDB and TVDB scraper sites. Those sites list only biographical data and images for the '''main cast actors''' only. Episode actors (those actors that appear in only one or two episodes) are line entries at the scraper sites, which means that the actor has no profile page or image attached to them.}}<br />
<br />
{{red|If that episode actor is a main cast actor in another tv show or movie listed within your Kodi library, then an Actor Image and biographical data will be available for display. When viewing the actors for a tv show in Kodi, it is normal to see missing actor artwork. These limitations are being worked on and should become available when the relevant sites update their API's. For TVDB this should become available when they finalise their v2 API. It will then be possible to link episode actors to their profile pages on IMDB. This is beyond the control of Kodi.}}<br />
<!--https://forums.thetvdb.com/viewtopic.php?f=86&t=38214&p=116408#p116380 --><br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Source Folder Artwork ==<br />
[[File:Artwork-VideoFolder01.jpg|400px|right]]<br />
<br />
The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your tv show sources in the Video menu. You will not see this artwork in the TV Show menu. This image file is saved directly within the Source directory.<br />
<br />
To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved the image in the correct location, it will be available to select immediately. If not, you will need to navigate to locate and select it. The image must remain in its original location once selected as it will not be cached. Deleting the image will remove it from view in the folder icon.<br />
<br />
You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows<br />
<br />
<pre><nowiki><br />
<source><br />
<name>tv show</name><br />
<path>xbms://192.168.1.100:1400/tv show/</path><br />
<thumbnail>F:\My TV Shows\folder.jpg</thumbnail><br />
</source><br />
</nowiki></pre><br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|640x360}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=200px |Folder Artwork:<br />
| width=250px |folder.jpg<br />
| width=600px |f:\TVShows\folder.jpg<br />
|- valign="top"<br />
| width=200px |Alternative name:<br />
| width=250px |<foldername>.jpg<br />
| width=600px |f:\TVShows\MyMovies.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
= Extended TV Show Artwork =<br />
To display the Extended artwork, you will need to change to a skin that supports the additional types of artwork. Add-ons are available to automate the download and caching of the extended artwork listed below. This is usually downloaded and installed with the skin. If not, you can manually download and install the add-on separately. The downloader can then be used to automatically scrape the extended artwork from either online or local sources. If you do not want to automate the process, it is possible to perform this procedure manually using the [[Artwork#Kodi-_Choose_Art|Kodi- Choose Art]] procedure detailed in the main Artwork page.<br />
<br />
Two examples are below. <br />
; {{see also|Add-on:Artwork_Downloader}}<br />
:'''''See also: [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
*If using the Artwork Downloader add-on, it is important to note the following<br />
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. This can be selected in the settings page of the add-on<br />
**If you have more than one episode in a single directory, the add-on will scrape the online and also the local artwork if correctly named and saved.<br />
**Using the Kodi scraper will not download extended artwork. The artwork downloader is required to be run after the Kodi scrape process. i.e. you are performing two scrapes.<br />
<br />
<br />
== ClearArt ==<br />
[[File:Artwork-ClearArt02.jpg|400px|right]]<br />
<br />
ClearArt are images that are saved on a transparent background. This allows the image to be overlayed on another image or playing video. The images normally include the tv show name or logo, along with an iconic prop or scene from the tv show, or an actors image.<br />
<br />
The image to the right is displaying ClearArt at the bottom right corner of the image.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.562}}<br />
| width=200px | {{nowrap|500*281}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearart.png<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Clearlogo ==<br />
[[File:Artwork-ClearLogo02.jpg|400px|right]]<br />
<br />
This is the basic tv show logo or name on a transparent background. The logo uses the distinctive font of the tv show and is uncluttered by images from the show or actors. The transparent background allows it to be overlayed on other images or video with minimal impact. This image is sometimes saved as "logo.png", but "clearlogo.png" is preferred to match the library naming convention.<br />
<br />
The image on the right is displaying the tv show listing using the Logo view in the Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.388}}<br />
| width=200px | {{nowrap|400x155}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearlogo.png<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Character Art ==<br />
[[File:Artwork-CharacterArt01.jpg|400px|right]]<br />
Character Art, also known simply as Character, is an image of the main or prominent character in a tv show. It uses a transparent background in a similar fashion to Clear Logo and Clear Art. There are very few skins that display this artwork.<br />
<br />
The image to the right displays the Clear Logo and Character Art in the top right corner.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|800x310}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |characterart.png<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Landscape ==<br />
[[File:Artwork-Landscape01.jpg|400px|right]]<br />
Landscape, also known as TV Show Thumbs (as distinct from Episode Thumbs), are specially made small fanart images. The main differences between Landscape and Fanart images is that Landscape image contains the tv show logo. They are used in certain page layouts for movie browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.<br />
<br />
The image to the right displays the Landscape view in Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1000x562}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |landscape.jpg<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
|}<br />
</div><br />
<br />
= Skin Dependent & Other Artwork =<br />
The following artwork requires a skin that supports that type of artwork.<br />
;{{see also|skin}}<br />
:'''''See also: [https://kodi.tv/addons/browse?keyword=&category=1192&author=&sort=title+ASC<nowiki>Add-on Search</nowiki>]'''''<br />
<br />
<br />
== DiscArt ==<br />
[[File:Artwork-DiscArt01.jpg|400px|right]]<br />
<br />
DiscArt requires the use of a supporting skin. It replicates the picture on the physical DVD and Bluray disc. Although the disc artwork is round, the image itself is square and the disc image is placed on a transparent background. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1000}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |discart.png<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
|}<br />
</div><br />
<br />
== Keyart ==<br />
Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |keyart.jpg<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
|}<br />
</div><br />
<br />
== Extra fanart ==<br />
It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard Fanart described above. These images are not cached, and are directly accessed by the skin.<br />
<br />
Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the TV Show ''(eg f:\TV Shows\Californication\extrafanart)''. Each Extra Fanart must be named ''fanartX.jpg'' where ''X'' is a sequential number starting with 0 ''(fanart0.jpg, fanart1.jpg, fanart2.jpg, etc)''. There is a limit of 10 fanart images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrafanart Folder is as follows.<br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced Extra Fanart:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
<br />
{{Top}}<br />
<br />
<br />
{{updated|17}}<br />
[[Category:Guides]]<br />
[[Category:First time user]]<br />
[[Category:FAQ]]<br />
[[Category:Manual]]<br />
[[Category:Index]]<br />
[[Category:Karellen]]<br />
[[Category:Video library]]<br />
[[Category:Quick Start Guide]]<br />
[[Category:Advanced topics]]<br />
[[User:Karellen|Karellen]] ([[User talk:Karellen|talk]]) 01:57, 29 June 2017 (EDT)</div>Jjd-ukhttps://kodi.wiki/index.php?title=TV-Show_artwork&diff=139847TV-Show artwork2018-08-14T08:54:39Z<p>Jjd-uk: Undo revision 139846 by Jjd-uk (talk)</p>
<hr />
<div>{{Artwork_Contents}}<br />
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}<br />
<br />
<br />
<section begin="intro" />TV Show artwork are images directly related to a TV Show, preferably of high quality, that are displayed when viewing the entry in the library. The TV Show section in Kodi has the impressive ability to display up to 13 types of artwork. This page will describe the different types of artwork available in the TV Show category of Kodi.<section end="intro" /><br />
<br />
{{red|'''It is important to note the following:'''}}<br />
*Artwork is totally skin dependent. This means that some skins display a small number of artwork types, while other skins will display most or all of the available artwork types.<br />
*In previous versions of Kodi and in older wiki pages, the term Thumbnails was used to describe Artwork. Kodi has now moved away from referring to thumbnails due to the amount of confusion and concern it caused users.<br />
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork.<br />
*While high resolution do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware<br />
<br />
<br />
= Basic TV Show Artwork =<br />
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
<br />
<br />
== Banner ==<br />
[[File:Artwork-Banner01.jpg|400px|right]]<br />
Also known as Wide Banner Icons. The image to the right shows the Banner view. They are images that normally contain recognisable characters or moments in the show. The banner image normally displays the movie logo which is of a size that is clearly legible. There should be no written advertising of Actors, Studios etc.<br />
<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:0.185}}<br />
| width=200px | {{nowrap|1000x185}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season banner is '''''season01-banner.jpg''''' where 01 is the season number and '''''season-all-banner.jpg''''' for the All season poster and '''''season-specials-banner.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved TV Show Episodes as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |banner.jpg/png<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Main ==<br />
[[File:Artwork-PosterView02.jpg|400px|right]]<br />
<br />
Also known as ''Cover Art'' and ''Folder Image''. It normally includes the name of the TV Show, along with images of the main character or recognisable scenes from the show.<br />
;{{see also|wikipedia:Poster|l1=Poster on Wikipedia}}<br />
<br />
The image to the right is displaying Poster View of the shows in the Kodi library. They are portrait, high quality images which use a small portion of the screen allowing movie information or other items to be displayed alongside.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Season ==<br />
[[File:Artwork-SeasonPoster01.jpg|400px|right]]<br />
;{{See also|Season rename}}<br />
<br />
<br />
The Season Poster has the same properties as the TV Show Poster. The season poster is used to display each season in the TV Show. The image to the right shows the Shift view in Estuary which displays the available seasons for the selected TV Show.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained<br /></small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season posters is '''''season01-poster.jpg''''' where 01 is the season number and '''''season-all-poster.jpg''''' for the All season poster and '''''season-specials-poster.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |season01-poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Fanart ==<br />
[[File:Artwork-FanartView03.jpg|400px|right]]<br />
Fanart can be defined as images, depicting iconic scenes in a tv show, that have been created by fans. They are also known as Wallpapers or Backdrops.<br />
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}<br />
<br />
For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. <br />
<br />
<br />
The image to the right is a typical example of a TV Show fanart. It is specifically designed to match the 16:9 ratio of current generation televisions and monitors. This allows the screen to be completely filled by the image. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season fanart is '''''season01-fanart.jpg''''' where 01 is the season number and '''''season-all-fanart.jpg''''' for the All season fanart and '''''season-specials-fanart jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart.jpg/png<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Animated Artwork ==<br />
[[File:Artwork-Animated01.gif|right]]<br />
Animated Artwork are image files that contain movement. A creator starts with a static image and adds additional frames (images) to the file, each one slightly different to the previous and next image. The images are saved as a gif file, which is recognised as an animated file.<br />
<br />
Kodi has the ability to display animated Fanart and animated Posters. If you have located an animated fanart or poster that you would like to display, simply replace the existing Fanart or Poster artwork using the [[Artwork#Importing.2FScraping_Artwork|Kodi- Choose Art]] procedure.<br />
<br />
To the right is an example of Animated Fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080 --''' for Fanart'''}}<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500 --''' for Poster'''}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=200px |See above<br />
| width=250px |See above<br />
| width=600px |Use Naming and Saving conventions as described in Poster and Fanart above:<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Episode Thumbnail ==<br />
[[File:Artwork-EpisodeThumb01.jpg|400px|right]]<br />
The Episode Thumbnail is an individual and specific image to a particular episode. It usually is a snapshot of a memorable scene in that particular episode.<br />
<br />
These images are often shown in a small box with several on screen at once, so for HD episodes using a resolution smaller than the video file they were captured from can be a good idea.<br />
<br />
The image to the right shows the episode listing using the Episode Thumb view.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1280x720}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
|- valign="top"<br />
| width=300px |''also'':<br />
----<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\Dominion S01E01-thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01-thumb.jpg<br />
|}<br />
</div><br />
<br />
== Actor Image ==<br />
[[File:Artwork-Actors01.jpg|400px|right]]<br />
<br />
The Actor artwork is a portrait of an actor for easy identification.<br />
<br />
The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.<br />
<br />
{{Red|It is important to note the following limitation with actor artwork. Kodi cannot download actor images for every listed actor in the show. This is due to a limitation with the TMDB and TVDB scraper sites. Those sites list only biographical data and images for the '''main cast actors''' only. Episode actors (those actors that appear in only one or two episodes) are line entries at the scraper sites, which means that the actor has no profile page or image attached to them.}}<br />
<br />
{{red|If that episode actor is a main cast actor in another tv show or movie listed within your Kodi library, then an Actor Image and biographical data will be available for display. When viewing the actors for a tv show in Kodi, it is normal to see missing actor artwork. These limitations are being worked on and should become available when the relevant sites update their API's. For TVDB this should become available when they finalise their v2 API. It will then be possible to link episode actors to their profile pages on IMDB. This is beyond the control of Kodi.}}<br />
<!--https://forums.thetvdb.com/viewtopic.php?f=86&t=38214&p=116408#p116380 --><br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Source Folder Artwork ==<br />
[[File:Artwork-VideoFolder01.jpg|400px|right]]<br />
<br />
The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your tv show sources in the Video menu. You will not see this artwork in the TV Show menu. This image file is saved directly within the Source directory.<br />
<br />
To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved the image in the correct location, it will be available to select immediately. If not, you will need to navigate to locate and select it. The image must remain in its original location once selected as it will not be cached. Deleting the image will remove it from view in the folder icon.<br />
<br />
You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows<br />
<br />
<pre><nowiki><br />
<source><br />
<name>tv show</name><br />
<path>xbms://192.168.1.100:1400/tv show/</path><br />
<thumbnail>F:\My TV Shows\folder.jpg</thumbnail><br />
</source><br />
</nowiki></pre><br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|640x360}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=200px |Folder Artwork:<br />
| width=250px |folder.jpg<br />
| width=600px |f:\TVShows\folder.jpg<br />
|- valign="top"<br />
| width=200px |Alternative name:<br />
| width=250px |<foldername>.jpg<br />
| width=600px |f:\TVShows\MyMovies.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
= Extended TV Show Artwork =<br />
To display the Extended artwork, you will need to change to a skin that supports the additional types of artwork. Add-ons are available to automate the download and caching of the extended artwork listed below. This is usually downloaded and installed with the skin. If not, you can manually download and install the add-on separately. The downloader can then be used to automatically scrape the extended artwork from either online or local sources. If you do not want to automate the process, it is possible to perform this procedure manually using the [[Artwork#Kodi-_Choose_Art|Kodi- Choose Art]] procedure detailed in the main Artwork page.<br />
<br />
Two examples are below. <br />
; {{see also|Add-on:Artwork_Downloader}}<br />
:'''''See also: [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
*If using the Artwork Downloader add-on, it is important to note the following<br />
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. This can be selected in the settings page of the add-on<br />
**If you have more than one episode in a single directory, the add-on will scrape the online and also the local artwork if correctly named and saved.<br />
**Using the Kodi scraper will not download extended artwork. The artwork downloader is required to be run after the Kodi scrape process. i.e. you are performing two scrapes.<br />
<br />
<br />
== ClearArt ==<br />
[[File:Artwork-ClearArt02.jpg|400px|right]]<br />
<br />
ClearArt are images that are saved on a transparent background. This allows the image to be overlayed on another image or playing video. The images normally include the tv show name or logo, along with an iconic prop or scene from the tv show, or an actors image.<br />
<br />
The image to the right is displaying ClearArt at the bottom right corner of the image.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.562}}<br />
| width=200px | {{nowrap|500*281}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearart.png<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Clearlogo ==<br />
[[File:Artwork-ClearLogo02.jpg|400px|right]]<br />
<br />
This is the basic tv show logo or name on a transparent background. The logo uses the distinctive font of the tv show and is uncluttered by images from the show or actors. The transparent background allows it to be overlayed on other images or video with minimal impact. This image is sometimes saved as "logo.png", but "clearlogo.png" is preferred to match the library naming convention.<br />
<br />
The image on the right is displaying the tv show listing using the Logo view in the Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.388}}<br />
| width=200px | {{nowrap|400x155}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearlogo.png<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Character Art ==<br />
[[File:Artwork-CharacterArt01.jpg|400px|right]]<br />
Character Art, also known simply as Character, is an image of the main or prominent character in a tv show. It uses a transparent background in a similar fashion to Clear Logo and Clear Art. There are very few skins that display this artwork.<br />
<br />
The image to the right displays the Clear Logo and Character Art in the top right corner.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|800x310}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |characterart.png<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Landscape ==<br />
[[File:Artwork-Landscape01.jpg|400px|right]]<br />
Landscape, also known as TV Show Thumbs (as distinct from Episode Thumbs), are specially made small fanart images. The main differences between Landscape and Fanart images is that Landscape image contains the tv show logo. They are used in certain page layouts for movie browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.<br />
<br />
The image to the right displays the Landscape view in Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1000x562}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |landscape.jpg<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
|}<br />
</div><br />
<br />
= Skin Dependent & Other Artwork =<br />
The following artwork requires a skin that supports that type of artwork.<br />
;{{see also|skin}}<br />
:'''''See also: [https://kodi.tv/addons/browse?keyword=&category=1192&author=&sort=title+ASC<nowiki>Add-on Search</nowiki>]'''''<br />
<br />
<br />
== DiscArt ==<br />
[[File:Artwork-DiscArt01.jpg|400px|right]]<br />
<br />
DiscArt requires the use of a supporting skin. It replicates the picture on the physical DVD and Bluray disc. Although the disc artwork is round, the image itself is square and the disc image is placed on a transparent background. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1000}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |discart.png<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
|}<br />
</div><br />
<br />
== Keyart ==<br />
Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |keyart.jpg<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
|}<br />
</div><br />
<br />
== Extra fanart ==<br />
It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard Fanart described above. These images are not cached, and are directly accessed by the skin.<br />
<br />
Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the TV Show ''(eg f:\TV Shows\Californication\extrafanart)''. Each Extra Fanart must be named ''fanartX.jpg'' where ''X'' is a sequential number starting with 0 ''(fanart0.jpg, fanart1.jpg, fanart2.jpg, etc)''. There is a limit of 10 fanart images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrafanart Folder is as follows.<br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced Extra Fanart:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
<br />
{{Top}}<br />
<br />
<br />
{{updated|17}}<br />
[[Category:Guides]]<br />
[[Category:First time user]]<br />
[[Category:FAQ]]<br />
[[Category:Manual]]<br />
[[Category:Index]]<br />
[[Category:Karellen]]<br />
[[Category:Video library]]<br />
[[Category:Quick Start Guide]]<br />
[[Category:Advanced topics]]<br />
[[User:Karellen|Karellen]] ([[User talk:Karellen|talk]]) 01:57, 29 June 2017 (EDT)</div>Jjd-ukhttps://kodi.wiki/index.php?title=TV-Show_artwork&diff=139846TV-Show artwork2018-08-14T08:54:14Z<p>Jjd-uk: </p>
<hr />
<div>{{Artwork_Contents}}<br />
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}<br />
<br />
<br />
<section begin="intro" />TV Show artwork are images directly related to a TV Show, preferably of high quality, that are displayed when viewing the entry in the library. The TV Show section in Kodi has the impressive ability to display up to 13 types of artwork. This page will describe the different types of artwork available in the TV Show category of Kodi.<section end="intro" /><br />
<br />
{{red|'''It is important to note the following:'''}}<br />
*Artwork is totally skin dependent. This means that some skins display a small number of artwork types, while other skins will display most or all of the available artwork types.<br />
*In previous versions of Kodi and in older wiki pages, the term Thumbnails was used to describe Artwork. Kodi has now moved away from referring to thumbnails due to the amount of confusion and concern it caused users.<br />
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork.<br />
*While high resolution do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware<br />
<br />
<br />
= Basic TV Show Artwork =<br />
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
<br />
<br />
== Banner ==<br />
[[File:Artwork-Banner01.jpg|400px|right]]<br />
Also known as Wide Banner Icons. The image to the right shows the Banner view. They are images that normally contain recognisable characters or moments in the show. The banner image normally displays the movie logo which is of a size that is clearly legible. There should be no written advertising of Actors, Studios etc.<br />
<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:0.185}}<br />
| width=200px | {{nowrap|1000x185}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season banner is '''''season01-banner.jpg''''' where 01 is the season number and '''''season-all-banner.jpg''''' for the All season poster and '''''season-specials-banner.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved TV Show Episodes as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |banner.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |banner.jpg/png<br />
| width=600px |f:\TVShows\Dominion\banner.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Main ==<br />
[[File:Artwork-PosterView02.jpg|400px|right]]<br />
<br />
Also known as ''Cover Art'' and ''Folder Image''. It normally includes the name of the TV Show, along with images of the main character or recognisable scenes from the show.<br />
;{{see also|wikipedia:Poster|l1=Poster on Wikipedia}}<br />
<br />
The image to the right is displaying Poster View of the shows in the Kodi library. They are portrait, high quality images which use a small portion of the screen allowing movie information or other items to be displayed alongside.<br />
<br />
<span style="color:white; background:#2F4F4F"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</span><br /><br />
<br />
<div style="{{linear-gradient|top|#708090, #708090}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Poster- Season ==<br />
[[File:Artwork-SeasonPoster01.jpg|400px|right]]<br />
;{{See also|Season rename}}<br />
<br />
<br />
The Season Poster has the same properties as the TV Show Poster. The season poster is used to display each season in the TV Show. The image to the right shows the Shift view in Estuary which displays the available seasons for the selected TV Show.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained<br /></small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season posters is '''''season01-poster.jpg''''' where 01 is the season number and '''''season-all-poster.jpg''''' for the All season poster and '''''season-specials-poster.jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |season01-poster.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |season01-poster.jpg/png<br />
| width=600px |f:\TVShows\Dominion\season01-poster.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Fanart ==<br />
[[File:Artwork-FanartView03.jpg|400px|right]]<br />
Fanart can be defined as images, depicting iconic scenes in a tv show, that have been created by fans. They are also known as Wallpapers or Backdrops.<br />
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}<br />
<br />
For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. <br />
<br />
<br />
The image to the right is a typical example of a TV Show fanart. It is specifically designed to match the 16:9 ratio of current generation televisions and monitors. This allows the screen to be completely filled by the image. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg or png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
<br />
<small>The naming convention for Season fanart is '''''season01-fanart.jpg''''' where 01 is the season number and '''''season-all-fanart.jpg''''' for the All season fanart and '''''season-specials-fanart jpg''''' for the Specials season</small><br />
<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart.jpg/png<br />
----<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart.jpg/png<br />
| width=600px |f:\TVShows\Dominion\fanart.jpg/png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Animated Artwork ==<br />
[[File:Artwork-Animated01.gif|right]]<br />
Animated Artwork are image files that contain movement. A creator starts with a static image and adds additional frames (images) to the file, each one slightly different to the previous and next image. The images are saved as a gif file, which is recognised as an animated file.<br />
<br />
Kodi has the ability to display animated Fanart and animated Posters. If you have located an animated fanart or poster that you would like to display, simply replace the existing Fanart or Poster artwork using the [[Artwork#Importing.2FScraping_Artwork|Kodi- Choose Art]] procedure.<br />
<br />
To the right is an example of Animated Fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1920x1080 --''' for Fanart'''}}<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.gif}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500 --''' for Poster'''}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=200px |See above<br />
| width=250px |See above<br />
| width=600px |Use Naming and Saving conventions as described in Poster and Fanart above:<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Episode Thumbnail ==<br />
[[File:Artwork-EpisodeThumb01.jpg|400px|right]]<br />
The Episode Thumbnail is an individual and specific image to a particular episode. It usually is a snapshot of a memorable scene in that particular episode.<br />
<br />
These images are often shown in a small box with several on screen at once, so for HD episodes using a resolution smaller than the video file they were captured from can be a good idea.<br />
<br />
The image to the right shows the episode listing using the Episode Thumb view.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1280x720}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\thumb.jpg<br />
|- valign="top"<br />
| width=300px |''also'':<br />
----<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01\Dominion S01E01-thumb.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<EpisodeFileName>-thumb.jpg<br />
| width=600px |f:\TVShows\Dominion\Dominion S01E01-thumb.jpg<br />
|}<br />
</div><br />
<br />
== Actor Image ==<br />
[[File:Artwork-Actors01.jpg|400px|right]]<br />
<br />
The Actor artwork is a portrait of an actor for easy identification.<br />
<br />
The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.<br />
<br />
{{Red|It is important to note the following limitation with actor artwork. Kodi cannot download actor images for every listed actor in the show. This is due to a limitation with the TMDB and TVDB scraper sites. Those sites list only biographical data and images for the '''main cast actors''' only. Episode actors (those actors that appear in only one or two episodes) are line entries at the scraper sites, which means that the actor has no profile page or image attached to them.}}<br />
<br />
{{red|If that episode actor is a main cast actor in another tv show or movie listed within your Kodi library, then an Actor Image and biographical data will be available for display. When viewing the actors for a tv show in Kodi, it is normal to see missing actor artwork. These limitations are being worked on and should become available when the relevant sites update their API's. For TVDB this should become available when they finalise their v2 API. It will then be possible to link episode actors to their profile pages on IMDB. This is beyond the control of Kodi.}}<br />
<!--https://forums.thetvdb.com/viewtopic.php?f=86&t=38214&p=116408#p116380 --><br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1.5}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |<FirstName>_<LastName>.jpg<br />
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Source Folder Artwork ==<br />
[[File:Artwork-VideoFolder01.jpg|400px|right]]<br />
<br />
The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your tv show sources in the Video menu. You will not see this artwork in the TV Show menu. This image file is saved directly within the Source directory.<br />
<br />
To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved the image in the correct location, it will be available to select immediately. If not, you will need to navigate to locate and select it. The image must remain in its original location once selected as it will not be cached. Deleting the image will remove it from view in the folder icon.<br />
<br />
You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows<br />
<br />
<pre><nowiki><br />
<source><br />
<name>tv show</name><br />
<path>xbms://192.168.1.100:1400/tv show/</path><br />
<thumbnail>F:\My TV Shows\folder.jpg</thumbnail><br />
</source><br />
</nowiki></pre><br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|640x360}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=200px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location'''''<br />
|- valign="top"<br />
| width=200px |Folder Artwork:<br />
| width=250px |folder.jpg<br />
| width=600px |f:\TVShows\folder.jpg<br />
|- valign="top"<br />
| width=200px |Alternative name:<br />
| width=250px |<foldername>.jpg<br />
| width=600px |f:\TVShows\MyMovies.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
= Extended TV Show Artwork =<br />
To display the Extended artwork, you will need to change to a skin that supports the additional types of artwork. Add-ons are available to automate the download and caching of the extended artwork listed below. This is usually downloaded and installed with the skin. If not, you can manually download and install the add-on separately. The downloader can then be used to automatically scrape the extended artwork from either online or local sources. If you do not want to automate the process, it is possible to perform this procedure manually using the [[Artwork#Kodi-_Choose_Art|Kodi- Choose Art]] procedure detailed in the main Artwork page.<br />
<br />
Two examples are below. <br />
; {{see also|Add-on:Artwork_Downloader}}<br />
:'''''See also: [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''<br />
<br />
{{red|'''Note the following:'''}}<br />
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.<br />
*If using the Artwork Downloader add-on, it is important to note the following<br />
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. This can be selected in the settings page of the add-on<br />
**If you have more than one episode in a single directory, the add-on will scrape the online and also the local artwork if correctly named and saved.<br />
**Using the Kodi scraper will not download extended artwork. The artwork downloader is required to be run after the Kodi scrape process. i.e. you are performing two scrapes.<br />
<br />
<br />
== ClearArt ==<br />
[[File:Artwork-ClearArt02.jpg|400px|right]]<br />
<br />
ClearArt are images that are saved on a transparent background. This allows the image to be overlayed on another image or playing video. The images normally include the tv show name or logo, along with an iconic prop or scene from the tv show, or an actors image.<br />
<br />
The image to the right is displaying ClearArt at the bottom right corner of the image.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.562}}<br />
| width=200px | {{nowrap|500*281}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearart.png<br />
| width=600px |f:\TVShows\Dominion\clearart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Clearlogo ==<br />
[[File:Artwork-ClearLogo02.jpg|400px|right]]<br />
<br />
This is the basic tv show logo or name on a transparent background. The logo uses the distinctive font of the tv show and is uncluttered by images from the show or actors. The transparent background allows it to be overlayed on other images or video with minimal impact. This image is sometimes saved as "logo.png", but "clearlogo.png" is preferred to match the library naming convention.<br />
<br />
The image on the right is displaying the tv show listing using the Logo view in the Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:0.388}}<br />
| width=200px | {{nowrap|400x155}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |clearlogo.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |clearlogo.png<br />
| width=600px |f:\TVShows\Dominion\clearlogo.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Character Art ==<br />
[[File:Artwork-CharacterArt01.jpg|400px|right]]<br />
Character Art, also known simply as Character, is an image of the main or prominent character in a tv show. It uses a transparent background in a similar fashion to Clear Logo and Clear Art. There are very few skins that display this artwork.<br />
<br />
The image to the right displays the Clear Logo and Character Art in the top right corner.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|800x310}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |characterart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |characterart.png<br />
| width=600px |f:\TVShows\Dominion\characterart.png<br />
|}<br />
</div><br />
<br />
<br />
<br />
== Landscape ==<br />
[[File:Artwork-Landscape01.jpg|400px|right]]<br />
Landscape, also known as TV Show Thumbs (as distinct from Episode Thumbs), are specially made small fanart images. The main differences between Landscape and Fanart images is that Landscape image contains the tv show logo. They are used in certain page layouts for movie browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.<br />
<br />
The image to the right displays the Landscape view in Aeon Nox skin.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|16:9}}<br />
| width=200px | {{nowrap|1000x562}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |landscape.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |landscape.jpg<br />
| width=600px |f:\TVShows\Dominion\landscape.jpg<br />
|}<br />
</div><br />
<br />
= Skin Dependent & Other Artwork =<br />
The following artwork requires a skin that supports that type of artwork.<br />
;{{see also|skin}}<br />
:'''''See also: [https://kodi.tv/addons/browse?keyword=&category=1192&author=&sort=title+ASC<nowiki>Add-on Search</nowiki>]'''''<br />
<br />
<br />
== DiscArt ==<br />
[[File:Artwork-DiscArt01.jpg|400px|right]]<br />
<br />
DiscArt requires the use of a supporting skin. It replicates the picture on the physical DVD and Bluray disc. Although the disc artwork is round, the image itself is square and the disc image is placed on a transparent background. <br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.png}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1000}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |discart.png<br />
----<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |discart.png<br />
| width=600px |f:\TVShows\Dominion\discart.png<br />
|}<br />
</div><br />
<br />
== Keyart ==<br />
Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.<br />
<br />
<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}"><br />
'''Required file properties:'''<br /><br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small><br />
{|<br />
|- valign="top"<br />
| '''''File Type'''''<br />
| '''''Aspect Ratio'''''<br />
| '''''Resolution- <small>recommended</small>'''''<br />
|- valign="top"<br />
| width=150px | {{nowrap|*.jpg}} <br />
| width=200px | {{nowrap|1:1}}<br />
| width=200px | {{nowrap|1000x1500}}<br />
|}<br />
</div><br /><br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced artwork:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |keyart.jpg<br />
----<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |keyart.jpg<br />
| width=600px |f:\TVShows\Dominion\keyart.jpg<br />
|}<br />
</div><br />
<br />
== Extra fanart ==<br />
It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard Fanart described above. These images are not cached, and are directly accessed by the skin.<br />
<br />
Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the TV Show ''(eg f:\TV Shows\Californication\extrafanart)''. Each Extra Fanart must be named ''fanartX.jpg'' where ''X'' is a sequential number starting with 0 ''(fanart0.jpg, fanart1.jpg, fanart2.jpg, etc)''. There is a limit of 10 fanart images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrafanart Folder is as follows.<br />
<br />
<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}"><br />
'''''Naming and Saving conventions for your own manually sourced Extra Fanart:'''''<br />
{|<br />
|- valign="top"<br />
| width=300px |'''''Saved movies as'''''<br />
| width=250px |'''''File Name'''''<br />
| width=600px |'''''Save Location and example'''''<br />
|- valign="top"<br />
| width=300px |BluRay & DVD Structure:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |One episode per directory in the TV Show:<br />
----<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
----<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
----<br />
|- valign="top"<br />
| width=300px |All episodes in TV Show directory:<br />
| width=250px |fanart0.jpg (0 thru 9)<br />
| width=600px |f:\TVShows\Dominion\extrafanart\fanart0.jpg<br />
|}<br />
</div><br />
<br />
<br />
<br />
<br />
{{Top}}<br />
<br />
<br />
{{updated|17}}<br />
[[Category:Guides]]<br />
[[Category:First time user]]<br />
[[Category:FAQ]]<br />
[[Category:Manual]]<br />
[[Category:Index]]<br />
[[Category:Karellen]]<br />
[[Category:Video library]]<br />
[[Category:Quick Start Guide]]<br />
[[Category:Advanced topics]]<br />
[[User:Karellen|Karellen]] ([[User talk:Karellen|talk]]) 01:57, 29 June 2017 (EDT)</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=135903User talk:Jjd-uk2018-02-21T11:59:19Z<p>Jjd-uk: </p>
<hr />
<div>{{divbox|orange||<big>'''NOTICE:''' This is considered an advanced (complicated) and experimental feature.</big>}}<br />
{{divbox|red||{{huge|'''NOTICE:''' Every {{kodi}} "client" '''must''' run the same version of {{kodi}}.}}<br />Otherwise they will not be sharing the same library. There can even be differences between [[development builds]], so make sure you always use the same build dates. See '''[[XBMC databases/Version table|Version table]]''' for more info. }}<br />
{{:MySQL/Contents}}<br />
:''For simple library sharing see: '''[[HOW-TO:Share libraries using UPnP]]'''''<br />
{{See also|Databases}}<br />
<br />
[[File:Network.png|200px|left]]<br />
;<big><u>Introduction</u></big><br />
<section begin="intro"/>If you have more than one {{kodi}} device on your local network then you might want to synchronize them by sharing the Kodi library databases via the MySQL protocol. Using shared library databases allows you to store information for either your video or music library in a central database, so that multiple devices can access the same information at the same time.<section end="intro"/><br />
<br />
This gives you the ability to do things like:<br />
* Share watched and unwatched status for your media on all devices<br />
* Stop watching a movie or TV show in one room then finish watching it in another room automatically<br />
* Only one library to maintain for all devices<br />
{{-}}<br />
<br />
;{{big|MySQL Protocol & MariaDB}}<br />
When setting up shared Library databases either MySQL or Maria DB can be used as they both use the same MySQL protocol. Since many Linux distributions have dropped including MySQL and now instead now ship MariaDB it is being more common to use MariaDB for shared Library databases.<br />
<br />
<br />
{{next|[[MySQL/Setting up MySQL|Setting up MySQL]]}}<br />
<br />
{{Updated|16}}<br />
<br />
[[Category:How-to]]<br />
[[Category:File sharing]]<br />
[[Category:Guides]]<br />
[[Category:Advanced topics]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=135902User talk:Jjd-uk2018-02-21T11:44:12Z<p>Jjd-uk: </p>
<hr />
<div>{{divbox|orange||<big>'''NOTICE:''' This is considered an advanced (complicated) and experimental feature.</big>}}<br />
{{divbox|red||{{huge|'''NOTICE:''' Every {{kodi}} "client" '''must''' run the same version of {{kodi}}.}}<br />Otherwise they will not be sharing the same library. There can even be differences between [[development builds]], so make sure you always use the same build dates. See '''[[XBMC databases/Version table|Version table]]''' for more info. }}<br />
{{:MySQL/Contents}}<br />
:''For simple library sharing see: '''[[HOW-TO:Share libraries using UPnP]]'''''<br />
{{See also|Databases}}<br />
<br />
[[File:Network.png|200px|left]]<br />
;<big><u>Introduction</u></big><br />
<section begin="intro"/>If you have more than one {{kodi}} device on your local network then you might want to synchronize them by sharing the Kodi library databases via the MySQL protocol. Using a shared library databases allows you to store information for either your video or music library in a central database, so that multiple devices can access the same information at the same time.<section end="intro"/><br />
<br />
This gives you the ability to do things like:<br />
* Share watched and unwatched status for your media on all devices<br />
* Stop watching a movie or TV show in one room then finish watching it in another room automatically<br />
* Only one library to maintain for all devices<br />
{{-}}<br />
<br />
;{{big|MySQL Protocol & MariaDB}}<br />
When setting up shared Library databases either MySQL or Maria DB can be used as they both use the same MySQL protocol. Since many Linux distributions have dropped including MySQL and now instead now ship MariaDB it is being more common to use MariaDB for shared Library databases.<br />
<br />
<br />
{{next|[[MySQL/Setting up MySQL|Setting up MySQL]]}}<br />
<br />
{{Updated|16}}<br />
<br />
[[Category:How-to]]<br />
[[Category:File sharing]]<br />
[[Category:Guides]]<br />
[[Category:Advanced topics]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=135901User talk:Jjd-uk2018-02-21T11:31:02Z<p>Jjd-uk: </p>
<hr />
<div>{{divbox|orange||<big>'''NOTICE:''' This is considered an advanced (complicated) and experimental feature.</big>}}<br />
{{divbox|red||{{huge|'''NOTICE:''' Every {{kodi}} "client" '''must''' run the same version of {{kodi}}.}}<br />Otherwise they will not be sharing the same library. There can even be differences between [[development builds]], so make sure you always use the same build dates. See '''[[XBMC databases/Version table|Version table]]''' for more info. }}<br />
{{:MySQL/Contents}}<br />
:''For simple library sharing see: '''[[HOW-TO:Share libraries using UPnP]]'''''<br />
{{See also|Databases}}<br />
<br />
[[File:Network.png|200px|left]]<br />
;<big><u>Introduction</u></big><br />
<section begin="intro"/>If you have more than one {{kodi}} device on your local network then you might want to synchronize them by sharing the Kodi library databases via the MySQL protocol. Using a shared library databases allows you to store information about your whole video library in a central database, so that multiple devices can access the same information at the same time.<section end="intro"/><br />
<br />
This gives you the ability to do things like:<br />
* Share watched and unwatched status for your media on all devices<br />
* Stop watching a movie or TV show in one room then finish watching it in another room automatically<br />
* Only one library to maintain for all devices<br />
{{-}}<br />
<br />
;{{big|MySQL Protocol & MariaDB}}<br />
When setting up shared Library databases either MySQL or Maria DB can be used as they both use the same MySQL protocol. Since many Linux distributions have dropped including MySQL and now instead now ship MariaDB it is being more common to use MariaDB for shared Library databases.<br />
<br />
<br />
{{next|[[MySQL/Setting up MySQL|Setting up MySQL]]}}<br />
<br />
{{Updated|16}}<br />
<br />
[[Category:How-to]]<br />
[[Category:File sharing]]<br />
[[Category:Guides]]<br />
[[Category:Advanced topics]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=135900User talk:Jjd-uk2018-02-21T11:30:16Z<p>Jjd-uk: </p>
<hr />
<div>{{divbox|orange||<big>'''NOTICE:''' This is considered an advanced (complicated) and experimental feature.</big>}}<br />
{{divbox|red||{{huge|'''NOTICE:''' Every {{kodi}} "client" '''must''' run the same version of {{kodi}}.}}<br />Otherwise they will not be sharing the same library. There can even be differences between [[development builds]], so make sure you always use the same build dates. See '''[[XBMC databases/Version table|Version table]]''' for more info. }}<br />
{{:MySQL/Contents}}<br />
:''For simple library sharing see: '''[[HOW-TO:Share libraries using UPnP]]'''''<br />
{{See also|Databases}}<br />
<br />
[[File:Network.png|200px|left]]<br />
;<big><u>Introduction</u></big><br />
<section begin="intro"/>If you have more than one {{kodi}} device on your local network then you might want to synchronize them by sharing the Kodi Library databases via the MySQL protocol. Using a shared library allows you to store information about your whole video library in a central database, so that multiple devices can access the same information at the same time.<section end="intro"/><br />
<br />
This gives you the ability to do things like:<br />
* Share watched and unwatched status for your media on all devices<br />
* Stop watching a movie or TV show in one room then finish watching it in another room automatically<br />
* Only one library to maintain for all devices<br />
{{-}}<br />
<br />
;{{big|MySQL Protocol & MariaDB}}<br />
When setting up shared Library databases either MySQL or Maria DB can be used as they both use the same MySQL protocol. Since many Linux distributions have dropped including MySQL and now instead now ship MariaDB it is being more common to use MariaDB for shared Library databases.<br />
<br />
<br />
{{next|[[MySQL/Setting up MySQL|Setting up MySQL]]}}<br />
<br />
{{Updated|16}}<br />
<br />
[[Category:How-to]]<br />
[[Category:File sharing]]<br />
[[Category:Guides]]<br />
[[Category:Advanced topics]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130972User talk:Jjd-uk2017-10-02T11:22:33Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
{{See also|Backup}}<br />
<section begin="intro" />{{big|This section covers Kodi's various settings and where to find them.}}<section end="intro" /><br />
__NOTOC__<br />
<br />
== Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options.<br><br />
{{-}}<br />
{|style="color:green; background-color:#06353e; float:left; margin-right: 10px" cellpadding="0";<br />
|-<br />
|[[File:Settings Main Player Settings.jpg |200px|centeralt=Alt text|Player Settings|link=Settings/Player]] || [[File:Settings_Main_Media_Settings.jpg|200px|centrealt=Alt text|Media Settings|link=Settings/Media]] || [[File:Settings_Main_PVR_Settings.jpg|200px|centrealt=Alt text|PVR & Live TV settings|link=Settings/Live_TV]] || [[File:Settings_Main_Service_Settings.jpg|200px|centrealt=Alt text|Service settings|link=Settings/Services]]<br />
|-<br />
|[[File:Settings_Main_Interface_Settings.jpg|200px|centrealt=Alt text|Interface Settings|link=Settings/Interface]] || [[File:Settings_Main_Skin_Settings.jpg|200px|centrealt=Alt text|Skin Settings|link=Skin_settings]] || [[File:Settings_Main_Profile_Settings.jpg|200px|centrealt=Alt text|Profile settings|link=Profiles#Profile_settings]] || [[File:Settings_Main_System_Settings.jpg|200px|centrealt=Alt text|System settings|link=Settings/System]]<br />
|-<br />
|[[File:Settings_Main_System_Information.jpg |200px|centrealt=Alt text|System Information|link=]] || [[File:Settings_Main_Event_Log.jpg|200px|centrealt=Alt text|Event Log|link=]] || [[File:Settings_Main_File_Manager.jpg|200px|centrealt=Alt text|File Manager|link=File_manager]] || <br />
|}<br />
<br />
Click on the relevant icon to navigate to the wiki page describing the settings for that section e.g. click player settings icon to be taken to page describing the player settings:<br />
{{-}}<br />
== Settings Level ==<br />
<br />
[[File:settings_levels.jpg|500px|left]] <br />
There are four tiered settings levels where each level unlocks more settings, the levels are:<br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br><br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level. <br />
<br />
{{-}}<br />
<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130971User talk:Jjd-uk2017-10-02T09:47:40Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
{{See also|Backup}}<br />
<section begin="intro" />{{big|This section covers Kodi's various settings and where to find them.}}<section end="intro" /><br />
__NOTOC__<br />
<br />
== Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options.<br><br />
Click on the relevant icon to navigate to the wiki page describing the settings for that section e.g. click player settings icon to be taken to page describing the player settings:<br />
<br />
{{-}}<br />
{|style="color:green; background-color:#06353e;" cellpadding="0"<br />
|-<br />
|[[File:Settings Main Player Settings.jpg |200px|centeralt=Alt text|Player Settings|link=Settings/Player]] || [[File:Settings_Main_Media_Settings.jpg|200px|centrealt=Alt text|Media Settings|link=Settings/Media]] || [[File:Settings_Main_PVR_Settings.jpg|200px|centrealt=Alt text|PVR & Live TV settings|link=Settings/Live_TV]] || [[File:Settings_Main_Service_Settings.jpg|200px|centrealt=Alt text|Service settings|link=Settings/Services]]<br />
|-<br />
|[[File:Settings_Main_Interface_Settings.jpg|200px|centrealt=Alt text|Interface Settings|link=Settings/Interface]] || [[File:Settings_Main_Skin_Settings.jpg|200px|centrealt=Alt text|Skin Settings|link=Skin_settings]] || [[File:Settings_Main_Profile_Settings.jpg|200px|centrealt=Alt text|Profile settings|link=Profiles#Profile_settings]] || [[File:Settings_Main_System_Settings.jpg|200px|centrealt=Alt text|System settings|link=Settings/System]]<br />
|-<br />
|[[File:Settings_Main_System_Information.jpg |200px|centrealt=Alt text|System Information|link=]] || [[File:Settings_Main_Event_Log.jpg|200px|centrealt=Alt text|Event Log|link=]] || [[File:Settings_Main_File_Manager.jpg|200px|centrealt=Alt text|File Manager|link=File_manager]] || <br />
|}<br />
<br />
<br />
== Settings Level ==<br />
<br />
[[File:settings_levels.jpg|500px|left]] <br />
There are four tiered settings levels where each level unlocks more settings, the levels are:<br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br><br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level. <br />
<br />
{{-}}<br />
<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings/Media/Videos&diff=130783Talk:Settings/Media/Videos2017-09-20T13:43:24Z<p>Jjd-uk: Blanked the page</p>
<hr />
<div></div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings/Media/Videos&diff=130782Talk:Settings/Media/Videos2017-09-20T13:35:44Z<p>Jjd-uk: Created page with "{{bigger|This category contains the settings for how information for videos is collected, stored, shown and navigated.}} __TOC__ {{-}} == All == [[File:Settings_media_videos_a..."</p>
<hr />
<div>{{bigger|This category contains the settings for how information for videos is collected, stored, shown and navigated.}}<br />
__TOC__<br />
{{-}}<br />
== All ==<br />
[[File:Settings_media_videos_all.JPG|500px|left]]<br />
=== Default select action ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Basic<br />
|- valign="top"<br />
| '''Description:'''<br />
| Lets you toggle between '''Choose''', '''Play''', '''Resume''' and '''Show information'''<br />
<br />
'''Choose''', will select item, eg open a directory in files mode. <br />
<br />
On '''Resume''' Kodi will automatically resume videos from the last position that you were viewing them, even after restarting the system. <br />
<br />
Default is '''Play'''<br />
|}<br />
<br />
<br />
=== Extract thumbnail and video information ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| When enabled, Kodi will extract thumbnails from videos that have no thumb in the library and information such as codecs and aspect ratio to display in Library Mode.<br />
|}<br />
<br />
<br />
=== Extract chapter thumbnails ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Extract chapter thummbnails for presentation in the chapters/bookmarks dialogue. This might increase CPU load<br />
|}<br />
<br />
<br />
== Files ==<br />
[[File:Settings_media_videos_files.JPG|500px|right]]<br />
=== Combine split video items ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| Combines multi-part video files, DVD folders or movie folders, down to a single item in the non-library views<br />
|}<br />
<br />
<br />
=== Replace file names with library titles ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| When a file is scanned into the library it will display the metadata title instead of the filename<br />
|}<br />
{{-}}<br />
<br />
== Library ==<br />
[[File:Settings_media_videos_library.JPG|500px|right]]<br />
=== Show all items entry ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Show "All items" intry in directory, e.g. "All Albums" or "All seasons"<br />
|}<br />
<br />
<br />
=== Show plot for unwatched items ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Basic<br />
|- valign="top"<br />
| '''Description:'''<br />
| Show plot for unwatched media in the video library<br />
|}<br />
<br />
<br />
=== Show movie sets ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| When enabled, movies belonging to a "Movie set" are grouped together under one entry in for the set in the movie library. This entry can then be opened to display the individual movies. When disabled, each movie wil have its own entry in the movie library even if it belongs to a set.<br />
|}<br />
<br />
<br />
==== Include sets containing a single movie ====<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| When enabled, a "Movie set! entry is used even if the movie library contains only a single movie from that set. When disabled, a "Movie set" entry is used only if the movie library contains more than one movie from a set<br />
|}<br />
<br />
<br />
=== Flatten hierarchy ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Romeves the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view<br />
|}<br />
<br />
<br />
=== Flatten TV show seasons ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Removes the TV show season node, toggles between "If only one season" (default), "Always" and "Never".<br />
|}<br />
<br />
<br />
=== Show empty TV shows ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Shows TV shows with no episodes when browsing through the library<br />
|} <br />
<br />
<br />
=== Select first unwatched TV show season / episode ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| When entering TV show season or episode views, automatically selects the first unwatched item.<br />
If viewing seasons, selects the first season with unwatched episodes.<br />
If viewing episodes, selects the first unwatched episode. Only applies if sort method is set to Episode<br />
|}<br />
<br />
<br />
==== Include "All seasons" and "Specials" ====<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Whether or not consider the items from "All season" and "Specials in the unwatched item selection<br />
|}<br />
<br />
<br />
=== Download actor thumbnails ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Gets thumbnails for actors when scanning media.<br />
|}</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings&diff=130781Talk:Settings2017-09-20T13:22:31Z<p>Jjd-uk: Blanked the page</p>
<hr />
<div></div>Jjd-ukhttps://kodi.wiki/index.php?title=Settings&diff=130780Settings2017-09-20T13:21:44Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
{{See also|Backup}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
<br><br />
'''Settings Levels'''<br><br />
Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br><br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options:<br />
{{-}}<br />
[[File:settings_krypton.JPG|400px|right]]<br />
{{Index two column<br />
| image 1 = Video.png<br />
| link 1 = Settings/Player<br />
| link name 1 = Player settings<br />
| image 2 = Video.png<br />
| link 2 = Settings/Media<br />
| link name 2 = Media settings<br />
| image 3 = Television.png<br />
| link 3 = Settings/Live TV<br />
| link name 3 = TV settings<br />
| image 4 = Crystal Project Network Connection Manager.png<br />
| link 4 = Settings/Services<br />
| link name 4 = Service settings<br />
| image 5 = Crystal Clear app kcoloredit.png<br />
| link 5 = Skin_settings<br />
| link name 5 = Skin settings<br />
| image 6 = Gnome-system-run.png<br />
| link 6 = Profiles#Profile_settings<br />
| link name 6 = Profile settings<br />
| image 7 = Crystal Clear app kcoloredit.png<br />
| link 7 = Settings/Interface<br />
| link name 7 = Interface<br />
| image 8 = Gnome-system-run.png<br />
| link 8 = Settings/System<br />
| link name 8 = System<br />
| image 9 = Gnome-system-run.png<br />
| link 9 = System Information<br />
| link name 9 = System Information<br />
}}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings&diff=130778Talk:Settings2017-09-20T13:17:39Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
{{See also|Backup}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
<br><br />
'''Settings Levels'''<br><br />
Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br><br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options:<br />
{{-}}<br />
[[File:settings_krypton.JPG|400px|right]]<br />
{{Index two column<br />
| image 1 = Video.png<br />
| link 1 = Settings/Player<br />
| link name 1 = Player settings<br />
| image 2 = Video.png<br />
| link 2 = Settings/Media<br />
| link name 2 = Media settings<br />
| image 3 = Television.png<br />
| link 3 = Settings/Live TV<br />
| link name 3 = TV settings<br />
| image 4 = Crystal Project Network Connection Manager.png<br />
| link 4 = Settings/Services<br />
| link name 4 = Service settings<br />
| image 5 = Crystal Clear app kcoloredit.png<br />
| link 5 = Skin_settings<br />
| link name 5 = Skin settings<br />
| image 6 = Gnome-system-run.png<br />
| link 6 = Profiles#Profile_settings<br />
| link name 6 = Profile settings<br />
| image 7 = Crystal Clear app kcoloredit.png<br />
| link 7 = Settings/Interface<br />
| link name 7 = Interface<br />
| image 8 = Gnome-system-run.png<br />
| link 8 = Settings/System<br />
| link name 8 = System<br />
| image 9 = Gnome-system-run.png<br />
| link 9 = System Information<br />
| link name 9 = System Information<br />
}}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}</div>Jjd-ukhttps://kodi.wiki/index.php?title=Settings/System/Audio&diff=130777Settings/System/Audio2017-09-20T13:16:18Z<p>Jjd-uk: </p>
<hr />
<div>[[File:system_audio1.JPG|600px|right]][[File:system_audio2.JPG|600px|right]]<br />
{{See also|Audio}}<br />
__TOC__<br />
<br />
==Audio decoder==<br />
<br />
==GUI sounds==<br />
<br />
==Audio passthrough==<br />
<br />
==Audio DSP==</div>Jjd-ukhttps://kodi.wiki/index.php?title=Settings/System/Audio&diff=130776Settings/System/Audio2017-09-20T13:13:09Z<p>Jjd-uk: </p>
<hr />
<div>[[File:system_audio1.JPG|600px|right]][[File:system_audio2.JPG|600px|right]]<br />
{{See also|http://kodi.wiki/view/Audio|label 1=Audio}}<br />
__TOC__<br />
<br />
==Audio decoder==<br />
<br />
==GUI sounds==<br />
<br />
==Audio passthrough==<br />
<br />
==Audio DSP==</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings&diff=130775Talk:Settings2017-09-20T12:58:39Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
<br><br />
'''Settings Levels'''<br><br />
Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br><br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options:<br />
{{-}}<br />
[[File:settings_krypton.JPG|400px|right]]<br />
{{Index two column<br />
| image 1 = Video.png<br />
| link 1 = Settings/Player<br />
| link name 1 = Player settings<br />
| image 2 = Video.png<br />
| link 2 = Settings/Media<br />
| link name 2 = Media settings<br />
| image 3 = Television.png<br />
| link 3 = Settings/Live TV<br />
| link name 3 = TV settings<br />
| image 4 = Crystal Project Network Connection Manager.png<br />
| link 4 = Settings/Services<br />
| link name 4 = Service settings<br />
| image 5 = Crystal Clear app kcoloredit.png<br />
| link 5 = Skin_settings<br />
| link name 5 = Skin settings<br />
| image 6 = Gnome-system-run.png<br />
| link 6 = Profiles#Profile_settings<br />
| link name 6 = Profile settings<br />
| image 7 = Crystal Clear app kcoloredit.png<br />
| link 7 = Settings/Interface<br />
| link name 7 = Interface<br />
| image 8 = Gnome-system-run.png<br />
| link 8 = Settings/System<br />
| link name 8 = System<br />
| image 9 = Gnome-system-run.png<br />
| link 9 = System Information<br />
| link name 9 = System Information<br />
}}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}<br />
<br />
== Resetting Kodi settings to default ==<br />
{{see also|userdata}}<br />
Delete your [[userdata]] folder and the parent "Kodi" folder (sometimes named ".Kodi") to remove all Kodi settings and library databases. Deleting some individual files/folders in the [[userdata]] folder will also selectively reset those files to a default state.<br />
<br />
== Other settings related pages ==<br />
* [[Audio]]<br />
<br />
== See also ==<br />
* [[Backup]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings&diff=130774Talk:Settings2017-09-20T12:56:09Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
<br><br />
'''Settings Levels'''<br><br />
Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br><br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== System Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options:<br />
{{-}}<br />
[[File:settings_krypton.JPG|400px|right]]<br />
{{Index two column<br />
| image 1 = Video.png<br />
| link 1 = Settings/Player<br />
| link name 1 = Player settings<br />
| image 2 = Video.png<br />
| link 2 = Settings/Media<br />
| link name 2 = Media settings<br />
| image 3 = Television.png<br />
| link 3 = Settings/Live TV<br />
| link name 3 = TV settings<br />
| image 4 = Crystal Project Network Connection Manager.png<br />
| link 4 = Settings/Services<br />
| link name 4 = Service settings<br />
| image 5 = Crystal Clear app kcoloredit.png<br />
| link 5 = Skin_settings<br />
| link name 5 = Skin settings<br />
| image 6 = Gnome-system-run.png<br />
| link 6 = Profiles#Profile_settings<br />
| link name 6 = Profile settings<br />
| image 7 = Crystal Clear app kcoloredit.png<br />
| link 7 = Settings/Interface<br />
| link name 7 = Interface<br />
| image 8 = Gnome-system-run.png<br />
| link 8 = Settings/System<br />
| link name 8 = System<br />
| image 9 = Gnome-system-run.png<br />
| link 9 = System Information<br />
| link name 9 = System Information<br />
}}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}<br />
<br />
== Resetting Kodi settings to default ==<br />
{{see also|userdata}}<br />
Delete your [[userdata]] folder and the parent "Kodi" folder (sometimes named ".Kodi") to remove all Kodi settings and library databases. Deleting some individual files/folders in the [[userdata]] folder will also selectively reset those files to a default state.<br />
<br />
== Other settings related pages ==<br />
* [[Audio]]<br />
<br />
== See also ==<br />
* [[Backup]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130773User talk:Jjd-uk2017-09-20T12:53:42Z<p>Jjd-uk: </p>
<hr />
<div>__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
'''Settings Levels:''' Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== System Settings ==<br />
{|<br />
|colspan="6"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}<br />
<br />
== Resetting Kodi settings to default ==<br />
{{see also|userdata}}<br />
Delete your [[userdata]] folder and the parent "Kodi" folder (sometimes named ".Kodi") to remove all Kodi settings and library databases. Deleting some individual files/folders in the [[userdata]] folder will also selectively reset those files to a default state.<br />
<br />
== Other settings related pages ==<br />
* [[Audio]]<br />
<br />
== See also ==<br />
* [[Backup]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Talk:Settings&diff=130772Talk:Settings2017-09-20T12:52:50Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
'''Settings Levels:''' Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== System Settings ==<br />
For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''<br />
<br />
Choosing Settings from the Home Screen opens the Settings Window. In this window, you are able to configure Kodi's options:<br />
{{-}}<br />
[[File:settings_krypton.JPG|400px|right]]<br />
{{Index two column<br />
| image 1 = Video.png<br />
| link 1 = Settings/Player<br />
| link name 1 = Player settings<br />
| image 2 = Video.png<br />
| link 2 = Settings/Media<br />
| link name 2 = Media settings<br />
| image 3 = Television.png<br />
| link 3 = Settings/Live TV<br />
| link name 3 = TV settings<br />
| image 4 = Crystal Project Network Connection Manager.png<br />
| link 4 = Settings/Services<br />
| link name 4 = Service settings<br />
| image 5 = Crystal Clear app kcoloredit.png<br />
| link 5 = Skin_settings<br />
| link name 5 = Skin settings<br />
| image 6 = Gnome-system-run.png<br />
| link 6 = Profiles#Profile_settings<br />
| link name 6 = Profile settings<br />
| image 7 = Crystal Clear app kcoloredit.png<br />
| link 7 = Settings/Interface<br />
| link name 7 = Interface<br />
| image 8 = Gnome-system-run.png<br />
| link 8 = Settings/System<br />
| link name 8 = System<br />
| image 9 = Gnome-system-run.png<br />
| link 9 = System Information<br />
| link name 9 = System Information<br />
}}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}<br />
<br />
== Resetting Kodi settings to default ==<br />
{{see also|userdata}}<br />
Delete your [[userdata]] folder and the parent "Kodi" folder (sometimes named ".Kodi") to remove all Kodi settings and library databases. Deleting some individual files/folders in the [[userdata]] folder will also selectively reset those files to a default state.<br />
<br />
== Other settings related pages ==<br />
* [[Audio]]<br />
<br />
== See also ==<br />
* [[Backup]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130771User talk:Jjd-uk2017-09-20T12:42:38Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
'''Settings Levels:''' Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== System Settings ==<br />
{|<br />
|colspan="6"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}<br />
<br />
== Resetting Kodi settings to default ==<br />
{{see also|userdata}}<br />
Delete your [[userdata]] folder and the parent "Kodi" folder (sometimes named ".Kodi") to remove all Kodi settings and library databases. Deleting some individual files/folders in the [[userdata]] folder will also selectively reset those files to a default state.<br />
<br />
== Other settings related pages ==<br />
* [[Audio]]<br />
<br />
== See also ==<br />
* [[Backup]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130770User talk:Jjd-uk2017-09-20T12:38:39Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]}}<br />
__NOTOC__<br />
[[File:settings_levels.jpg|400px|right]]<section begin="intro" />This section covers Kodi's various settings and where to find them.<br />
<br />
Note that there are four tiered settings levels where each level unlocks more settings, the levels are: <br />
* Basic<br />
* Standard (Default)<br />
* Advanced<br />
* Expert<br />
<br />
The "Settings level" can be changed using the button in the bottom left which shows the currently selected level.<section end="intro" /><br />
{{-}}<br />
<br />
== System Settings ==<br />
{|<br />
|colspan="6"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}<br />
== Advanced settings ==<br />
{{main|advancedsettings.xml}}<br />
{{#lst:advancedsettings.xml|intro}}<br />
<br />
== Resetting Kodi settings to default ==<br />
{{see also|userdata}}<br />
Delete your [[userdata]] folder and the parent "Kodi" folder (sometimes named ".Kodi") to remove all Kodi settings and library databases. Deleting some individual files/folders in the [[userdata]] folder will also selectively reset those files to a default state.<br />
<br />
== Other settings related pages ==<br />
* [[Audio]]<br />
<br />
== See also ==<br />
* [[Backup]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130769User talk:Jjd-uk2017-09-20T12:27:11Z<p>Jjd-uk: </p>
<hr />
<div>{|<br />
|colspan="6"|<big>'''Settings levels'''</big><br />
|-<br />
|colspan="5"|There are tiered settings levels. Each mode unlocks more settings, and is available by selecting the "Settings level" button, which will also display the currently used level.||rowspan="6"|[[File:settings_levels.jpg|400px]]<br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
|colspan="6"|<big>'''System settings'''</big><br />
|-<br />
|colspan="6"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130768User talk:Jjd-uk2017-09-20T12:24:57Z<p>Jjd-uk: </p>
<hr />
<div>{|<br />
|colspan="6"|<big>'''Settings levels'''</big><br />
|-<br />
|colspan="5"|There are tiered settings levels. Each mode unlocks more settings, and is available by selecting the "Settings level" button, which will also display the currently used level.||rowspan="6"|[[File:Confluence - settings level.jpg|400px]]<br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
| || || || || || <br />
|-<br />
|colspan="6"|<big>'''System settings'''</big><br />
|-<br />
|colspan="6"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130767User talk:Jjd-uk2017-09-20T11:44:52Z<p>Jjd-uk: </p>
<hr />
<div>{|<br />
|colspan="6"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|colspan="6"|<big>'''GUI Settings'''</big>|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130766User talk:Jjd-uk2017-09-20T11:33:09Z<p>Jjd-uk: </p>
<hr />
<div>{|<br />
|colspan="5"|For Version 16 and below see '''[[Settings_legacy|Settings legacy]]'''|| ||<br />
|-<br />
|colspan="5"|<big>'''GUI Settings'''</big>|| ||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]|| || rowspan="6"|[[File:settings_krypton.JPG|400px]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated||<br />
|-<br />
|[[File:Video.png|50px]]||[[Settings/Player|Player settings]]||[[File:Video.png|50px]]||[[Settings/Media|Media settings]]||[[File:Video.png|50px]]||[[Settings/Player|Player settings]]<br />
|-<br />
| ||Section that contains the settings for the playback of media|| ||Section that contains the settings for sources and how media information is collected, stored, shown and navigated|| ||Section that contains the settings for the playback of media<br />
|}</div>Jjd-ukhttps://kodi.wiki/index.php?title=Basic_controls&diff=130379Basic controls2017-07-27T13:04:09Z<p>Jjd-uk: /* Sidebar menu */</p>
<hr />
<div>{{mininav|[[First time user]]}}<br />
<br />
<br />
{{cleanup}}<br />
<br />
<br />
<section begin="intro" />This page describes the basic controls that are used in most areas of Kodi, as well as the Kodi home screen. This page assumes you are using the default skin for Kodi, '''[[Confluence]]'''.<section end="intro" /><br />
<br />
== Home screen ==<br />
{{main|Add-on:Confluence/Settings}}<br />
[[File:XBMC home.jpg|center|700px]]<br />
<br />
The home screen in the default skin, as well as most other skins, show the user the major areas of Kodi, such as videos, music, pictures, etc. Menus can be laid out in various different ways, but in Confluence most options are in a horizontal menu.<br />
<br />
<br />
Pressing left or right on the main menu "ribbon" will highlight different main options, which then have additional more specific options that can be selected when the user presses down {{keypress|down}}. The main options are:<br />
<br />
* '''[[Videos]]''' - Shows the top level of all video areas, including file views, movie library, TV show library, music video library, playlists, and video related add-ons. Users can also use this to navigate to more '''[[video nodes|nodes]]''' in the library, showing movies or TV shows by year, genre, actor, or even custom created nodes for specific people, moods, etc.<br />
* '''[[videos|Movies]]''' - This is a short cut to the "All movies, by title" node in the video library.<br />
* '''[[videos|TV shows]]''' - This is a short cut to the "All TV shows, by title" node in the video library.<br />
* '''[[Music]]''' - This is the main music view, which can be toggled between a basic file mode or a meta-data rich "library mode" via the sidebar menu. Users can also find playlists and music/audio-related add-ons in this section. Like with videos, the library mode has '''[[audio nodes|nodes]]''' that show different listings and can be customized.<br />
* '''[[Pictures]]''' - Shows a basic file-based image viewer, as well as picture-related add-ons.<br />
* '''[[Add-ons|Programs]]''' - "Programs" is normally just a selection of "program"-type [[add-ons]], such as add-ons that control lights or show sports scores. However, some platforms such as Android will also list other installed programs, which can be launched from within Kodi.<br />
* '''[[Settings|System]]''' - All the system settings, system info, [[profile]] controls, and [[file manager]].<br />
<br />
{{note|Certain options, such as "Movies" and "TV shows" will only show up once files have been scanned into the library (see '''[[adding videos to the library]]'''). Even without a scanned in library, users can still use the "Videos" button to select and play videos using file-based navigation.}}<br />
<br />
<br />
In the [[Add-on:Confluence/Settings|Confluence settings]] different main menu options can also show add-on shortcuts. For example, video related buttons/tabs can be set up to show shortcuts to your most used video add-ons. Video, music, pictures, and "programs" can all have add-on shortcuts. <br />
<br />
<br />
Above the main menu ribbon is a search button, which searches for videos and music that have been added to their respective libraries. It does not currently search for add-on content.<br />
<br />
<br />
Below the man menu ribbon are two additional buttons and an '''[[RSS ticker]]''':<br />
* The "Star" button opens up the '''[[Favorites|Favorites menu]]'''.<br />
* The power button opens up the '''[[Shutdown menu]]'''<br />
<br />
<br />
The home screen also displays the current date and time, and can optionally show '''[[weather]]''' information, if set up.<br />
<br />
{{-}}<br />
=== RSS ticker ===<br />
{{main|RSS ticker}}<br />
{{#lst:RSS ticker|intro}}<br />
<br />
== Contextual menu ==<br />
The '''context menu''' gives you quick access to some functions that also can be accessed by the keyboard directly (e.g. ''Queue item''), while other functions (e.g. ''Change content'') are only accessible from the context menu.<br />
<br />
You can bring up the context menu either by:<br />
* right-clicking with the mouse.<br />
* pressing the {{keypress|C}} key .<br />
* pressing the {{button|guide}} button on a [[Remote controls#MCE Remote|MCE]] remote.<br />
<br />
Examples of the context menu:<br />
<gallery widths="240" heights="136"><br />
File:Contextmenu1.png|The context menu in the ''Movie library''.<br />
File:Contextmenu2.png|The context menu in the [[Add-on:YouTube|YouTube]] add-on.<br />
File:Contextmenu3.png|The context menu in the ''Video file browser''.<br />
File:Contextmenu4.png|The context menu in the ''Favourites menu''.<br />
</gallery><br />
<br />
;See below for specific explanations of the contextual menu on different menus and areas of Kodi:<br />
* '''[[Video navigation#Contextual menu|In the video library]]'''<br />
* '''[[Music library#Context Menu|In the music library]]'''<br />
* '''[[Favourites]]''', '''[[playlists]]''', the '''[[file manager]]''', and various '''[[add-ons]]''' have management and editing options in the contextual menu.<br />
<br />
== Sidebar menu ==<br />
<br />
[[File:EstuarySideBarMenu_small.gif|right]]<br />
[[File:Estuary-player-sidebar-video.jpg|210px|right]]<br />
<br />
'''Locating the Sidebar Menu'''<br />
<br />
You can bring up the sidebar menu either by:<br />
* bringing the mouse cursor to the left side.<br />
* pressing the {{keypress|left}} key, when browsing Files.<br />
* pressing the {{keypress|left}} key, when browsing the library views List, Big List, Thumbnail, Media info, Media info 2 and Media info 3.<br />
* pressing the {{keypress|up}} key, when browsing the library views Poster wrap and Fanart.<br />
<br />
<br />
<br />
<br />
'''Available Options'''<br />
<br />
;ViewType<br />
:Change current library view.<br />
<br />
;Sort by<br />
:Select how the list of Movies/TV Shows/Episodes are sorted- eg Title, PlayCount etc<br />
<br />
;Order<br />
:Once the ''Sort by'' is selected, do you want the order Ascending or Descending<br />
<br />
;Filter<br />
:Allows you to filter your list on certain criteria- eg Director, Actor, Ratings, Tags etc<br />
<br />
;All Videos / Watched / Unwatched<br />
:Global toggle that allows you to select what is shown in the list - All Videos, Watched or Unwatched videos only<br />
<br />
;Update library<br />
:Scans the library for newly added Movies/TV Shows and Episodes<br />
<br />
<br />
<br />
Additional information about the sidebar menu's functions in different parts of Kodi can be seen on these pages:<br />
* '''[[Video navigation]]'''<br />
* '''[[Music navigation]]'''<br />
* '''[[Add-ons]]'''<br />
* '''[[PVR/Basics]]'''<br />
<br />
{{-}}<br />
<br />
== Profiles ==<br />
{{Main|Profiles}}<br />
{{#lst:Profiles|intro}}<br />
<br />
== Favourites ==<br />
{{main|Favourites}}<br />
{{#lst:Favourites|intro}}<br />
<br />
== Shutdown menu ==<br />
Pressing {{keypress|S}} on the keyboard, or by selecting the Shutdown icon in the lower left corner of the default Estuary skin the home screen brings up the shutdown menu.<br />
<br />
[[File:Estuary-power-menu.jpg|right|299px]]<br />
'''The options on this menu are from top to bottom:'''<br />
<br />
;Exit<br />
:Exits Kodi to your operating system.<br />
;Power off system<br />
:Powers down your system<br />
;Custom Shutdown Timer<br />
:Kodi will shutdown your computer after you enter the countdown time.<br />
;Suspend<br />
:Suspends your computer.<br />
;Hibernate<br />
:Hibernates your computer.<br />
;Reboot<br />
:Restarts your computer.<br />
<br />
{{-}}<br />
<br />
== File manager ==<br />
{{main|File manager}}<br />
{{#lst:File manager|intro}}<br />
<br />
== On screen keyboard ==<br />
{{helix note|This section already needs to be expanded in general, but Helix will bring some very significant chances to the on screen keyboard. Probably enough to even justify making a seperate page for the OSK. This includes basic usage, the different layout options, etc. If anyone wants to help add this information, please do.}}<br />
<br />
* Kodi can use USB keyboards or you can use the remote control-friendly on-screen-keyboard.<br />
<br />
* Kodi for iOS will use the native iOS on-screen-keyboard. This also allows iOS to have clipboard paste support.<br />
<br />
* Windows, Mac OS X, and iOS have clipboard paste support for text entry.<br />
<br />
== System information screen ==<br />
{{editor note|There's really not much to say about this, as the system info screen is pretty self explanatory. This section just needs a screen shot and a basic description of what information is summarized there.}}<br />
<br />
== Profiles ==<br />
{{main|Profiles}}<br />
{{#lst:Profiles|intro}}<br />
<br />
== Weather ==<br />
{{main|Weather}}<br />
{{#lst:Weather|intro}}<br />
<br />
== See also ==<br />
* [[Keyboard controls]]<br />
* [[Remote controls]]<br />
<br />
{{Isengard updated}}<br />
<br />
[[Category:Manual]]<br />
[[Category:General topics]]<br />
[[Category:First time user]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=User_talk:Jjd-uk&diff=130378User talk:Jjd-uk2017-07-27T13:02:31Z<p>Jjd-uk: Replaced content with "File:EstuarySideBarMenu_small.gif"</p>
<hr />
<div>[[File:EstuarySideBarMenu_small.gif]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=File:EstuarySideBarMenu_small.gif&diff=130377File:EstuarySideBarMenu small.gif2017-07-27T13:01:46Z<p>Jjd-uk: MsUpload</p>
<hr />
<div>MsUpload</div>Jjd-ukhttps://kodi.wiki/index.php?title=Settings/Player/Videos&diff=130319Settings/Player/Videos2017-07-22T14:00:06Z<p>Jjd-uk: /* Platform Specific Hardware Acceleration settings */</p>
<hr />
<div>{{bigger|This category contains the settings for the playback of videos}}<br />
__TOC__<br />
<br />
== Actions ==<br />
[[File:Settings - Player - Videos - Action.jpg|500px|right]]<br />
=== Play next video automatically ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Basic<br />
|- valign="top"<br />
| '''Description:'''<br />
| When selected this enables automatic playback of the next file in the list. <br />
|}<br />
; {{small see also|Playlists}}<br />
<br />
<br />
=== Skip steps ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| Defines the amount of time each press of the Skip button will skip forward or backwards. A (-) will define backwards and no (-) will define forward. You can set multiple times so each press will skip more time in the video. So if, for example you use '''10 sec, 30 sec, 60 sec''' when press the Skip button once it will skip 10 seconds foward, double pressing the Skip button will skip 30 seconds and triple pressing the Skip button will skip 60 seconds.<br />
|}<br />
; {{small see also|Skip steps}}<br />
<br />
<br />
=== Skip delay ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| Defines how much time it takes before the skip step occurs. The range is '''none''' (which will cause the skip step to happen immediately) & '''250 - 3000ms''' (milliseconds).<br />
|}<br />
<br />
<br />
{{-}}<br />
<br />
== Playback==<br />
[[File:Settings - Player - Videos - Playback.jpg|500px|right]]<br />
<br />
=== Adjust display refresh rate ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}} <br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| Defines when the refresh rate adjustments should take place. Activate to automatically set the refresh rate which is best matched with the video that is playing (default off). This potentially allows for perfectly smooth video reproduction, as video material can be recorded in a variety of frame rates (23.976fps, 24fps, 25fps, 29.97fps, 30 fps, etc.) which need to be properly matched by the refresh rate of the display, in order to be displayed smoothly.<br />
|}<br />
<br />
<br />
=== Sync playback to display ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Standard<br />
|- valign="top"<br />
| '''Description:'''<br />
| This setting enables syncing the video to the refresh rate of the monitor.<br />
|}<br />
<br />
<br />
=== Minimise black bars ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Allow video player to try to fit video to screen by ignoring aspect ratio by a certain amount.<br />
|}<br />
<br />
<br />
=== Display {{nowrap|4:3}} videos as ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Determines the zoom level that 4:3 videos are shown on widescreen displays.<br />
|}<br />
<br />
<br />
{{-}}<br />
<br />
== Processing ==<br />
[[File:Settings - Player - Videos - Processing.jpg|500px|right]]<br />
<br />
=== Render method ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Controls the method used by the player to process and display the video, (which is called rendering).<br />
|}<br />
<br />
<br />
=== Enable HQ scalers for scaling above ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Use high quality scalers when upscaling a video by at least this percentage. A value below 5% makes little sense as video is processed with high GPU load without any visible picture quality improvements<br />
|}<br />
<br />
<br />
=== Platform Specific Hardware Acceleration settings ===<br />
:The following settings will show up for the '''Processing''' section for their respective platforms: <br />
<br />
{{collapse top|Windows specific settings (click 'expand' to view)}}<br />
; Allow hardware acceleration DXVA2<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable DXVA2 hardware decoding of video files.<br />
|}<br />
{{collapse bottom}}<br />
<br />
{{collapse top|Linux specific settings (click 'expand' to expand)}}<br />
; Allow hardware acceleration - VDPAU<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable VDPAU hardware decoding of video files, mainly used for NVIDIA graphics and in some circumstances AMD graphics.<br />
|}<br />
<br />
<br />
; Prefer VDPAU video mixer<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Bypassing VDPAU mixer saves resources on low power systems but slightly reduces picture quality.<br />
|}<br />
<br />
<br />
; Use MPEG-4 VDPAU<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Expert<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable this option to use hardware acceleration for the MPEG-4 codec. If disabled the CPU will be used instead. Some ION hardware has problems with this being enabled by default.<br />
|}<br />
<br />
<br />
; Allow hardware acceleration - VAAPI<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable VAAPI hardware decoding of video files, mainly used for Intel graphics and in some circumstances AMD graphics.<br />
|}<br />
<br />
<br />
; Use MPEG-2 VAAPI<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Expert<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable this option to use hardware acceleration for MPEG-(1/2) codecs. If disabled the CPU will be used instead. Some MPEG-2 videos might have green artifacts.<br />
|}<br />
<br />
<br />
; Use MPEG-4 VAAPI<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Expert<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable this option to use hardware acceleration for MPEG-4 codec. If disabled the CPU will be used instead.<br />
|}<br />
<br />
<br />
; Use VC-1 VAAPI<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Expert<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable this option to use hardware acceleration for VC-1 based codecs. If disabled the CPU will be used instead. Especially VC-1 interlaced fails hard on Intel hardware.<br />
|}<br />
<br />
<br />
; Prefer VAAPI render method<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Expert<br />
|- valign="top"<br />
| '''Description:'''<br />
| When enabled, VAAPI render method is preferred and the CPU has less load. If you experience hangs, disable this option.<br />
|}<br />
{{collapse bottom}}<br />
<br />
{{collapse top|Mac OS specific settings (click 'expand' to expand)}}<br />
; Allow hardware acceleration - VTBDecoder<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enable VTB hardware decoding of video files.<br />
|}<br />
{{collapse bottom}}<br />
{{-}}<br />
<br />
== Stereoscopic 3D ==<br />
[[File:Settings - Player - Videos - Stereoscopic - 3D.jpg|500px|right]]<br />
<br />
=== Playback mode of stereoscopic videos ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Select in which mode stereoscopic 3D videos will be played. [Ask me] Will show a dialogue to select the desired mode for each playback. [Preferred mode] Will use the preferred mode specified in the "system->Video hardware" section of the settings. [Monoscopic/2D] will play the video in mono/2D. [Ignore] Disables any stereoscopic 3D processing and handling.<br />
|}<br />
<br />
<br />
=== Disable stereoscopic mode when playback is stopped ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| While enabled, GUI and some TVs will switch back to 2D mode, beween videos in a playlist or when playback ended. While disabled, GUI and TV will stay in stereoscopic 3D mode. For video playlists with mixed stereoscopic 3D and 2D content, then the GUI will also stay in stereoscopic 3D mode even when a non-stereoscopic 2D video is playing.<br />
|}<br />
<br />
<br />
; {{see also|3D}}<br />
<br />
<br />
== Teletext ==<br />
[[File:Settings - Player - Videos - Teletext.jpg|500px|right]]<br />
<br />
=== Activate Teletext ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| Enables Teletext when watching a live TV stream.<br />
|}<br />
<br />
<br />
=== Scale Teletext to {{nowrap|4:3}} ===<br />
{|<br />
|- valign="top"<br />
| width=120px | {{nowrap|'''Settings level:'''}}<br />
| Advanced<br />
|- valign="top"<br />
| '''Description:'''<br />
| When selected, scales Teletext to 4:3 ratio.<br />
|}<br />
<br />
<br />
{{-}}</div>Jjd-ukhttps://kodi.wiki/index.php?title=Supported_hardware&diff=129929Supported hardware2017-06-22T16:42:47Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]{{l2|[[Hardware]]}}|[[Installing]]}}<br />
{{see also|Devices and hardware}}<br />
{{forum link2|1=Want to discuss or ask about what hardware is good for Kodi? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=112 Hardware for Kodi subforum]}}<br />
<section begin="intro" />Kodi is officially supported on a number of operating systems and hardware devices that are designed to be connected directly to a TV. Kodi runs well on what are relatively "underpowered" systems, thanks to hardware video decoding being common on nearly all supported platforms. These requirements don't include what might be required for some "advanced" features, such as PVR, which might require additional hardware. <section end="intro" /><br />
<br />
<br />
== Android ==<br />
{{see also|Android|Android hardware}}<br />
<section begin="Android" />{{Warning|It is highly recommended for users to not make any purchases in anticipation of running Kodi on Android without first researching the device you want to buy. Before you do buy, make sure multiple people have verified that it works! <big><u>'''''If in doubt, do not buy that hardware!'''''</u></big>}}<br />
* Kodi v17 requires Android 5.0 or higher.<br />
* x86 (Intel) or NEON compatible ARM processor, (for example: Nvidia Tegra 3 and newer are fully supported by Kodi, while Tegra 2 and older are not).<br />
* The main aim for the Android port of Kodi is to foremost target media-players/set-top-boxes/sticks that connect to a large screen television and uses a standard remote control as its main interface device, (that is the same market as for HTPC).<section end="Android" /><br />
<br />
== iOS ==<br />
{{see also|iOS}}<br />
<section begin="iOS" /><br />
=== ATV2 ===<br />
<section begin="ATV2" /><br />
* As of v15.0, Kodi no longer supports the Apple TV 2.<section end="ATV2" /><br />
<br />
=== ATV4 ===<br />
<section begin="ATV4" /><br />
* Apple TV 4 is supported by Kodi. For step by step Installation guide, click the How-To guide below.<section end="ATV4" /><br />
<br />
=== iDevices ===<br />
<section begin=iDevices />*To '''[[HOW-TO:Install Kodi for iOS|install Kodi for iOS]]''' you must have one of the following:<br />
** a jailbroken [[w:iDevice|iDevice]] running iOS 6.0 or higher<br />
** a normal iDevice running iOS 6.0 or higher and a Mac running Xcode 7 and higher<br />
* For hardware: iPad (1,2,3,4), iPad Air (1,2), iPad Mini (1,2,3), iPhone (4, 4s, 5, 5c, 5s, 6, 6+, 6s, 6s+), iPod touch (4, 5, 6).<section end=iDevices /><br />
<section end="iOS" /><br />
<br />
== Linux ==<br />
{{See also|Linux}}<br />
<br />
=== Desktop ===<br />
<section begin="Linux" /><br />
{| class="prettytable" style="background-color:#FFFFFF;"<br />
! CPU<br />
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).<br />
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc<br />
|-<br />
! RAM<br />
|<br />
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.<br />
|-<br />
! Graphics<br />
|<br />
Kodi will run on most graphics cards made within the last 10-years or so, though for good hardware video decoding support a little newer graphics cards can be required. This includes most cards from AMD/ATI, Intel, or NVIDIA which support OpenGL 2.0 or later.<br />
<br />
'''AMD/Intel'''<br />
* '''Minimum:''' [[w:Mesa_(computer_graphics)|Mesa 11.3]] or later<br />
* '''Recommended:''' [[w:Mesa_(computer_graphics)|Mesa 17.1]] or later (required for 10 bit HEVC)<br />
|-<br />
! Video decoding<br />
| For hardware video decoding, which may be necessary on low-performance CPUs to playback 1080p content, make sure your GPU or VPU supports either VAAPI or VDPAU.<br />
<br />
{| class="datatable" width="100%"<br />
! !! ATI ( [[w:VDPAU| VDPAU]] or [[w:Video_Acceleration_API| VA-API minimum 1.7.1]] ) !! Intel ( [[w:Video_Acceleration_API| VA-API minimum 1.7.1]] ) !! Nvidia ( [[w:VDPAU| VDPAU]] )<br />
|- <br />
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon RV710/M92 (HD 4300/4500)]] [[w:Unified Video Decoder#UVD enabled GPUs|Note: These are uvd2.2 cards]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] or newer || [[w:GeForce|Nvidia GeForce 6-Series]]<br />
|-<br />
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon|AMD/ATI Radeon HD 5000 Series]] or newer || [[w:Intel HD and Iris Graphics| Bay Trail /Sandybridge]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon Rx 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 900 series (GM20x)]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || Not available || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || Not available<br />
|}<br />
|-<br />
! Drive space<br />
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.<br />
* '''Minimum:''' 4 to 8GB<br />
* '''Recommended:''' 16GB or more<br />
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].<br />
|}<section end="Linux" /><br />
<br />
=== Embedded systems (ARM/MIPS-based hardware) ===<br />
Other than OpenGL ES 2.0 graphics support being a must it is very hard to generalize Kodi hardware requirements for Linux-based operating-system distributions on ARM or MIPS based embedded systems. This is partially due to most of the work in this area still being early/on-going in development. For most ARM and MIPS-based devices, hardware video decoding support will also be needed for most high-definition videos, (and possibly even some standard-definition videos). Some newer and faster high-end ARM/MIPS chipset can decode some high-definition video using software video decoding, but those encoded with the latest video codecs.<br />
<br />
'''Here are a few popular embedded hardware devices that are known to work with Kodi and Linux:'''<br />
<br />
* '''[[Raspberry Pi]]''' - Hardware video decoding support for H.264, MPEG-2, and VC-1. GUI is responsive on most light skins. Official supported by many third-party JeOS (Just enough Operating System) Linux distributions made for Kodi such as [[LibreELEC]], [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]<br />
* '''[[Cubox-i]]''' - Official supported by [[LibreELEC]], [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]<br />
* '''Various "Android" boxes''' - can run reinstalled with a Linux firmware and boot directly into Kodi. Hardware video decoding for most video codecs, GUI is very responsive on most skins. Running Linux and Kodi on these "Android boxes" will likely result in better performance and enhanced playback capabilities than running Kodi under Android.<br />
<br />
=== JeOS implementations for Kodi ===<br />
{{main|JeOS implementations for Kodi}}<br />
{{#lst:JeOS implementations for Kodi|JeOS for Kodi}}<br />
<br />
== Mac OS X ==<br />
{{see also|Mac OS X}}<br />
<section begin="Mac OS X" /><br />
*Kodi v17 requires Mac OS X 10.8 or later.<br />
*All hardware requirements are the same as those for OS X 10.8. If your computer can run OS X 10.8 or later then your hardware should work just fine with Kodi.<section end="Mac OS X" /><br />
<br />
== Windows ==<br />
{{See also|Windows}}<br />
{{Note|Due to changes in code it may be possible that older hardware/videocards are no longer supported. If starting of Kodi fails then try upgrading to last available drivers (or beta drivers).}}<br />
<section begin="Windows" /><br />
{| class="prettytable" style="background-color:#FFFFFF;"<br />
! Windows Version<br />
|<br />
* '''Minimum:''' Windows 7<br />
* '''Recommended:''' Windows 10<br />
|-<br />
! CPU<br />
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).<br />
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc<br />
|-<br />
! RAM<br />
|<br />
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.<br />
|-<br />
! Graphics<br />
|<br />
GPU hardware must support at least level [[w:DirectX|DirectX version 9.0c]] however the GPU software drivers must support the [[w:Feature_levels_in_Direct3D#Direct3D_11| DirectX 11 Feature Level 9.1]] (which means the DX11 API has been implemented in the GPU software driver to be compatible with DX9 hardware) <br />
|-<br />
! Video decoding<br />
| On low-performance CPUs to playback 1080p content then hardware video decoding maybe necessary.<br />
{| class="datatable" width="100%"<br />
! !! AMD/ATI !! Intel !! Nvidia<br />
|- <br />
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon R300 Series (Radeon 9500)]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] or newer || [[w:GeForce|Nvidia GeForce 4-Series]]<br />
|-<br />
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon| AMD/ATI Radeon HD 3000 Series ]] or newer || [[w:Intel HD and Iris Graphics| Bay Trail /Sandybridge]] or newer || [[w:GeForce|Nvidia GeForce 4-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon RX 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon 400 series]] or newer || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|}<br />
|-<br />
! Drive space<br />
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.<br />
* '''Minimum:''' 4 to 8GB<br />
* '''Recommended:''' 16GB or more<br />
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].<br />
|}<section end="Windows" /><br />
<br />
{{Updated|17}}<br />
<br />
[[Category:Manual]]<br />
[[Category:Hardware|*]]<br />
[[Category:Installation]]<br />
[[Category:General topics]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Supported_hardware&diff=129928Supported hardware2017-06-22T16:42:04Z<p>Jjd-uk: </p>
<hr />
<div>{{mininav|[[General topics]]{{l2|[[Hardware]]}}|[[Installing]]}}<br />
{{see also|Devices and hardware}}<br />
{{forum link2|1=Want to discuss or ask about what hardware is good for Kodi? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=112 Hardware for Kodi subforum]}}<br />
<section begin="intro" />Kodi is officially supported on a number of operating systems and hardware devices that are designed to be connected directly to a TV. Kodi runs well on what are relatively "underpowered" systems, thanks to hardware video decoding being common on nearly all supported platforms. These requirements don't include what might be required for some "advanced" features, such as PVR, which might require additional hardware. <section end="intro" /><br />
<br />
<br />
== Android ==<br />
{{see also|Android|Android hardware}}<br />
<section begin="Android" />{{Warning|It is highly recommended for users to not make any purchases in anticipation of running Kodi on Android without first researching the device you want to buy. Before you do buy, make sure multiple people have verified that it works! <big><u>'''''If in doubt, do not buy that hardware!'''''</u></big>}}<br />
* Kodi v17 requires Android 5.0 or higher.<br />
* x86 (Intel) or NEON compatible ARM processor, (for example: Nvidia Tegra 3 and newer are fully supported by Kodi, while Tegra 2 and older are not).<br />
* The main aim for the Android port of Kodi is to foremost target media-players/set-top-boxes/sticks that connect to a large screen television and uses a standard remote control as its main interface device, (that is the same market as for HTPC).<section end="Android" /><br />
<br />
== iOS ==<br />
{{see also|iOS}}<br />
<section begin="iOS" /><br />
=== ATV2 ===<br />
<section begin="ATV2" /><br />
* As of v15.0, Kodi no longer supports the Apple TV 2.<section end="ATV2" /><br />
<br />
=== ATV4 ===<br />
<section begin="ATV4" /><br />
* Apple TV 4 is supported by Kodi. For step by step Installation guide, click the How-To guide below.<section end="ATV4" /><br />
<br />
=== iDevices ===<br />
<section begin=iDevices />*To '''[[HOW-TO:Install Kodi for iOS|install Kodi for iOS]]''' you must have one of the following:<br />
** a jailbroken [[w:iDevice|iDevice]] running iOS 6.0 or higher<br />
** a normal iDevice running iOS 6.0 or higher and a Mac running Xcode 7 and higher<br />
* For hardware: iPad (1,2,3,4), iPad Air (1,2), iPad Mini (1,2,3), iPhone (4, 4s, 5, 5c, 5s, 6, 6+, 6s, 6s+), iPod touch (4, 5, 6).<section end=iDevices /><br />
<section end="iOS" /><br />
<br />
== Linux ==<br />
{{See also|Linux}}<br />
<br />
=== Desktop ===<br />
<section begin="Linux" /><br />
{| class="prettytable" style="background-color:#FFFFFF;"<br />
! CPU<br />
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).<br />
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc<br />
|-<br />
! RAM<br />
|<br />
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.<br />
|-<br />
! Graphics<br />
|<br />
Kodi will run on most graphics cards made within the last 10-years or so, though for good hardware video decoding support a little newer graphics cards can be required. This includes most cards from AMD/ATI, Intel, or NVIDIA which support OpenGL 2.0 or later.<br />
<br />
'''AMD/Intel'''<br />
* '''Minimum:''' [[w:Mesa_(computer_graphics)|Mesa 11.3]] or later<br />
* '''Recommended:''' [[w:Mesa_(computer_graphics)|Mesa 17.1]] or later (required for 10 bit HEVC)<br />
|-<br />
! Video decoding<br />
| For hardware video decoding, which may be necessary on low-performance CPUs to playback 1080p content, make sure your GPU or VPU supports either VAAPI or VDPAU.<br />
<br />
{| class="datatable" width="100%"<br />
! !! ATI ( [[w:VDPAU| VDPAU]] or [[w:Video_Acceleration_API| VA-API minimum 1.7.1]] ) !! Intel ( [[w:Video_Acceleration_API| VA-API minimum 1.7.1]] ) !! Nvidia ( [[w:VDPAU| VDPAU]] )<br />
|- <br />
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon RV710/M92 (HD 4300/4500)]] [[w:Unified Video Decoder#UVD enabled GPUs|Note: These are uvd2.2 cards]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] || [[w:GeForce|Nvidia GeForce 6-Series]]<br />
|-<br />
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon|AMD/ATI Radeon HD 5000 Series]] or newer || [[w:Intel HD and Iris Graphics| Bay Trail /Sandybridge]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon Rx 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 900 series (GM20x)]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || Not available || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || Not available<br />
|}<br />
|-<br />
! Drive space<br />
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.<br />
* '''Minimum:''' 4 to 8GB<br />
* '''Recommended:''' 16GB or more<br />
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].<br />
|}<section end="Linux" /><br />
<br />
=== Embedded systems (ARM/MIPS-based hardware) ===<br />
Other than OpenGL ES 2.0 graphics support being a must it is very hard to generalize Kodi hardware requirements for Linux-based operating-system distributions on ARM or MIPS based embedded systems. This is partially due to most of the work in this area still being early/on-going in development. For most ARM and MIPS-based devices, hardware video decoding support will also be needed for most high-definition videos, (and possibly even some standard-definition videos). Some newer and faster high-end ARM/MIPS chipset can decode some high-definition video using software video decoding, but those encoded with the latest video codecs.<br />
<br />
'''Here are a few popular embedded hardware devices that are known to work with Kodi and Linux:'''<br />
<br />
* '''[[Raspberry Pi]]''' - Hardware video decoding support for H.264, MPEG-2, and VC-1. GUI is responsive on most light skins. Official supported by many third-party JeOS (Just enough Operating System) Linux distributions made for Kodi such as [[LibreELEC]], [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]<br />
* '''[[Cubox-i]]''' - Official supported by [[LibreELEC]], [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]<br />
* '''Various "Android" boxes''' - can run reinstalled with a Linux firmware and boot directly into Kodi. Hardware video decoding for most video codecs, GUI is very responsive on most skins. Running Linux and Kodi on these "Android boxes" will likely result in better performance and enhanced playback capabilities than running Kodi under Android.<br />
<br />
=== JeOS implementations for Kodi ===<br />
{{main|JeOS implementations for Kodi}}<br />
{{#lst:JeOS implementations for Kodi|JeOS for Kodi}}<br />
<br />
== Mac OS X ==<br />
{{see also|Mac OS X}}<br />
<section begin="Mac OS X" /><br />
*Kodi v17 requires Mac OS X 10.8 or later.<br />
*All hardware requirements are the same as those for OS X 10.8. If your computer can run OS X 10.8 or later then your hardware should work just fine with Kodi.<section end="Mac OS X" /><br />
<br />
== Windows ==<br />
{{See also|Windows}}<br />
{{Note|Due to changes in code it may be possible that older hardware/videocards are no longer supported. If starting of Kodi fails then try upgrading to last available drivers (or beta drivers).}}<br />
<section begin="Windows" /><br />
{| class="prettytable" style="background-color:#FFFFFF;"<br />
! Windows Version<br />
|<br />
* '''Minimum:''' Windows 7<br />
* '''Recommended:''' Windows 10<br />
|-<br />
! CPU<br />
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).<br />
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc<br />
|-<br />
! RAM<br />
|<br />
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.<br />
|-<br />
! Graphics<br />
|<br />
GPU hardware must support at least level [[w:DirectX|DirectX version 9.0c]] however the GPU software drivers must support the [[w:Feature_levels_in_Direct3D#Direct3D_11| DirectX 11 Feature Level 9.1]] (which means the DX11 API has been implemented in the GPU software driver to be compatible with DX9 hardware) <br />
|-<br />
! Video decoding<br />
| On low-performance CPUs to playback 1080p content then hardware video decoding maybe necessary.<br />
{| class="datatable" width="100%"<br />
! !! AMD/ATI !! Intel !! Nvidia<br />
|- <br />
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon R300 Series (Radeon 9500)]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] || [[w:GeForce|Nvidia GeForce 4-Series]]<br />
|-<br />
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon| AMD/ATI Radeon HD 3000 Series ]] or newer || [[w:Intel HD and Iris Graphics| Bay Trail /Sandybridge]] or newer || [[w:GeForce|Nvidia GeForce 4-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon RX 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon 400 series]] or newer || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|}<br />
|-<br />
! Drive space<br />
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.<br />
* '''Minimum:''' 4 to 8GB<br />
* '''Recommended:''' 16GB or more<br />
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].<br />
|}<section end="Windows" /><br />
<br />
{{Updated|17}}<br />
<br />
[[Category:Manual]]<br />
[[Category:Hardware|*]]<br />
[[Category:Installation]]<br />
[[Category:General topics]]</div>Jjd-ukhttps://kodi.wiki/index.php?title=Supported_hardware&diff=129927Supported hardware2017-06-22T16:39:20Z<p>Jjd-uk: /* Desktop */</p>
<hr />
<div>{{mininav|[[General topics]]{{l2|[[Hardware]]}}|[[Installing]]}}<br />
{{see also|Devices and hardware}}<br />
{{forum link2|1=Want to discuss or ask about what hardware is good for Kodi? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=112 Hardware for Kodi subforum]}}<br />
<section begin="intro" />Kodi is officially supported on a number of operating systems and hardware devices that are designed to be connected directly to a TV. Kodi runs well on what are relatively "underpowered" systems, thanks to hardware video decoding being common on nearly all supported platforms. These requirements don't include what might be required for some "advanced" features, such as PVR, which might require additional hardware. <section end="intro" /><br />
<br />
<br />
== Android ==<br />
{{see also|Android|Android hardware}}<br />
<section begin="Android" />{{Warning|It is highly recommended for users to not make any purchases in anticipation of running Kodi on Android without first researching the device you want to buy. Before you do buy, make sure multiple people have verified that it works! <big><u>'''''If in doubt, do not buy that hardware!'''''</u></big>}}<br />
* Kodi v17 requires Android 5.0 or higher.<br />
* x86 (Intel) or NEON compatible ARM processor, (for example: Nvidia Tegra 3 and newer are fully supported by Kodi, while Tegra 2 and older are not).<br />
* The main aim for the Android port of Kodi is to foremost target media-players/set-top-boxes/sticks that connect to a large screen television and uses a standard remote control as its main interface device, (that is the same market as for HTPC).<section end="Android" /><br />
<br />
== iOS ==<br />
{{see also|iOS}}<br />
<section begin="iOS" /><br />
=== ATV2 ===<br />
<section begin="ATV2" /><br />
* As of v15.0, Kodi no longer supports the Apple TV 2.<section end="ATV2" /><br />
<br />
=== ATV4 ===<br />
<section begin="ATV4" /><br />
* Apple TV 4 is supported by Kodi. For step by step Installation guide, click the How-To guide below.<section end="ATV4" /><br />
<br />
=== iDevices ===<br />
<section begin=iDevices />*To '''[[HOW-TO:Install Kodi for iOS|install Kodi for iOS]]''' you must have one of the following:<br />
** a jailbroken [[w:iDevice|iDevice]] running iOS 6.0 or higher<br />
** a normal iDevice running iOS 6.0 or higher and a Mac running Xcode 7 and higher<br />
* For hardware: iPad (1,2,3,4), iPad Air (1,2), iPad Mini (1,2,3), iPhone (4, 4s, 5, 5c, 5s, 6, 6+, 6s, 6s+), iPod touch (4, 5, 6).<section end=iDevices /><br />
<section end="iOS" /><br />
<br />
== Linux ==<br />
{{See also|Linux}}<br />
<br />
=== Desktop ===<br />
<section begin="Linux" /><br />
{| class="prettytable" style="background-color:#FFFFFF;"<br />
! CPU<br />
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).<br />
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc<br />
|-<br />
! RAM<br />
|<br />
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.<br />
|-<br />
! Graphics<br />
|<br />
Kodi will run on most graphics cards made within the last 10-years or so, though for good hardware video decoding support a little newer graphics cards can be required. This includes most cards from AMD/ATI, Intel, or NVIDIA which support OpenGL 2.0 or later.<br />
<br />
'''AMD/Intel'''<br />
* '''Minimum:''' [[w:Mesa_(computer_graphics)|Mesa 11.3]] or later<br />
* '''Recommended:''' [[w:Mesa_(computer_graphics)|Mesa 17.1]] or later (required for 10 bit HEVC)<br />
|-<br />
! Video decoding<br />
| For hardware video decoding, which may be necessary on low-performance CPUs to playback 1080p content, make sure your GPU or VPU supports either VAAPI or VDPAU.<br />
<br />
{| class="datatable" width="100%"<br />
! !! ATI ( [[w:VDPAU| VDPAU]] or [[w:Video_Acceleration_API| VA-API minimum 1.7.1]] ) !! Intel ( [[w:Video_Acceleration_API| VA-API minimum 1.7.1]] ) !! Nvidia ( [[w:VDPAU| VDPAU]] )<br />
|- <br />
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon RV710/M92 (HD 4300/4500)]] [[w:Unified Video Decoder#UVD enabled GPUs|Note: These are uvd2.2 cards]] || [[w:Intel HD and Iris Graphics| Arrandale / Clarkdale]] || [[w:GeForce|Nvidia GeForce 6-Series]]<br />
|-<br />
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon|AMD/ATI Radeon HD 5000 Series]] or newer || [[w:Intel HD and Iris Graphics| Bay Trail /Sandybridge]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon Rx 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 900 series (GM20x)]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || Not available || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || Not available<br />
|}<br />
|-<br />
! Drive space<br />
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.<br />
* '''Minimum:''' 4 to 8GB<br />
* '''Recommended:''' 16GB or more<br />
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].<br />
|}<section end="Linux" /><br />
<br />
=== Embedded systems (ARM/MIPS-based hardware) ===<br />
Other than OpenGL ES 2.0 graphics support being a must it is very hard to generalize Kodi hardware requirements for Linux-based operating-system distributions on ARM or MIPS based embedded systems. This is partially due to most of the work in this area still being early/on-going in development. For most ARM and MIPS-based devices, hardware video decoding support will also be needed for most high-definition videos, (and possibly even some standard-definition videos). Some newer and faster high-end ARM/MIPS chipset can decode some high-definition video using software video decoding, but those encoded with the latest video codecs.<br />
<br />
'''Here are a few popular embedded hardware devices that are known to work with Kodi and Linux:'''<br />
<br />
* '''[[Raspberry Pi]]''' - Hardware video decoding support for H.264, MPEG-2, and VC-1. GUI is responsive on most light skins. Official supported by many third-party JeOS (Just enough Operating System) Linux distributions made for Kodi such as [[LibreELEC]], [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]<br />
* '''[[Cubox-i]]''' - Official supported by [[LibreELEC]], [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]<br />
* '''Various "Android" boxes''' - can run reinstalled with a Linux firmware and boot directly into Kodi. Hardware video decoding for most video codecs, GUI is very responsive on most skins. Running Linux and Kodi on these "Android boxes" will likely result in better performance and enhanced playback capabilities than running Kodi under Android.<br />
<br />
=== JeOS implementations for Kodi ===<br />
{{main|JeOS implementations for Kodi}}<br />
{{#lst:JeOS implementations for Kodi|JeOS for Kodi}}<br />
<br />
== Mac OS X ==<br />
{{see also|Mac OS X}}<br />
<section begin="Mac OS X" /><br />
*Kodi v17 requires Mac OS X 10.8 or later.<br />
*All hardware requirements are the same as those for OS X 10.8. If your computer can run OS X 10.8 or later then your hardware should work just fine with Kodi.<section end="Mac OS X" /><br />
<br />
== Windows ==<br />
{{See also|Windows}}<br />
{{Note|Due to changes in code it may be possible that older hardware/videocards are no longer supported. If starting of Kodi fails then try upgrading to last available drivers (or beta drivers).}}<br />
<section begin="Windows" /><br />
{| class="prettytable" style="background-color:#FFFFFF;"<br />
! Windows Version<br />
|<br />
* '''Minimum:''' Windows 7<br />
* '''Recommended:''' Windows 10<br />
|-<br />
! CPU<br />
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).<br />
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc<br />
|-<br />
! RAM<br />
|<br />
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.<br />
|-<br />
! Graphics<br />
|<br />
GPU hardware must support at least level [[w:DirectX|DirectX version 9.0c]] however the GPU software drivers must support the [[w:Feature_levels_in_Direct3D#Direct3D_11| DirectX 11 Feature Level 9.1]] (which means the DX11 API has been implemented in the GPU software driver to be compatible with DX9 hardware) <br />
|-<br />
! Video decoding<br />
| On low-performance CPUs to playback 1080p content then hardware video decoding maybe necessary.<br />
{| class="datatable" width="100%"<br />
! !! AMD/ATI !! Intel !! Nvidia<br />
|- <br />
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon R300 Series (Radeon 9500)]] || [[w:Intel GMA|Intel GMA 950 (945G)]] || [[w:GeForce|Nvidia GeForce 4-Series]]<br />
|-<br />
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon| AMD/ATI Radeon HD 3000 Series ]] or newer || [[w:Intel GMA|Intel GMA X4500HD (G45)]] or newer || [[w:GeForce|Nvidia GeForce 4-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 8-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon RX 300 series]] or newer || [[w:Intel HD and Iris Graphics| Braswell / Skylake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|-<br />
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || [[w:Radeon|AMD Radeon 400 series]] or newer || [[w:Intel_HD_and_Iris_Graphic| Apollo Lake / Kaby Lake]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer<br />
|}<br />
|-<br />
! Drive space<br />
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.<br />
* '''Minimum:''' 4 to 8GB<br />
* '''Recommended:''' 16GB or more<br />
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].<br />
|}<section end="Windows" /><br />
<br />
{{Updated|17}}<br />
<br />
[[Category:Manual]]<br />
[[Category:Hardware|*]]<br />
[[Category:Installation]]<br />
[[Category:General topics]]</div>Jjd-uk