Official Kodi Wiki - User contributions [en]

Advancedsettings.xml

2021-04-19T06:44:31Z

DaveBlake: Nothing special about <useartistsort>, it is just like all the other GUI settings that can be hidden by including in advancedsettings

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

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

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

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

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==== Extra artwork ====

Applies to Kodi v18 only.

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

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

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


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

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

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

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

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

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

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

== Library artwork ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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


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

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

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

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

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


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

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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

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

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

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

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

== File system settings ==

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

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

Default: False

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

=== smartredraw ===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= References =
<references />

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

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

Advancedsettings.xml

2020-11-20T14:25:42Z

DaveBlake: /* network */ add NFS timeout

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

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

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

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

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==== Extra artwork ====

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

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

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


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

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

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

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

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

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

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

== Library artwork ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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


<useartistsortname>false</useartistsortname> 


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

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

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

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

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


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

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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

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

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

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

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

== File system settings ==

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

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

Default: False

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

=== smartredraw ===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= References =
<references />

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

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

List of Built In Controls

2020-08-05T06:19:54Z

DaveBlake: /* DialogSelect.xml */

<section begin="main content" />
== .xml files ==

=== AddonBrowser.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Enable auto-updating of the installed add-on's
|-
|6 ||radiobutton ||Enable add-on notifications
|-
|7 ||radiobutton ||Enable language filter
|-
|8 ||radiobutton ||Hide broken addons
|-
|9 ||button ||Check for repo updates
|}

=== DialogAddonInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Install the selected add-on
|-
|7 ||button ||Disable the selected add-on
|-
|8 ||button ||Update the selected add-on
|-
|9 ||button ||Show the settings of the selected add-on
|-
|10 ||button ||Show the dependencies of the selected add-on
|-
|12 ||button ||Run the selected add-on
|-
|13 ||radiobutton ||Auto-update
|-
|50 ||container ||List of available screenshots
|}

=== DialogAddonSettings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|3 ||grouplist ||Grouplist template
|-
|5 ||grouplist ||Grouplist template
|-
|7 ||button ||Button template
|-
|8 ||radiobutton ||Radiobutton template
|-
|9 ||spincontrolex ||Spincontrolex template
|-
|10 ||togglebutton ||Togglebutton template
|-
|11 ||image ||Default separator image
|-
|12 ||edit ||Edit template
|-
|13 ||sliderex ||Slider template
|-
|14 ||label ||Label template
|-
|28 ||button ||OK button
|-
|29 ||button ||Cancel button
|-
|30 ||button ||<unused button>
|}

=== DialogAudioDSPManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|20 ||container ||List with available options
|-
|21 ||container ||List with active options
|-
|22 ||radiobutton ||Continuous save button
|-
|23 ||button ||Apply button
|-
|24 ||button ||Clear button
|-
|9000 ||container ||List with available modes
|}

=== DialogBusy.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||progress ||Progress bar
|}

=== DialogButtonMenu.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3100 ||label ||Label of the focused button
|}

=== DialogConfirm.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|9 ||textbox ||Message
|-
|10 ||button ||No button
|-
|11 ||button ||Yes button
|-
|12 ||button ||(for future use)
|-
|20 ||progress ||Progress bar
|}

=== DialogContextMenu.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|999 ||image ||Background image of the context menu (center part) (deprecated)
|-
|998 ||image ||Background image of the context menu (bottom part) (deprecated)
|-
|997 ||image ||Background image of the context menu (top part) (deprecated)
|-
|996 ||grouplist || Grouplist template
|-
|999 ||image ||Background image of the context menu
|-
|1000 ||button ||Button template
|}

=== DialogExtendedProgressBar.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|30 ||label ||Heading label
|-
|31 ||label ||Line 1
|-
|32 ||progress ||Scan progress bar
|}

=== DialogGameControllers.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3 ||grouplist ||List of controller types
|-
|5 ||grouplist ||List of feature types
|-
|7 ||button ||Button template
|-
|8 ||label ||Settings category label template
|-
|9 ||image ||Settings separator image template
|-
|10 ||button ||Button template
|-
|17 ||button ||Help button
|-
|18 ||button ||OK button
|-
|19 ||button ||Reset button
|-
|20 ||button ||Get more... button
|-
|21 ||button ||Ignore input button
|-
|22 ||button ||Get all button
|-
|31 ||gamecontroller ||Gamecontroller image template
|-
|32 ||textbox ||Controller description
|}

=== DialogFavourites.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|450 ||container ||List of available favourites
|}

=== DialogKeyboard.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|8 ||button ||Backspace button
|-
|100 – 111 ||button ||Digits 0 – 9
|-
|120 – 171 ||button ||Characters A – Z
|-
|300 ||button ||Done Button
|-
|301 ||button ||Cancel button
|-
|302 ||radiobutton ||Shift button
|-
|303 ||radiobutton ||Caps-Lock button
|-
|304 ||radiobutton ||Switch to symbols
|-
|305 ||button ||Navigate left button
|-
|306 ||button ||Navigate right button
|-
|307 ||button ||Enter IP address button
|-
|309 ||button ||Layout button
|-
|311 ||label ||Heading label
|-
|312 ||edit ||Label displaying the text being entered
|-
|313 ||label ||Label displaying the text being entered (when keyboard layout is Chinese)
|-
|314 ||label ||Label displaying the available choices (when keyboard layout is Chinese)
|}

=== DialogMediaSource.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|10 ||container ||List of added media sources
|-
|11 ||button ||Browse for location button
|-
|12 ||edit ||Button for entering the name for the selected source
|-
|13 ||button ||Add new source button
|-
|14 ||button ||Delete source button
|-
|18 ||button ||OK button
|-
|19 ||button ||Cancel button (unused)
|}

=== DialogMusicInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Refresh artist information / Refresh album information
|-
|7 ||button ||User rating
|-
|10 ||button ||Get artist thumbnail / Get album thumbnail
|-
|11 ||button ||Connect to the Last.fm radio channel for this artist
|-
|12 ||button ||Get artist fanart image
|-
|13 ||button ||Get song thumbnail
|-
|50 ||container || Discography of the selected artist / tracks on the selected album / contributors on the selected song
|}

=== DialogNotification.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|400 ||image ||Default Icon
|-
|401 ||label ||Heading text
|-
|402 ||label ||Message text
|}

=== DialogNumeric.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|4 ||label ||Label displaying the digits being entered
|-
|10 – 19 ||button ||Digits 0 – 9
|-
|20 ||button ||Navigate left button
|-
|21 ||button ||Enter Button
|-
|22 ||button ||Navigate right button
|-
|23 ||button ||Backspace button
|}

=== DialogPictureInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|5 ||container ||List of the available exif information of the image currently being displayed
|}

=== DialogPVRChannelManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||button ||OK button
|-
|5 ||button ||Apply button
|-
|6 ||button ||Cancel button
|-
|7 ||radiobutton ||Activate channel button
|-
|6 ||button ||Cancel button
|-
|8 ||edit ||Channel name
|-
|9 ||button ||Channel logo
|-
|11 ||spincontrolex ||Select group
|-
|12 ||radiobutton ||Activate EPG
|-
|13 ||spincontrolex ||Select EPG source button
|-
|30 ||button ||Switch to group management
|-
|31 ||button ||New channel
|-
|34 ||button ||Toggle radio / tv channels
|-
|20 ||container ||Channel list
|}

=== DialogPVRChannelsOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Channels list
|}

=== DialogPVRGroupManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Ungrouped channels
|-
|12 ||container ||Grouped channels
|-
|13 ||container ||Group list
|-
|25 ||radiobutton ||Hide / Unhide button
|-
|26 ||button ||Add button
|-
|27 ||button ||Rename button
|-
|28 ||button ||Delete button
|-
|29 ||button ||OK button
|-
|34 ||togglebutton ||Switch between TV / Radio
|}

=== DialogPVRChannelGuide.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|11 ||container ||Guide list
|}

=== DialogPVRGuideSearch.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|9 ||edit ||Search string
|-
|10 ||radiobutton ||Include description
|-
|11 ||radiobutton ||Case sensitive
|-
|12 ||spincontrolex ||Minimal duration
|-
|13 ||spincontrolex ||Maximal duration
|-
|14 ||edit ||Start date
|-
|15 ||edit ||End date
|-
|16 ||edit ||Start time
|-
|17 ||edit ||End Time
|-
|18 ||spincontrolex ||Genre
|-
|19 ||radiobutton ||Avoid repeats
|-
|20 ||radiobutton ||Unknown genres
|-
|21 ||spincontrolex ||Groups
|-
|22 ||radiobutton ||FTA
|-
|23 ||spincontrolex ||Channels
|-
|24 ||radiobutton ||Ignore timers
|-
|25 ||button ||Cancel button
|-
|26 ||button ||Search button
|-
|27 ||radiobutton ||Ignore recordings
|-
|28 ||button ||Defaults button
|}

=== DialogPVRInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||button ||Similar button
|-
|5 ||button ||Switch to channel button
|-
|6 ||button ||Record button
|-
|7 ||button ||OK button
|-
|8 ||button ||Play button
|-
|9 ||button ||Add timer button
|}

=== DialogSeekBar.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|401 ||slider ||Marker representing the current seek position
|-
|402 ||label ||Time label displaying current seek position
|}

=== DialogSelect.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Heading label
|-
|2 ||label ||Number of items in the list
|-
|3 ||container ||List of available options
|-
|5 ||button ||OK (on multiple selection) or Manual/Get More... button
|-
|6 ||container ||List of available add-ons
|-
|7 ||button ||Cancel button
|-
|8 ||button || Add/Get More... button
|-
|11 ||container ||List with game video thumbnails
|-
|12 ||textbox ||Description of the currently-selected video filter
|}

=== DialogSettings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Header label
|-
|5 ||grouplist ||Grouplist template
|-
|7 ||button ||button template
|-
|8 ||radiobutton ||radiobutton template
|-
|9 ||spincontrolex ||spincontrolex template
|-
|11 ||image ||image template
|-
|12 ||edit ||edit template
|-
|13 ||sliderex ||sliderex template
|-
|14 ||label ||label template
|-
|28 ||button ||ok button
|-
|29 ||button ||cancel button
|-
|30 ||button ||clear/settings button
|}

=== DialogSlider.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||label ||Heading label
|-
|11 ||slider ||Slider
|-
|12 ||label ||Label representing the slider value
|}

=== DialogSubtitles.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|100 ||label ||Name of subtitle service
|-
|110 ||image ||Logo of subtitle service
|-
|120 ||container ||List of available subtitles
|-
|130 ||label ||Local subtitle available
|-
|140 ||label ||Number of available subtitles
|-
|150 ||container ||List of available subtitle services
|-
|160 ||button ||Manual search buttom
|}

=== DialogTextViewer.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|5 ||textbox ||Text area for add-on output
|}

=== DialogVideoInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|3 ||image ||Video thumb
|-
|4 ||textbox ||Text area for displaying the video plot
|-
|5 ||button ||Toggle between video review and cast members (Deprecated)
|-
|6 ||button ||Refresh video information
|-
|7 ||button ||User rating
|-
|8 ||button ||Play video
|-
|9 ||button ||Resume video
|-
|10 ||button ||Get video Fanart, Poster, Banner, or Thumb
|-
|11 ||button ||Play movie trailer
|-
|13 ||button ||Show all movies by the director of the selected movie
|-
|50 ||container ||List of cast members of the currently selected movie
|}

=== EventLog.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|20 ||button ||Clear button
|-
|21 ||button ||Level button
|-
|22 ||radiobutton ||Only show current level radiobutton
|-
|50 ||container ||Container with event loglines
|}

=== FileBrowser.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|450 ||container ||Directory list
|-
|451 ||container ||List of available thumbnails
|-
|411 ||label ||Heading label
|-
|412 ||label ||Path of the selected item
|-
|413 ||button ||OK button
|-
|414 ||button ||Cancel button
|-
|415 ||button ||Create folder
|-
|416 ||radiobutton ||Flip Image horizontally
|}

=== FileManager.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|12 ||label ||Number of items in directory list 1
|-
|13 ||label ||Number of items in directory list 2
|-
|20 ||container ||Directory list 1
|-
|21 ||container ||Directory list 2
|-
|101 ||label ||Path of the currently selected directory in list 1
|-
|102 ||label ||Path of the currently selected directory in list 2
|}

=== GameOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1101 ||label ||Help text
|-
|1102 ||gamecontroller ||Controller layout
|}

=== LoginScreen.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|3 ||label ||Number of the currently selected profile
|-
|52 ||container ||List of the available profiles
|}

=== MusicOSD.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|500 ||button ||Select visualization
|-
|501 ||button ||Lock visualization to the current preset
|}

=== MusicVisualisation.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||visualisation ||Background Visualization
|}

=== MyMusicNav.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Switch to file mode
|-
|8 ||edit ||Search for a string anywhere in the Kodi music database
|-
|12 ||label ||Number of items in the list
|-
|15 ||label ||Filter label
|-
|16 ||radiobutton ||Start party mode (randomly play songs from your entire music collection)
|-
|17 ||button ||Manually enter artist and album name to lookup the artist and album information on the internet
|-
|18 ||label ||Warning to the user to turn off library mode when no scanned media is found
|-
|19 ||radiobutton / edit||Filter the media files to only show items that include the specified string in the name
|-
|20 ||button ||Update library
|}

=== MyMusicPlaylistEditor.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|6 ||button ||Load the playlist
|-
|7 ||button ||Save the playlist
|-
|8 ||button ||Clear the playlist
|-
|12 ||label ||Number of items in the current directory or library list
|-
|XX ||container ||List allowing you to browse your directories and music library
|-
|100 ||container ||List of songs in the playlist
|-
|101 ||label ||Number of items in the playlist
|}

=== MyPics.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|6 ||button ||Start a picture slideshow
|-
|7 ||button ||Start a recursive picture slideshow
|-
|9 ||radiobutton ||Randomize the picture slideshow
|-
|12 ||label ||Number of items in the list
|}

=== MyPlaylist.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|12 ||label ||Number of items in the playlist
|-
|20 ||radiobutton ||Shuffle the playlist
|-
|21 ||button ||Save the playlist
|-
|22 ||button ||Clear the playlist
|-
|23 ||button ||Play the playlist
|-
|24 ||button ||Play the next item in the playlist
|-
|25 ||button ||Play the previous item in the playlist
|-
|26 ||button ||Put the playlist on repeat
|}

=== MyPrograms.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|12 ||label ||Number of items in the list
|}

=== MyPVRChannels.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|6 ||radiobutton ||Show hidden channels
|-
|28 ||button ||Channel groups button
|-
|29 ||label ||Channel groups name
|-
|31 ||radiobutton ||Filter
|}

=== MyPVRGuide.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|10 ||epggrid ||EPG Guide Timeline
|-
|11 ||container ||Channel groups selector
|-
|28 ||button ||Channel groups button
|-
|29 ||label ||View name (Now / Next / Timeline)
|-
|30 ||label ||Channel groups name
|}

=== MyPVRRecordings.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||radiobutton ||Group items by folder structure
|-
|7 ||radiobutton ||Show deleted recordings
|-
|10 ||button ||Show only watched, unwatched or all recordings
|-
|28 ||button ||Channelgroups button
|-
|29 ||label ||'Deleted' (When show deleted recordings is enabled, otherwise empty)
|}

=== MyPVRSearch.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|28 ||button ||Channel groups button
|}

=== MyPVRTimers.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|8 ||radiobutton ||Hide disabled timers
|-
|28 ||button ||Channel groups button
|}

=== MyVideoNav.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Select viewtype (list, thumbnail, media info, etc...)
|-
|3 ||button ||Select sort method (sort by: name, date size, etc...)
|-
|4 ||togglebutton ||Select sortmode (ascending or descending)
|-
|5 ||button ||Switch to file mode
|-
|6 ||button ||Play DVD (used the play physical DVD discs)
|-
|8 ||button ||Search for a string anywhere in the Kodi video database
|-
|10 ||button ||Show only watched, unwatched or all videos
|-
|12 ||label ||Number of items in the list
|-
|14 ||button ||Show only unwatched or all videos
|-
|11 ||button ||Unlock shares
|-
|15 ||label ||Filter label
|-
|16 ||button ||Start party mode (randomly play musicvideos from your collection)
|-
|18 ||label ||Warning to the user to turn off library mode when no scanned media is found
|-
|19 ||radiobutton / edit ||Filter the media files to only show items that include the specified string in the name
|-
|20 ||button ||Update library
|}

=== MyWeather.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Refresh the weather information
|-
|3 ||spincontrolex ||Change weather location
|-
|11 ||label ||Shows the time of last weather update
|-
|31 ||label ||Current day label
|-
|32 ||label ||Today's high temperature value
|-
|33 ||label ||Today's low temperature value
|-
|34 ||label ||Today's weather condition
|-
|35 ||image ||Today's weather icon
|-
|223 ||label ||Localized “Temperature” string
|-
|224 ||label ||Localized “Feels like” string
|-
|225 ||label ||Localized “UV index” string
|-
|226 ||label ||Localized “Wind” string
|-
|227 ||label ||Localized “Dew point” string
|-
|228 ||label ||Localized “Humidity” string
|}

=== Pointer.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||image ||Pointer no focus image
|-
|2 ||image ||Pointer focus image
|-
|3 ||image ||Pointer drag image
|-
|4 ||image ||Pointer click image
|}

=== SettingsCategory.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Label displaying the current settings category
|-
|3 ||grouplist ||Grouplist template for the menu
|-
|5 ||grouplist ||Grouplist template for the settings section
|-
|6 ||textbox ||Settings description
|-
|7 ||button ||Button template
|-
|8 ||radiobutton ||Radiobutton template
|-
|9 ||spincontrolex ||Spincontrolex template
|-
|10 ||button ||Button template for the menu
|-
|11 ||image ||Default separator image
|-
|12 ||edit ||Edit control template
|-
|13 ||sliderex ||Sliderex control template
|-
|14 ||label ||label template
|-
|20 ||button ||Setting level button
|}

=== SettingsProfile.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||container ||List of available profiles
|-
|4 ||button ||Enable the loginscreen
|-
|5 ||button ||Auto login
|}

=== SettingsScreenCalibration.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Coordinates label
|-
|3 ||label ||Help information
|-
|8 ||mover ||Top left mover
|-
|9 ||mover ||Right bottom mover
|-
|10 ||mover ||Subtitle position mover
|-
|11 ||resize ||Pixel aspect ratio box
|-
|20 ||videowindow ||currently playing video
|}

=== SlideShow.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|10 ||label ||Error loading image message
|-
|13 ||[any] ||These controls are visible when the slideshow is paused
|}

=== SettingsSystemInfo.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 – 11 ||label ||Line 2 – Line 11
|-
|30 ||textbox ||privacy-policy text
|-
|40 ||label ||System information category label
|-
|52 ||label ||Kodi build label
|-
|53 ||label || Kodi build date label
|-
|94 ||button ||Show storage information
|-
|95 ||button ||Show summary information
|-
|96 ||button ||Show network information
|-
|97 ||button ||Show video information
|-
|98 ||button ||Show hardware information
|-
|99 ||button ||Show PVR information
|-
|100 ||button ||Show privacy-policy
|}

=== SmartPlaylistEditor.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||label ||Heading label
|-
|10 ||container ||List of playlist rules
|-
|12 ||button ||Name of the playlist
|-
|13 ||button ||Add a rule
|-
|14 ||button ||Remove a rule
|-
|15 ||button ||Edit a rule
|-
|16 ||button ||Match rules option (match all rules / match one or more rules)
|-
|17 ||button ||Limit rules option (number of results: 10, 25, 50, 100, etc... items)
|-
|18 ||button ||Sort rules option (order the results by: title, genre, random, etc...)
|-
|19 ||button ||Sort direction option (ascending / descending)
|-
|20 ||button ||OK button
|-
|21 ||button ||Cancel button
|-
|22 ||button ||Set Playlist type (movies, episodes, mixed, etc...)
|-
|23 ||button ||Group by
|-
|24 ||radiobutton ||Mixed
|}

=== SmartPlaylistRule.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|15 ||button ||Select field (director, duration, video resolution, etc...)
|-
|16 ||button ||Select operator (is, is not, less than, etc...)
|-
|17 ||edit ||Enter a value the rule should match
|-
|18 ||button ||OK button
|-
|19 ||button ||Cancel button
|-
|20 ||button ||Browse button
|}

=== VideoFullScreen.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|1 ||label ||Numpad seek label
|-
|10 ||label ||Line 1
|-
|11 ||label ||Line 2
|-
|12 ||label ||Line 3
|}

=== VideoOSDBookmarks.xml ===
{| class="prettytable" width="100%"
! width="50" | ID !! width="150" | Type !! Description
|-
|2 ||button ||Add a video bookmark
|-
|3 ||button ||Clear all bookmarks
|-
|4 ||button ||Use the currently selected video bookmark as the episode thumbnail
|-
|11 ||container ||List of available bookmarks
|}

<section end="main content" />

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

[[Category:Skin development]]

Archive:JSON-RPC API/v9

2020-03-15T22:38:53Z

DaveBlake: Warning not to use this page. IMO it should be deleted because an incomplete reference is worse than none, and JSON API is self documenting

{{mininav|[[Development]]|[[JSON-RPC API]]}}

{{notice|This page is a partially edited copy ob the v8 API (Krypton) and seriously incomplete. It should not be relied upon as a reference. The API version of Kodi v18, a.k.a. Leia is v10 but no web version has been created}}

{{cleanup}}

Version 10 is the stable version of Kodi's JSON-RPC API and is published with the release of v18 (Leia).

It comes with support for [http://en.wikipedia.org/wiki/WebSocket WebSockets] as an alternative transport for third party clients. Using WebSockets will allow webinterfaces (which are currently restricted to the HTTP transport only) to get access to a bidirectional transport with Kodi's JSON-RPC API and can therefore also profit from additional features like notifications.

{{TOC right}}
== JSON-RPC 2.0 compatibility ==
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; width: 7em; text-align: left;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests
|-
|style="padding-left: 5px;"|Version 6
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|}

== Documentation (JSON Schema) ==
=== Supported features of JSON Schema ===
<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema
!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 type]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2 properties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3 patternProperties]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4 additionalProperties]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5 items]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6 additionalItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7 required]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.8 dependencies]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.9 minimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.10 maximum]
|{{yes}}
|-
|}
</div>

<div style="float:left; margin-right:2em">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03

|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.11 exclusiveMinimum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.12 exclusiveMaximum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.13 minItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.14 maxItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.15 uniqueItems]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.16 pattern]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.17 minLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.18 maxLength]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19 enum]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.20 default]
|{{yes}}
|-
|}
</div>

<div style="float:left;">
{| class="prettytable" style="margin-right: 0;"
!style="width: 10em; text-align: left;"|Schema

!style="padding-left: 10px; padding-right: 10px;"|IETF Draft 03
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21 title]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22 description]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 format]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.24 divisibleBy]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.25 disallow]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26 extends]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.27 id]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.28 $ref]
|{{yes}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.29 $schema]
|{{no}}
|-
|[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-6 Hyper Schema]
|{{no}}
|-
|}
</div>
<div style="clear:left;"></div>

== Error message ==
If Kodi detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
{|
|
<syntaxhighlight lang=json enclose="div">
{
"type": "object",
"properties": {
"code": { "type": "integer", "required": true },
"message": { "type": "string", "required": true },
"data": { "type": "object",
"properties": {
"method": { "type": "string", "required": true },
"stack": { "type": "object", "id": "Error.Stack",
"properties": {
"name": { "type": "string", "required": true },
"type": { "type": "string", "required": true },
"message": { "type": "string", "required": true },
"property": { "$ref": "Error.Stack" }
}
}
}
}
}
}
</syntaxhighlight>
|}

== Namespaces ==
The Kodi JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
{|
|
<pre>
Addons List, enable and execute addons
Application Application information and control
AudioLibrary Audio Library information
Favourites Favourites GetFavourites and AddFavourite
Files Shares information & filesystem listings
GUI Window properties and activation
Input Allows limited navigation within Kodi
JSONRPC A variety of standard JSONRPC calls
Player Manages all available players
Playlist Playlist modification
Profiles Support for Profiles operations to xbmc.
PVR Live TV control
Settings Allows manipulation of Kodi settings.
System System controls and information
Textures Supplies GetTextures and RemoveTexture. Textures are images.
VideoLibrary Video Library information
XBMC Dumping ground for very Kodi specific operations
</pre>
|}

== Methods ==
=== Addons ===
==== Addons.ExecuteAddon ====
Executes the given addon with the given parameters (if possible)<br />
'''Permissions:'''
* ExecuteAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''mixed: object|array|string'' params ]
# [ ''boolean'' wait = false ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Executes the given addon with the given parameters (if possible)",
"permission": "ExecuteAddon",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"default": "",
"type": [
{
"additionalProperties": {
"default": "",
"type": "string"
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"description": "URL path (must start with / or ?",
"type": "string"
}
],
"name": "params"
},
{
"default": "false",
"type": "boolean",
"name": "wait"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Addons.GetAddonDetails ====
Gets the details of a specific addon<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Addon.Details|Addon.Details]]'' addon
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Gets the details of a specific addon",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"$ref": "Addon.Fields",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"addon": {
"$ref": "Addon.Details",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Addons.GetAddons ====
Gets all available addons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Addon.Types|Addon.Types]]'' type = "unknown" ]
# [ ''[[#Addon.Content|Addon.Content]]'' content = "unknown" ] ''Content provided by the addon. Only considered for plugins and scripts.''
# [ ''mixed: boolean|string'' enabled = "all" ]
# [ ''[[#Addon.Fields|Addon.Fields]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''mixed: boolean|string'' installed = true ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Addon.Details|Addon.Details]]''[] addons ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Gets all available addons",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "unknown",
"$ref": "Addon.Types",
"name": "type"
},
{
"default": "unknown",
"description": "Content provided by the addon. Only considered for plugins and scripts.",
"$ref": "Addon.Content",
"name": "content"
},
{
"default": "all",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"name": "enabled"
},
{
"$ref": "Addon.Fields",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"default": "true",
"type": [
{
"type": "boolean"
},
{
"enums": [
"all"
],
"type": "string"
}
],
"name": "installed"
}
],
"returns": {
"type": "object",
"properties": {
"addons": {
"items": {
"$ref": "Addon.Details"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Addons.SetAddonEnabled ====
Enables/Disables a specific addon<br />
'''Permissions:'''
* ManageAddon
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' addonid
# ''[[#Global.Toggle|Global.Toggle]]'' enabled
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Enables/Disables a specific addon",
"permission": "ManageAddon",
"type": "method",
"params": [
{
"type": "string",
"name": "addonid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "enabled",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Application ===
==== Application.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Application.Property.Name|Application.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Application.Property.Value|Application.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "Application.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Application.Property.Value"
}
}</syntaxhighlight>}}

==== Application.Quit ====
Quit application<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Quit application",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Application.SetMute ====
Toggle mute/unmute<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' mute
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />

'''Description:''' ''Mute state''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Toggle mute/unmute",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Global.Toggle",
"name": "mute",
"required": true
}
],
"returns": {
"type": "boolean",
"description": "Mute state"
}
}</syntaxhighlight>}}

==== Application.SetVolume ====
Set the current volume<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''mixed'' volume
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''integer''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Set the current volume",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"type": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
],
"name": "volume",
"required": true
}
],
"returns": {
"type": "integer"
}
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.Clean ====
Cleans the audio library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Cleans the audio library from non-existent items",
"permission": "RemoveData",
"type": "method",
"params": [
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.Export ====
Exports all items from the audio library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed: object|object'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Exports all items from the audio library",
"permission": "WriteFile",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
],
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbumDetails ====
Retrieve details about a specific album<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]'' albumdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific album",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Audio.Fields.Album",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"albumdetails": {
"$ref": "Audio.Details.Album"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetAlbums ====
Retrieve all albums from specified artist (and role) or that has songs of the specified genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = false ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all albums from specified artist (and role) or that has songs of the specified genre",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Albums"
}
],
"name": "filter"
},
{
"default": "false",
"type": "boolean",
"name": "includesingles"
},
{
"default": "false",
"description": "Whether or not to include all roles when filtering by artist, rather than the default of excluding other contributions. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtistDetails ====
Retrieve details about a specific artist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]'' artistdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific artist",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"artistdetails": {
"$ref": "Audio.Details.Artist"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetArtists ====
Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Optional.Boolean|Optional.Boolean]]'' albumartistsonly ] ''Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used''
# [ ''[[#Audio.Fields.Artist|Audio.Fields.Artist]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Artist|Audio.Details.Artist]]''[] artists ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all artists. For backward compatibility by default this implicity does not include those that only contribute other roles, however absolutely all artists can be returned using allroles=true",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "Whether or not to only include album artists rather than the artists of only individual songs as well. If the parameter is not passed or is passed as null the GUI setting will be used",
"$ref": "Optional.Boolean",
"name": "albumartistsonly"
},
{
"$ref": "Audio.Fields.Artist",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Deprecated, use songgenreid. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenreid": {
"$ref": "Library.Id",
"description": "Song genreid. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Deprecated, use songgenre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songgenre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songgenre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"required": true
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"minLength": 1,
"required": true,
"type": "string"
},
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"roleid": {
"$ref": "Library.Id",
"description": "Role contributed by artist. Overriden by allroles parameter",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"role": {
"description": "Role contributed by artist. Overriden by allroles parameter",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Artists"
}
],
"name": "filter"
},
{
"default": "false",
"description": "Whether or not to include all artists irrespective of the role they contributed. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"artists": {
"items": {
"$ref": "Audio.Details.Artist"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all genres",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetProperties ====
Retrieves the values of the music library properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Audio.Property.Name|Audio.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Audio.Property.Value|Audio.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the music library properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "Audio.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Audio.Property.Value"
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedAlbums ====
Retrieve recently added albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve recently added albums",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyAddedSongs ====
Retrieve recently added songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#List.Amount|List.Amount]]'' albumlimit = "-1" ] ''The amount of recently added albums from which to return the songs''
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve recently added songs",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"description": "The amount of recently added albums from which to return the songs",
"$ref": "List.Amount",
"name": "albumlimit"
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedAlbums ====
Retrieve recently played albums<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Album|Audio.Fields.Album]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Album|Audio.Details.Album]]''[] albums ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve recently played albums",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Album",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"albums": {
"items": {
"$ref": "Audio.Details.Album"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRecentlyPlayedSongs ====
Retrieve recently played songs<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve recently played songs",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetRoles ====
Retrieve all contributor roles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Role|Audio.Fields.Role]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Audio.Details.Role|Audio.Details.Role]]''[] roles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all contributor roles",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Role",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"roles": {
"items": {
"$ref": "Audio.Details.Role"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongDetails ====
Retrieve details about a specific song<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]'' songdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific song",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Audio.Fields.Song",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"songdetails": {
"$ref": "Audio.Details.Song"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.GetSongs ====
Retrieve all songs from specified album, artist or genre<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
# [ ''boolean'' includesingles = true ]
# [ ''boolean'' allroles = false ] ''Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Audio.Details.Song|Audio.Details.Song]]''[] songs ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all songs from specified album, artist or genre",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Audio.Fields.Song",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Song genre. Filter for existance of songs with this genre",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Song genre. Filter for existance of songs with this genre",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
},
"role": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"album": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Songs"
}
],
"name": "filter"
},
{
"default": "true",
"type": "boolean",
"name": "includesingles"
},
{
"default": "false",
"description": "Whether or not to include all roles when filtering by artist, rather than default of excluding other contributors. When true it overrides any role filter value.",
"type": "boolean",
"name": "allroles"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"songs": {
"items": {
"$ref": "Audio.Details.Song"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== AudioLibrary.Scan ====
Scans the audio sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Scans the audio sources for new library items",
"permission": "UpdateData",
"type": "method",
"params": [
{
"default": "",
"type": "string",
"name": "directory"
},
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetAlbumDetails ====
Update the given album with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' albumid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''mixed'' theme ]
# [ ''mixed'' mood ]
# [ ''mixed'' style ]
# [ ''[[#Optional.String|Optional.String]]'' type ]
# [ ''[[#Optional.String|Optional.String]]'' albumlabel ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given album with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"$ref": "Optional.String",
"name": "description"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "theme"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "mood"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "style"
},
{
"$ref": "Optional.String",
"name": "type"
},
{
"$ref": "Optional.String",
"name": "albumlabel"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"name": "votes"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetArtistDetails ====
Update the given artist with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' artistid
# [ ''[[#Optional.String|Optional.String]]'' artist ]
# [ ''mixed'' instrument ]
# [ ''mixed'' style ]
# [ ''mixed'' mood ]
# [ ''[[#Optional.String|Optional.String]]'' born ]
# [ ''[[#Optional.String|Optional.String]]'' formed ]
# [ ''[[#Optional.String|Optional.String]]'' description ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.String|Optional.String]]'' died ]
# [ ''[[#Optional.String|Optional.String]]'' disbanded ]
# [ ''mixed'' yearsactive ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given artist with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
{
"$ref": "Optional.String",
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "instrument"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "style"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "mood"
},
{
"$ref": "Optional.String",
"name": "born"
},
{
"$ref": "Optional.String",
"name": "formed"
},
{
"$ref": "Optional.String",
"name": "description"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.String",
"name": "died"
},
{
"$ref": "Optional.String",
"name": "disbanded"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "yearsactive"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== AudioLibrary.SetSongDetails ====
Update the given song with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' songid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' artist ]
# [ ''mixed'' albumartist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' disc ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' duration ]
# [ ''[[#Optional.String|Optional.String]]'' comment ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainztrackid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzartistid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumid ]
# [ ''[[#Optional.String|Optional.String]]'' musicbrainzalbumartistid ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' votes ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given song with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "songid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "albumartist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "album"
},
{
"$ref": "Optional.Integer",
"name": "track"
},
{
"$ref": "Optional.Integer",
"name": "disc"
},
{
"$ref": "Optional.Integer",
"name": "duration"
},
{
"$ref": "Optional.String",
"name": "comment"
},
{
"$ref": "Optional.String",
"name": "musicbrainztrackid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzartistid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumid"
},
{
"$ref": "Optional.String",
"name": "musicbrainzalbumartistid"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.Integer",
"name": "votes"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Favourites ===
==== Favourites.AddFavourite ====
Add a favourite with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''[[#Favourite.Type|Favourite.Type]]'' type
# [ ''[[#Optional.String|Optional.String]]'' path ] ''Required for media and script favourites types''
# [ ''[[#Optional.String|Optional.String]]'' window ] ''Required for window favourite type''
# [ ''[[#Optional.String|Optional.String]]'' windowparameter ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Add a favourite with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"type": "string",
"name": "title",
"required": true
},
{
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
{
"description": "Required for media and script favourites types",
"$ref": "Optional.String",
"name": "path"
},
{
"description": "Required for window favourite type",
"$ref": "Optional.String",
"name": "window"
},
{
"$ref": "Optional.String",
"name": "windowparameter"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Favourites.GetFavourites ====
Retrieve all favourites<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' type ]
# [ ''[[#Favourite.Fields.Favourite|Favourite.Fields.Favourite]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Favourite.Details.Favourite|Favourite.Details.Favourite]]''[] favourites ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all favourites",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": [
{
"type": "null"
},
{
"$ref": "Favourite.Type"
}
],
"name": "type"
},
{
"$ref": "Favourite.Fields.Favourite",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"favourites": {
"items": {
"$ref": "Favourite.Details.Favourite"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

=== Files ===
==== Files.GetDirectory ====
Get the directories and files in the given directory<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' directory
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''[[#List.Limits|List.Limits]]'' limits ] ''Limits are applied after getting the directory content thus retrieval is not faster when they are applied.''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]''[] files
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Get the directories and files in the given directory",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "directory",
"required": true
},
{
"default": "files",
"$ref": "Files.Media",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"description": "Limits are applied after getting the directory content thus retrieval is not faster when they are applied.",
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"files": {
"items": {
"$ref": "List.Item.File"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.GetFileDetails ====
Get details for a specific file<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file ''Full path to the file''
# [ ''[[#Files.Media|Files.Media]]'' media = "files" ]
# [ ''[[#List.Fields.Files|List.Fields.Files]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.File|List.Item.File]]'' filedetails
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Get details for a specific file",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "Full path to the file",
"type": "string",
"name": "file",
"required": true
},
{
"default": "files",
"$ref": "Files.Media",
"name": "media"
},
{
"$ref": "List.Fields.Files",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"filedetails": {
"$ref": "List.Item.File",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.GetSources ====
Get the sources of the media windows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Files.Media|Files.Media]]'' media
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#List.Items.Sources|List.Items.Sources]]'' sources
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Get the sources of the media windows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sources": {
"$ref": "List.Items.Sources",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.PrepareDownload ====
Provides a way to download a given file (e.g. providing an URL to the real file location)<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' path
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''mixed'' ''Transport specific details on how/from where to download the given file''details
* ''string'' ''Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol''mode
* ''string'' protocol
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Provides a way to download a given file (e.g. providing an URL to the real file location)",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "path",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"details": {
"description": "Transport specific details on how/from where to download the given file",
"type": "any",
"required": true
},
"mode": {
"description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol",
"type": "string",
"required": true
},
"protocol": {
"type": "string",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Files.SetFileDetails ====
Update the given specific file with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' file ''Full path to the file''
# ''[[#Files.Media|Files.Media]]'' media ''File type to update correct database. Currently only "video" is supported.''
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ] ''Setting a valid lastplayed without a playcount will force playcount to 1.''
# [ ''mixed'' resume ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given specific file with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"description": "Full path to the file",
"type": "string",
"name": "file",
"required": true
},
{
"description": "File type to update correct database. Currently only \"video\" is supported.",
"$ref": "Files.Media",
"name": "media",
"required": true
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Setting a valid lastplayed without a playcount will force playcount to 1.",
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== GUI ===
==== GUI.ActivateWindow ====
Activates the given window<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Window|GUI.Window]]'' window
# [ ''string''[] parameters ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Activates the given window",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"$ref": "GUI.Window",
"name": "window",
"required": true
},
{
"items": {
"type": "string"
},
"type": "array",
"name": "parameters"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#GUI.Property.Name|GUI.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#GUI.Property.Value|GUI.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "GUI.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "GUI.Property.Value"
}
}</syntaxhighlight>}}

==== GUI.GetStereoscopicModes ====
Returns the supported stereoscopic modes of the GUI<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]''[] stereoscopicmodes ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Returns the supported stereoscopic modes of the GUI",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"stereoscopicmodes": {
"items": {
"$ref": "GUI.Stereoscopy.Mode"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== GUI.SetFullscreen ====
Toggle fullscreen/GUI<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Global.Toggle|Global.Toggle]]'' fullscreen
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />

'''Description:''' ''Fullscreen state''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Toggle fullscreen/GUI",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"$ref": "Global.Toggle",
"name": "fullscreen",
"required": true
}
],
"returns": {
"type": "boolean",
"description": "Fullscreen state"
}
}</syntaxhighlight>}}

==== GUI.SetStereoscopicMode ====
Sets the stereoscopic mode of the GUI to the given mode<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' mode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Sets the stereoscopic mode of the GUI to the given mode",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"type": "string",
"name": "mode",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== GUI.ShowNotification ====
Shows a GUI notification<br />
'''Permissions:'''
* ControlGUI
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' title
# ''string'' message
# [ ''mixed: string|string'' image ]
# [ ''integer'' displaytime = "5000" ] ''The time in milliseconds the notification will be visible''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Shows a GUI notification",
"permission": "ControlGUI",
"type": "method",
"params": [
{
"type": "string",
"name": "title",
"required": true
},
{
"type": "string",
"name": "message",
"required": true
},
{
"default": "",
"type": [
{
"enums": [
"info",
"warning",
"error"
],
"type": "string"
},
{
"type": "string"
}
],
"name": "image"
},
{
"default": "5000",
"description": "The time in milliseconds the notification will be visible",
"type": "integer",
"name": "displaytime"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Input ===
==== Input.Back ====
Goes back in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Goes back in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ContextMenu ====
Shows the context menu<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Shows the context menu",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Down ====
Navigate down in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Navigate down in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ExecuteAction ====
Execute a specific action<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Input.Action|Input.Action]]'' action
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Execute a specific action",
"permission": "Navigate",
"type": "method",
"params": [
{
"$ref": "Input.Action",
"name": "action",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Home ====
Goes to home window in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Goes to home window in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Info ====
Shows the information dialog<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Shows the information dialog",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Left ====
Navigate left in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Navigate left in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Right ====
Navigate right in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Navigate right in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Select ====
Select current item in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Select current item in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.SendText ====
Send a generic (unicode) text<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' text ''Unicode text''
# [ ''boolean'' done = true ] ''Whether this is the whole input or not (closes an open input dialog if true).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Send a generic (unicode) text",
"permission": "Navigate",
"type": "method",
"params": [
{
"description": "Unicode text",
"type": "string",
"name": "text",
"required": true
},
{
"default": "true",
"description": "Whether this is the whole input or not (closes an open input dialog if true).",
"type": "boolean",
"name": "done"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowCodec ====
Show codec information of the playing item<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Show codec information of the playing item",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowOSD ====
Show the on-screen display for the current player<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Show the on-screen display for the current player",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.ShowPlayerProcessInfo ====
Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Show player process information of the playing item, like video decoder, pixel format, pvr signal strength, ...",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Input.Up ====
Navigate up in GUI<br />
'''Permissions:'''
* Navigate
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Navigate up in GUI",
"permission": "Navigate",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== JSONRPC ===
==== JSONRPC.Introspect ====
Enumerates all actions and descriptions<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' getdescriptions = true ]
# [ ''boolean'' getmetadata = false ]
# [ ''boolean'' filterbytransport = true ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Enumerates all actions and descriptions",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "true",
"type": "boolean",
"name": "getdescriptions"
},
{
"default": "false",
"type": "boolean",
"name": "getmetadata"
},
{
"default": "true",
"type": "boolean",
"name": "filterbytransport"
},
{
"type": "object",
"name": "filter"
}
],
"returns": {
"type": "object",
"additionalProperties": false
}
}</syntaxhighlight>}}

==== JSONRPC.NotifyAll ====
Notify all other connected clients<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''string'' message
# [ ''mixed'' data ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''any''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Notify all other connected clients",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "string",
"name": "message",
"required": true
},
{
"type": "any",
"name": "data"
}
],
"returns": {
"type": "any"
}
}</syntaxhighlight>}}

==== JSONRPC.Permission ====
Retrieve the clients permissions<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''boolean'' controlgui
* ''boolean'' controlnotify
* ''boolean'' controlplayback
* ''boolean'' controlpower
* ''boolean'' controlpvr
* ''boolean'' controlsystem
* ''boolean'' executeaddon
* ''boolean'' manageaddon
* ''boolean'' navigate
* ''boolean'' readdata
* ''boolean'' removedata
* ''boolean'' updatedata
* ''boolean'' writefile
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve the clients permissions",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"controlgui": {
"type": "boolean",
"required": true
},
"controlnotify": {
"type": "boolean",
"required": true
},
"controlplayback": {
"type": "boolean",
"required": true
},
"controlpower": {
"type": "boolean",
"required": true
},
"controlpvr": {
"type": "boolean",
"required": true
},
"controlsystem": {
"type": "boolean",
"required": true
},
"executeaddon": {
"type": "boolean",
"required": true
},
"manageaddon": {
"type": "boolean",
"required": true
},
"navigate": {
"type": "boolean",
"required": true
},
"readdata": {
"type": "boolean",
"required": true
},
"removedata": {
"type": "boolean",
"required": true
},
"updatedata": {
"type": "boolean",
"required": true
},
"writefile": {
"type": "boolean",
"required": true
}
}
}
}</syntaxhighlight>}}

==== JSONRPC.Ping ====
Ping responder<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Ping responder",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== JSONRPC.Version ====
Retrieve the JSON-RPC protocol version.<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''mixed'' version
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve the JSON-RPC protocol version.",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "object",
"properties": {
"version": {
"type": "object",
"required": true
}
}
}
}</syntaxhighlight>}}

=== Player ===
==== Player.GetActivePlayers ====
Returns all active players<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Returns all active players",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetItem ====
Retrieves the currently played item<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]'' item
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the currently played item",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"item": {
"$ref": "List.Item.All",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Player.GetPlayers ====
Get a list of available players<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' media = "all" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Get a list of available players",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "all",
"type": "string",
"name": "media"
}
],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Player.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Player.Property.Name|Player.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Property.Value|Player.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"items": {
"$ref": "Player.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Player.Property.Value"
}
}</syntaxhighlight>}}

==== Player.GoTo ====
Go to previous/next/specific item in the playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' to
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Go to previous/next/specific item in the playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"$ref": "Playlist.Position",
"description": "position in playlist"
}
],
"name": "to",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Move ====
If picture is zoomed move viewport left/right/up/down otherwise skip previous/next<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''string'' direction
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "If picture is zoomed move viewport left/right/up/down otherwise skip previous/next",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": "string",
"name": "direction",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Open ====
Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed'' item ]
# [ ''mixed'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database.",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"default": 0
}
},
"type": "object"
},
{
"$ref": "Playlist.Item"
},
{
"additionalProperties": false,
"properties": {
"path": {
"required": true,
"type": "string"
},
"random": {
"default": true,
"description": "Deprecated, use the shuffled property of the options parameter instead",
"type": "boolean"
},
"recursive": {
"default": true,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"partymode": {
"default": "",
"type": [
{
"enums": [
"music",
"video"
],
"type": "string"
},
{
"description": "Path to a smartplaylist (*.xsp) file",
"minLength": 5,
"type": "string"
}
]
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channelid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"recordingid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
],
"name": "item"
},
{
"type": "object",
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.PlayPause ====
Pauses or unpause playback and returns the new state<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''[[#Global.Toggle|Global.Toggle]]'' play = "toggle" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Pauses or unpause playback and returns the new state",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "toggle",
"$ref": "Global.Toggle",
"name": "play"
}
],
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.Rotate ====
Rotates current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# [ ''string'' value = "clockwise" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Rotates current picture",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"default": "clockwise",
"type": "string",
"name": "value"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Seek ====
Seek through the playing item<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' = "0"percentage ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Seek through the playing item",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to"
},
{
"$ref": "Player.Position.Time",
"description": "Time to seek to"
},
{
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"percentage": {
"$ref": "Player.Position.Percentage",
"description": "Percentage value to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"time": {
"$ref": "Player.Position.Time",
"description": "Time to seek to",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"step": {
"description": "Seek by predefined jumps",
"enums": [
"smallforward",
"smallbackward",
"bigforward",
"bigbackward"
],
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"seconds": {
"description": "Seek by the given number of seconds",
"required": true,
"type": "integer"
}
},
"type": "object"
}
],
"name": "value",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage"
},
"time": {
"$ref": "Global.Time"
},
"totaltime": {
"$ref": "Global.Time"
}
}
}
}</syntaxhighlight>}}

==== Player.SetAudioStream ====
Set the audio stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Set the audio stream played by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the audio stream to play",
"minimum": 0,
"type": "integer"
}
],
"name": "stream",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetPartymode ====
Turn partymode on or off<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' partymode
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Turn partymode on or off",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "partymode",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetRepeat ====
Set the repeat mode of the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' repeat
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Set the repeat mode of the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"$ref": "Player.Repeat"
},
{
"enums": [
"cycle"
],
"type": "string"
}
],
"name": "repeat",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetShuffle ====
Shuffle/Unshuffle items in the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''[[#Global.Toggle|Global.Toggle]]'' shuffle
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Shuffle/Unshuffle items in the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"$ref": "Global.Toggle",
"name": "shuffle",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetSpeed ====
Set the speed of the current playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed'' speed
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Player.Speed|Player.Speed]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Set the speed of the current playback",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
-32,
-16,
-8,
-4,
-2,
-1,
0,
1,
2,
4,
8,
16,
32
],
"type": "integer"
},
{
"$ref": "Global.IncrementDecrement"
}
],
"name": "speed",
"required": true
}
],
"returns": {
"$ref": "Player.Speed"
}
}</syntaxhighlight>}}

==== Player.SetSubtitle ====
Set the subtitle displayed by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' subtitle
# [ ''boolean'' enable = false ] ''Whether to enable subtitles to be displayed after setting the new subtitle''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Set the subtitle displayed by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next",
"off",
"on"
],
"type": "string"
},
{
"description": "Index of the subtitle to display",
"minimum": 0,
"type": "integer"
}
],
"name": "subtitle",
"required": true
},
{
"default": "false",
"description": "Whether to enable subtitles to be displayed after setting the new subtitle",
"type": "boolean",
"name": "enable"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.SetVideoStream ====
Set the video stream played by the player<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' stream
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Set the video stream played by the player",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"previous",
"next"
],
"type": "string"
},
{
"description": "Index of the video stream to play",
"minimum": 0,
"type": "integer"
}
],
"name": "stream",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Stop ====
Stops playback<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Stops playback",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Player.Zoom ====
Zoom current picture<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Player.Id|Player.Id]]'' playerid
# ''mixed: string|integer'' zoom
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Zoom current picture",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
{
"type": [
{
"enums": [
"in",
"out"
],
"type": "string"
},
{
"description": "zoom level",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
],
"name": "zoom",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Add ====
Add item(s) to playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Add item(s) to playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
],
"name": "item",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Clear ====
Clear playlist<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Clear playlist",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.GetItems ====
Get all items from playlist<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# [ ''[[#List.Fields.All|List.Fields.All]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.Item.All|List.Item.All]]''[] items
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Get all items from playlist",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "List.Fields.All",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "List.Item.All"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Playlist.GetPlaylists ====
Returns all existing playlists<br />
'''Permissions:'''
* ReadData
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''array''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Returns all existing playlists",
"permission": "ReadData",
"type": "method",
"params": [],
"returns": {
"type": "array"
}
}</syntaxhighlight>}}

==== Playlist.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Property.Name|Playlist.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Playlist.Property.Value|Playlist.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"items": {
"$ref": "Playlist.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "Playlist.Property.Value"
}
}</syntaxhighlight>}}

==== Playlist.Insert ====
Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
# ''mixed'' item
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Insert item(s) into playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
},
{
"type": [
{
"$ref": "Playlist.Item"
},
{
"items": {
"$ref": "Playlist.Item"
},
"type": "array"
}
],
"name": "item",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Remove ====
Remove item from playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Remove item from playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Playlist.Swap ====
Swap items in the playlist. Does not work for picture playlists (aka slideshows).<br />
'''Permissions:'''
* ControlPlayback
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Playlist.Id|Playlist.Id]]'' playlistid
# ''[[#Playlist.Position|Playlist.Position]]'' position1
# ''[[#Playlist.Position|Playlist.Position]]'' position2
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Swap items in the playlist. Does not work for picture playlists (aka slideshows).",
"permission": "ControlPlayback",
"type": "method",
"params": [
{
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position1",
"required": true
},
{
"$ref": "Playlist.Position",
"name": "position2",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.GetCurrentProfile ====
Retrieve the current profile<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve the current profile",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
}
],
"returns": {
"$ref": "Profiles.Details.Profile"
}
}</syntaxhighlight>}}

==== Profiles.GetProfiles ====
Retrieve all profiles<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Profiles.Fields.Profile|Profiles.Fields.Profile]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Profiles.Details.Profile|Profiles.Details.Profile]]''[] profiles
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all profiles",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Profiles.Fields.Profile",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"profiles": {
"items": {
"$ref": "Profiles.Details.Profile"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Profiles.LoadProfile ====
Load the specified profile<br />
'''Permissions:'''
* Navigate
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' profile ''Profile name''
# [ ''boolean'' prompt = false ] ''Prompt for password''
# [ ''[[#Profiles.Password|Profiles.Password]]'' password ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Load the specified profile",
"permission": "Navigate",
"type": "method",
"params": [
{
"description": "Profile name",
"type": "string",
"name": "profile",
"required": true
},
{
"default": "false",
"description": "Prompt for password",
"type": "boolean",
"name": "prompt"
},
{
"$ref": "Profiles.Password",
"name": "password"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== PVR ===
==== PVR.AddTimer ====
Adds a timer to record the given show one times or a timer rule to record all showings of the given show<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid ''the broadcast id of the item to record''
# [ ''boolean'' timerrule = false ] ''controls whether to create a timer rule or a onetime timer''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Adds a timer to record the given show one times or a timer rule to record all showings of the given show",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the broadcast id of the item to record",
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"default": "false",
"description": "controls whether to create a timer rule or a onetime timer",
"type": "boolean",
"name": "timerrule"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.DeleteTimer ====
Deletes a onetime timer or a timer rule<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid ''the id of the onetime timer or timer rule to delete''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Deletes a onetime timer or a timer rule",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the id of the onetime timer or timer rule to delete",
"$ref": "Library.Id",
"name": "timerid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.GetBroadcastDetails ====
Retrieves the details of a specific broadcast<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the details of a specific broadcast",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"broadcastdetails": {
"$ref": "PVR.Details.Broadcast"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetBroadcasts ====
Retrieves the program of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Broadcast|PVR.Fields.Broadcast]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]''[] broadcasts
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the program of a specific channel",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Broadcast",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"broadcasts": {
"items": {
"$ref": "PVR.Details.Broadcast"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelDetails ====
Retrieves the details of a specific channel<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' channelid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]'' channeldetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the details of a specific channel",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"channeldetails": {
"$ref": "PVR.Details.Channel"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroupDetails ====
Retrieves the details of a specific channel group<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''mixed'' channels ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.ChannelGroup.Extended|PVR.Details.ChannelGroup.Extended]]'' channelgroupdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the details of a specific channel group",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"type": "object",
"name": "channels"
}
],
"returns": {
"type": "object",
"properties": {
"channelgroupdetails": {
"$ref": "PVR.Details.ChannelGroup.Extended"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannelGroups ====
Retrieves the channel groups for the specified type<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''[] channelgroups
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the channel groups for the specified type",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"channelgroups": {
"items": {
"$ref": "PVR.Details.ChannelGroup"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetChannels ====
Retrieves the channel list<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.ChannelGroup.Id|PVR.ChannelGroup.Id]]'' channelgroupid
# [ ''[[#PVR.Fields.Channel|PVR.Fields.Channel]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the channel list",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.ChannelGroup.Id",
"name": "channelgroupid",
"required": true
},
{
"$ref": "PVR.Fields.Channel",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#PVR.Property.Name|PVR.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#PVR.Property.Value|PVR.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "PVR.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "PVR.Property.Value"
}
}</syntaxhighlight>}}

==== PVR.GetRecordingDetails ====
Retrieves the details of a specific recording<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' recordingid
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Recording|PVR.Details.Recording]]'' recordingdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the details of a specific recording",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"recordingdetails": {
"$ref": "PVR.Details.Recording"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetRecordings ====
Retrieves the recordings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Recording|PVR.Fields.Recording]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Recording|PVR.Details.Recording]]''[] recordings
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the recordings",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Fields.Recording",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"recordings": {
"items": {
"$ref": "PVR.Details.Recording"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.GetTimerDetails ====
Retrieves the details of a specific timer<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' timerid
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#PVR.Details.Timer|PVR.Details.Timer]]'' timerdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the details of a specific timer",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"timerdetails": {
"$ref": "PVR.Details.Timer"
}
}
}
}</syntaxhighlight>}}

==== PVR.GetTimers ====
Retrieves the timers<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#PVR.Fields.Timer|PVR.Fields.Timer]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#PVR.Details.Timer|PVR.Details.Timer]]''[] timers
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the timers",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "PVR.Fields.Timer",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"timers": {
"items": {
"$ref": "PVR.Details.Timer"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== PVR.Record ====
Toggle recording of a channel<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Global.Toggle|Global.Toggle]]'' record = "toggle" ]
# [ ''mixed'' channel = "current" ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Toggle recording of a channel",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"default": "toggle",
"$ref": "Global.Toggle",
"name": "record"
},
{
"default": "current",
"type": [
{
"enums": [
"current"
],
"type": "string"
},
{
"$ref": "Library.Id"
}
],
"name": "channel"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Scan ====
Starts a channel scan<br />
'''Permissions:'''
* ControlPVR
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Starts a channel scan",
"permission": "ControlPVR",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.ToggleTimer ====
Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created<br />
'''Permissions:'''
* ControlPVR
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' broadcastid ''the broadcast id of the item to toggle a onetime timer or time rule for''
# [ ''boolean'' timerrule = false ] ''controls whether to create / delete a timer rule or a onetime timer''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Creates or deletes a onetime timer or timer rule for a given show. If it exists, it will be deleted. If it does not exist, it will be created",
"permission": "ControlPVR",
"type": "method",
"params": [
{
"description": "the broadcast id of the item to toggle a onetime timer or time rule for",
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
{
"default": "false",
"description": "controls whether to create / delete a timer rule or a onetime timer",
"type": "boolean",
"name": "timerrule"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Settings ===
==== Settings.GetCategories ====
Retrieves all setting categories<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''string'' section ]
# [ ''mixed'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves all setting categories",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"default": "",
"type": "string",
"name": "section"
},
{
"items": {
"type": "string"
},
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSections ====
Retrieves all setting sections<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Section|Setting.Details.Section]]''[] sections ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves all setting sections",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"items": {
"type": "string"
},
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"sections": {
"items": {
"$ref": "Setting.Details.Section"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSettings ====
Retrieves all settings<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Setting.Level|Setting.Level]]'' level = "standard" ]
# [ ''mixed: object'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves all settings",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "standard",
"$ref": "Setting.Level",
"name": "level"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"category": {
"minLength": 1,
"required": true,
"type": "string"
},
"section": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== Settings.GetSettingValue ====
Retrieves the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
}
],
"returns": {
"type": "object",
"properties": {
"value": {
"$ref": "Setting.Value.Extended",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Settings.ResetSettingValue ====
Resets the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Resets the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== Settings.SetSettingValue ====
Changes the value of a setting<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' setting
# ''[[#Setting.Value.Extended|Setting.Value.Extended]]'' value
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''boolean''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Changes the value of a setting",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "setting",
"required": true
},
{
"$ref": "Setting.Value.Extended",
"name": "value",
"required": true
}
],
"returns": {
"type": "boolean"
}
}</syntaxhighlight>}}

=== System ===
==== System.EjectOpticalDrive ====
Ejects or closes the optical disc drive (if available)<br />
'''Permissions:'''
* ControlSystem
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Ejects or closes the optical disc drive (if available)",
"permission": "ControlSystem",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.GetProperties ====
Retrieves the values of the given properties<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#System.Property.Name|System.Property.Name]]''[] properties
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''[[#System.Property.Value|System.Property.Value]]''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieves the values of the given properties",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"$ref": "System.Property.Name"
},
"type": "array",
"name": "properties",
"required": true
}
],
"returns": {
"$ref": "System.Property.Value"
}
}</syntaxhighlight>}}

==== System.Hibernate ====
Puts the system running Kodi into hibernate mode<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Puts the system running Kodi into hibernate mode",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Reboot ====
Reboots the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Reboots the system running Kodi",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Shutdown ====
Shuts the system running Kodi down<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Shuts the system running Kodi down",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== System.Suspend ====
Suspends the system running Kodi<br />
'''Permissions:'''
* ControlPower
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Suspends the system running Kodi",
"permission": "ControlPower",
"type": "method",
"params": [],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.GetTextures ====
Retrieve all textures<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Textures.Fields.Texture|Textures.Fields.Texture]]'' properties ]
# [ ''[[#List.Filter.Textures|List.Filter.Textures]]'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Textures.Details.Texture|Textures.Details.Texture]]''[] textures
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all textures",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Textures.Fields.Texture",
"name": "properties"
},
{
"$ref": "List.Filter.Textures",
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"textures": {
"items": {
"$ref": "Textures.Details.Texture"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== Textures.RemoveTexture ====
Remove the specified texture<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' textureid ''Texture database identifier''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Remove the specified texture",
"permission": "RemoveData",
"type": "method",
"params": [
{
"description": "Texture database identifier",
"$ref": "Library.Id",
"name": "textureid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.Clean ====
Cleans the video library from non-existent items<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Cleans the video library from non-existent items",
"permission": "RemoveData",
"type": "method",
"params": [
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Export ====
Exports all items from the video library<br />
'''Permissions:'''
* WriteFile
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''mixed: object|object'' options ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Exports all items from the video library",
"permission": "WriteFile",
"type": "method",
"params": [
{
"type": [
{
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the directory to where the data should be exported",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actorthumbs": {
"default": false,
"description": "Whether to export actor thumbnails",
"type": "boolean"
},
"images": {
"default": false,
"description": "Whether to export thumbnails and fanart images",
"type": "boolean"
},
"overwrite": {
"default": false,
"description": "Whether to overwrite existing exported files",
"type": "boolean"
}
},
"type": "object"
}
],
"name": "options"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodeDetails ====
Retrieve details about a specific tv show episode<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]'' episodedetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific tv show episode",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"episodedetails": {
"$ref": "Video.Details.Episode"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetEpisodes ====
Retrieve all tv show episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''integer'' season = "-1" ]
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all tv show episodes",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
{
"default": "-1",
"type": "integer",
"name": "season"
},
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Requires tvshowid to be set",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"description": "Requires tvshowid to be set",
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Episodes"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetGenres ====
Retrieve all genres<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Genre|Library.Fields.Genre]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#Library.Details.Genre|Library.Details.Genre]]''[] genres
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all genres",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "type",
"required": true
},
{
"$ref": "Library.Fields.Genre",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"genres": {
"items": {
"$ref": "Library.Details.Genre"
},
"type": "array",
"required": true
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetInProgressTVShows ====
Retrieve all in progress tvshows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all in progress tvshows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieDetails ====
Retrieve details about a specific movie<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]'' moviedetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific movie",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Video.Fields.Movie",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"moviedetails": {
"$ref": "Video.Details.Movie"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovies ====
Retrieve all movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all movies",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"country": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"setid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"set": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Movies"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSetDetails ====
Retrieve details about a specific movie set<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''mixed'' movies ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MovieSet.Extended|Video.Details.MovieSet.Extended]]'' setdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific movie set",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"type": "object",
"name": "movies"
}
],
"returns": {
"type": "object",
"properties": {
"setdetails": {
"$ref": "Video.Details.MovieSet.Extended"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMovieSets ====
Retrieve all movie sets<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MovieSet|Video.Fields.MovieSet]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''[] sets ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all movie sets",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MovieSet",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"sets": {
"items": {
"$ref": "Video.Details.MovieSet"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideoDetails ====
Retrieve details about a specific music video<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]'' musicvideodetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific music video",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"musicvideodetails": {
"$ref": "Video.Details.MusicVideo"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetMusicVideos ====
Retrieve all music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all music videos",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"artist": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"director": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.MusicVideos"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedEpisodes ====
Retrieve all recently added tv episodes<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Episode|Video.Fields.Episode]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Episode|Video.Details.Episode]]''[] episodes ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all recently added tv episodes",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Episode",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"episodes": {
"items": {
"$ref": "Video.Details.Episode"
},
"type": "array"
},
"limits": {
"$ref": "List.LimitsReturned",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMovies ====
Retrieve all recently added movies<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.Movie|Video.Fields.Movie]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all recently added movies",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.Movie",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetRecentlyAddedMusicVideos ====
Retrieve all recently added music videos<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.MusicVideo|Video.Fields.MusicVideo]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.MusicVideo|Video.Details.MusicVideo]]''[] musicvideos ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all recently added music videos",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.MusicVideo",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"musicvideos": {
"items": {
"$ref": "Video.Details.MusicVideo"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasonDetails ====
Retrieve details about a specific tv show season<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.Season|Video.Details.Season]]'' seasondetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific tv show season",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"seasondetails": {
"$ref": "Video.Details.Season"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetSeasons ====
Retrieve all tv seasons<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
# [ ''[[#Video.Fields.Season|Video.Fields.Season]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Season|Video.Details.Season]]''[] seasons ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all tv seasons",
"permission": "ReadData",
"type": "method",
"params": [
{
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
{
"$ref": "Video.Fields.Season",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"seasons": {
"items": {
"$ref": "Video.Details.Season"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTags ====
Retrieve all tags<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' type
# [ ''[[#Library.Fields.Tag|Library.Fields.Tag]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* ''[[#Library.Details.Tag|Library.Details.Tag]]''[] tags
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all tags",
"permission": "ReadData",
"type": "method",
"params": [
{
"type": "string",
"name": "type",
"required": true
},
{
"$ref": "Library.Fields.Tag",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tags": {
"items": {
"$ref": "Library.Details.Tag"
},
"type": "array",
"required": true
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShowDetails ====
Retrieve details about a specific tv show<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]'' tvshowdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve details about a specific tv show",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
}
],
"returns": {
"type": "object",
"properties": {
"tvshowdetails": {
"$ref": "Video.Details.TVShow"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.GetTVShows ====
Retrieve all tv shows<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''[[#Video.Fields.TVShow|Video.Fields.TVShow]]'' properties ]
# [ ''[[#List.Limits|List.Limits]]'' limits ]
# [ ''[[#List.Sort|List.Sort]]'' sort ]
# [ ''mixed'' filter ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />
'''Properties:'''
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.TVShow|Video.Details.TVShow]]''[] tvshows ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve all tv shows",
"permission": "ReadData",
"type": "method",
"params": [
{
"$ref": "Video.Fields.TVShow",
"name": "properties"
},
{
"$ref": "List.Limits",
"name": "limits"
},
{
"$ref": "List.Sort",
"name": "sort"
},
{
"type": [
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genre": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"year": {
"minimum": 0,
"required": true,
"type": "integer"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"actor": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"studio": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"tag": {
"minLength": 1,
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"$ref": "List.Filter.TVShows"
}
],
"name": "filter"
}
],
"returns": {
"type": "object",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"required": true
},
"tvshows": {
"items": {
"$ref": "Video.Details.TVShow"
},
"type": "array"
}
}
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshEpisode ====
Refresh the given episode in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''boolean'' ignorenfo = false ] ''Whether or not to ignore a local NFO if present.''
# [ ''string'' title ] ''Title to use for searching (instead of determining it from the item's filename/path).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Refresh the given episode in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshMovie ====
Refresh the given movie in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''boolean'' ignorenfo = false ] ''Whether or not to ignore a local NFO if present.''
# [ ''string'' title ] ''Title to use for searching (instead of determining it from the item's filename/path).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Refresh the given movie in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshMusicVideo ====
Refresh the given music video in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''boolean'' ignorenfo = false ] ''Whether or not to ignore a local NFO if present.''
# [ ''string'' title ] ''Title to use for searching (instead of determining it from the item's filename/path).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Refresh the given music video in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RefreshTVShow ====
Refresh the given tv show in the library<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''boolean'' ignorenfo = false ] ''Whether or not to ignore a local NFO if present.''
# [ ''boolean'' refreshepisodes = false ] ''Whether or not to refresh all episodes belonging to the TV show.''
# [ ''string'' title ] ''Title to use for searching (instead of determining it from the item's filename/path).''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Refresh the given tv show in the library",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"default": "false",
"description": "Whether or not to ignore a local NFO if present.",
"type": "boolean",
"name": "ignorenfo"
},
{
"default": "false",
"description": "Whether or not to refresh all episodes belonging to the TV show.",
"type": "boolean",
"name": "refreshepisodes"
},
{
"default": "",
"description": "Title to use for searching (instead of determining it from the item's filename/path).",
"type": "string",
"name": "title"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveEpisode ====
Removes the given episode from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Removes the given episode from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMovie ====
Removes the given movie from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Removes the given movie from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveMusicVideo ====
Removes the given music video from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Removes the given music video from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.RemoveTVShow ====
Removes the given tv show from the library<br />
'''Permissions:'''
* RemoveData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Removes the given tv show from the library",
"permission": "RemoveData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.Scan ====
Scans the video sources for new library items<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# [ ''string'' directory ]
# [ ''boolean'' showdialogs = true ] ''Whether or not to show the progress bar or any other GUI dialog''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Scans the video sources for new library items",
"permission": "UpdateData",
"type": "method",
"params": [
{
"default": "",
"type": "string",
"name": "directory"
},
{
"default": "true",
"description": "Whether or not to show the progress bar or any other GUI dialog",
"type": "boolean",
"name": "showdialogs"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetEpisodeDetails ====
Update the given episode with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' episodeid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''mixed'' writer ]
# [ ''[[#Optional.String|Optional.String]]'' firstaired ]
# [ ''[[#Optional.String|Optional.String]]'' productioncode ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' season ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' episode ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given episode with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "writer"
},
{
"$ref": "Optional.String",
"name": "firstaired"
},
{
"$ref": "Optional.String",
"name": "productioncode"
},
{
"$ref": "Optional.Integer",
"name": "season"
},
{
"$ref": "Optional.Integer",
"name": "episode"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieDetails ====
Update the given movie with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' movieid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ] ''linked with premiered. Overridden by premiered parameter''
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' trailer ]
# [ ''[[#Optional.String|Optional.String]]'' tagline ]
# [ ''[[#Optional.String|Optional.String]]'' plotoutline ]
# [ ''mixed'' writer ]
# [ ''mixed'' country ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' top250 ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' set ]
# [ ''mixed'' showlink ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ] ''linked with year. Overriedes year''
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given movie with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"description": "linked with premiered. Overridden by premiered parameter",
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "mpaa"
},
{
"$ref": "Optional.String",
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "trailer"
},
{
"$ref": "Optional.String",
"name": "tagline"
},
{
"$ref": "Optional.String",
"name": "plotoutline"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "writer"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "country"
},
{
"$ref": "Optional.Integer",
"name": "top250"
},
{
"$ref": "Optional.String",
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"name": "set"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "showlink"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "linked with year. Overriedes year",
"$ref": "Optional.String",
"name": "premiered"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMovieSetDetails ====
Update the given movie set with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' setid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''mixed'' art ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given movie set with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "setid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetMusicVideoDetails ====
Update the given music video with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' musicvideoid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''mixed'' director ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' year ] ''linked with premiered. Overridden by premiered parameter''
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''[[#Optional.String|Optional.String]]'' album ]
# [ ''mixed'' artist ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' track ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''mixed'' resume ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ] ''linked with year. Overriedes year''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given music video with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "director"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"description": "linked with premiered. Overridden by premiered parameter",
"$ref": "Optional.Integer",
"name": "year"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"$ref": "Optional.String",
"name": "album"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "artist"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Integer",
"name": "track"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Video.Resume"
}
],
"name": "resume"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "linked with year. Overriedes year",
"$ref": "Optional.String",
"name": "premiered"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetSeasonDetails ====
Update the given season with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' seasonid
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given season with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

==== VideoLibrary.SetTVShowDetails ====
Update the given tvshow with the given details<br />
'''Permissions:'''
* UpdateData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''[[#Library.Id|Library.Id]]'' tvshowid
# [ ''[[#Optional.String|Optional.String]]'' title ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' playcount ]
# [ ''mixed'' studio ]
# [ ''[[#Optional.String|Optional.String]]'' plot ]
# [ ''mixed'' genre ]
# [ ''[[#Optional.Number|Optional.Number]]'' rating ]
# [ ''[[#Optional.String|Optional.String]]'' mpaa ]
# [ ''[[#Optional.String|Optional.String]]'' imdbnumber ]
# [ ''[[#Optional.String|Optional.String]]'' premiered ]
# [ ''[[#Optional.String|Optional.String]]'' votes ]
# [ ''[[#Optional.String|Optional.String]]'' lastplayed ]
# [ ''[[#Optional.String|Optional.String]]'' originaltitle ]
# [ ''[[#Optional.String|Optional.String]]'' sorttitle ]
# [ ''[[#Optional.String|Optional.String]]'' episodeguide ]
# [ ''[[#Optional.String|Optional.String]]'' thumbnail ]
# [ ''[[#Optional.String|Optional.String]]'' fanart ]
# [ ''mixed'' tag ]
# [ ''mixed'' art ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' userrating ]
# [ ''[[#Video.Ratings.Set|Video.Ratings.Set]]'' ratings ]
# [ ''[[#Optional.String|Optional.String]]'' dateadded ]
# [ ''[[#Optional.Integer|Optional.Integer]]'' runtime ] ''Runtime in seconds''
# [ ''[[#Optional.String|Optional.String]]'' status ]
# [ ''mixed'' uniqueid ]
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''string''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Update the given tvshow with the given details",
"permission": "UpdateData",
"type": "method",
"params": [
{
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
{
"$ref": "Optional.String",
"name": "title"
},
{
"$ref": "Optional.Integer",
"name": "playcount"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "studio"
},
{
"$ref": "Optional.String",
"name": "plot"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "genre"
},
{
"$ref": "Optional.Number",
"name": "rating"
},
{
"$ref": "Optional.String",
"name": "mpaa"
},
{
"$ref": "Optional.String",
"name": "imdbnumber"
},
{
"$ref": "Optional.String",
"name": "premiered"
},
{
"$ref": "Optional.String",
"name": "votes"
},
{
"$ref": "Optional.String",
"name": "lastplayed"
},
{
"$ref": "Optional.String",
"name": "originaltitle"
},
{
"$ref": "Optional.String",
"name": "sorttitle"
},
{
"$ref": "Optional.String",
"name": "episodeguide"
},
{
"$ref": "Optional.String",
"name": "thumbnail"
},
{
"$ref": "Optional.String",
"name": "fanart"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Array.String"
}
],
"name": "tag"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.Artwork.Set"
}
],
"name": "art"
},
{
"$ref": "Optional.Integer",
"name": "userrating"
},
{
"$ref": "Video.Ratings.Set",
"name": "ratings"
},
{
"$ref": "Optional.String",
"name": "dateadded"
},
{
"description": "Runtime in seconds",
"$ref": "Optional.Integer",
"name": "runtime"
},
{
"$ref": "Optional.String",
"name": "status"
},
{
"type": [
{
"type": "null"
},
{
"$ref": "Media.UniqueID.Set"
}
],
"name": "uniqueid"
}
],
"returns": {
"type": "string"
}
}</syntaxhighlight>}}

=== XBMC ===
==== XBMC.GetInfoBooleans ====
Retrieve info booleans about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string''[] booleans
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />

'''Description:''' ''Object containing key-value pairs of the retrieved info booleans''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve info booleans about Kodi and the system",
"permission": "ReadData",
"type": "method",
"params": [
{
"items": {
"type": "string"
},
"type": "array",
"name": "booleans",
"required": true
}
],
"returns": {
"type": "object",
"description": "Object containing key-value pairs of the retrieved info booleans",
"additionalProperties": {
"default": "",
"type": "string"
}
}
}</syntaxhighlight>}}

==== XBMC.GetInfoLabels ====
Retrieve info labels about Kodi and the system<br />
'''Permissions:'''
* ReadData
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string''[] labels ''See http://kodi.wiki/view/InfoLabels for a list of possible info labels''
</div>
'''Returns:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
'''Type:''' ''object''<br />

'''Description:''' ''Object containing key-value pairs of the retrieved info labels''<br />
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Retrieve info labels about Kodi and the system",
"permission": "ReadData",
"type": "method",
"params": [
{
"description": "See http://kodi.wiki/view/InfoLabels for a list of possible info labels",
"items": {
"type": "string"
},
"type": "array",
"name": "labels",
"required": true
}
],
"returns": {
"type": "object",
"description": "Object containing key-value pairs of the retrieved info labels",
"additionalProperties": {
"default": "",
"type": "string"
}
}
}</syntaxhighlight>}}

== Global Types ==
=== Addon ===
==== Addon.Content ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"image",
"executable"
],
"id": "Addon.Content",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

==== Addon.Details ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' addonid
* [ ''string'' author ]
* [ ''mixed: boolean|string'' broken ]
* [ ''object'' dependencies ]
* [ ''string'' description ]
* [ ''string'' disclaimer ]
* [ ''boolean'' enabled = false ]
* [ ''object'' extrainfo ]
* [ ''string'' fanart ]
* [ ''boolean'' installed = false ]
* [ ''string'' name ]
* [ ''string'' path ]
* [ ''integer'' rating = "0" ]
* [ ''string'' summary ]
* [ ''string'' thumbnail ]
* ''[[#Addon.Types|Addon.Types]]'' type
* [ ''string'' version ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Addon.Details",
"properties": {
"addonid": {
"type": "string",
"name": "addonid",
"required": true
},
"author": {
"default": "",
"type": "string",
"name": "author"
},
"broken": {
"type": [
{
"type": "boolean"
},
{
"type": "string"
}
],
"name": "broken"
},
"dependencies": {
"items": {
"properties": {
"addonid": {
"required": true,
"type": "string"
},
"optional": {
"required": true,
"type": "boolean"
},
"version": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "dependencies"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disclaimer": {
"default": "",
"type": "string",
"name": "disclaimer"
},
"enabled": {
"default": "false",
"type": "boolean",
"name": "enabled"
},
"extrainfo": {
"items": {
"properties": {
"key": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "extrainfo"
},
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"installed": {
"default": "false",
"type": "boolean",
"name": "installed"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"path": {
"default": "",
"type": "string",
"name": "path"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"type": {
"$ref": "Addon.Types",
"name": "type",
"required": true
},
"version": {
"default": "",
"type": "string",
"name": "version"
}
}
}</syntaxhighlight>}}

==== Addon.Fields ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Addon.Fields",
"items": {
"enums": [
"name",
"version",
"summary",
"description",
"path",
"author",
"thumbnail",
"disclaimer",
"fanart",
"dependencies",
"broken",
"extrainfo",
"rating",
"enabled",
"installed"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Addon.Types ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"unknown",
"xbmc.player.musicviz",
"xbmc.gui.skin",
"xbmc.pvrclient",
"kodi.adsp",
"kodi.inputstream",
"kodi.peripheral",
"xbmc.python.script",
"xbmc.python.weather",
"xbmc.subtitle.module",
"xbmc.python.lyrics",
"xbmc.metadata.scraper.albums",
"xbmc.metadata.scraper.artists",
"xbmc.metadata.scraper.movies",
"xbmc.metadata.scraper.musicvideos",
"xbmc.metadata.scraper.tvshows",
"xbmc.ui.screensaver",
"xbmc.python.pluginsource",
"xbmc.addon.repository",
"xbmc.webinterface",
"xbmc.service",
"xbmc.audioencoder",
"kodi.context.item",
"kodi.audiodecoder",
"kodi.resource.images",
"kodi.resource.language",
"kodi.resource.uisounds",
"xbmc.addon.video",
"xbmc.addon.audio",
"xbmc.addon.image",
"xbmc.addon.executable",
"xbmc.metadata.scraper.library",
"xbmc.python.library",
"xbmc.python.module",
"kodi.game.controller"
],
"id": "Addon.Types",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Application ===
==== Application.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"volume",
"muted",
"name",
"version"
],
"id": "Application.Property.Name",
"type": "string",
"default": "volume"
}</syntaxhighlight>}}

==== Application.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' muted = false ]
* [ ''string'' name ]
* [ ''mixed'' version ]
* [ ''integer'' volume = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Application.Property.Value",
"type": "object",
"properties": {
"muted": {
"default": "false",
"type": "boolean",
"name": "muted"
},
"name": {
"default": "",
"type": "string",
"name": "name"
},
"version": {
"type": "object",
"name": "version"
},
"volume": {
"default": "0",
"type": "integer",
"name": "volume"
}
}
}</syntaxhighlight>}}

=== Array ===
==== Array.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Array.Integer",
"type": "array",
"items": {
"type": "integer"
}
}</syntaxhighlight>}}

==== Array.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Array.String",
"type": "array",
"items": {
"minLength": 1,
"type": "string"
}
}</syntaxhighlight>}}

=== Audio ===
==== Audio.Album.ReleaseType ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"album",
"single"
],
"id": "Audio.Album.ReleaseType",
"type": "string",
"default": "album"
}</syntaxhighlight>}}

==== Audio.Artist.Roles ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Audio.Artist.Roles",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The various roles contributed by an artist to one or more songs",
"properties": {
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Contributors ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Audio.Contributors",
"type": "array",
"items": {
"additionalProperties": false,
"description": "The artist and the role they contribute to a song",
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
},
"name": {
"required": true,
"type": "string"
},
"role": {
"required": true,
"type": "string"
},
"roleid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Album ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' albumid
* [ ''string'' albumlabel ]
* [ ''boolean'' compilation = false ]
* [ ''string'' description ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''integer'' playcount = "0" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''string'' type ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Album",
"properties": {
"albumid": {
"$ref": "Library.Id",
"name": "albumid",
"required": true
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"type": {
"default": "",
"type": "string",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Artist ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' artist
* ''[[#Library.Id|Library.Id]]'' artistid
* [ ''string'' born ]
* [ ''boolean'' compilationartist = false ]
* [ ''string'' description ]
* [ ''string'' died ]
* [ ''string'' disbanded ]
* [ ''string'' formed ]
* [ ''[[#Array.String|Array.String]]'' instrument ]
* [ ''boolean'' isalbumartist = false ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''[[#Audio.Artist.Roles|Audio.Artist.Roles]]'' roles ]
* [ ''[[#Audio.Details.Genres|Audio.Details.Genres]]'' songgenres ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' yearsactive ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Artist",
"properties": {
"artist": {
"type": "string",
"name": "artist",
"required": true
},
"artistid": {
"$ref": "Library.Id",
"name": "artistid",
"required": true
},
"born": {
"default": "",
"type": "string",
"name": "born"
},
"compilationartist": {
"default": "false",
"type": "boolean",
"name": "compilationartist"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"died": {
"default": "",
"type": "string",
"name": "died"
},
"disbanded": {
"default": "",
"type": "string",
"name": "disbanded"
},
"formed": {
"default": "",
"type": "string",
"name": "formed"
},
"instrument": {
"$ref": "Array.String",
"name": "instrument"
},
"isalbumartist": {
"default": "false",
"type": "boolean",
"name": "isalbumartist"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"roles": {
"$ref": "Audio.Artist.Roles",
"name": "roles"
},
"songgenres": {
"$ref": "Audio.Details.Genres",
"name": "songgenres"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"yearsactive": {
"$ref": "Array.String",
"name": "yearsactive"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''[[#Array.String|Array.String]]'' genre ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Audio.Details.Base",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Genres ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Audio.Details.Genres",
"type": "array",
"items": {
"properties": {
"genreid": {
"$ref": "Library.Id",
"required": true
},
"title": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Audio.Details.Media ====
'''Extends:'''
* ''[[#Audio.Details.Base|Audio.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.Integer|Array.Integer]]'' artistid ]
* [ ''string'' displayartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' genreid ]
* [ ''string'' musicbrainzalbumartistid ]
* [ ''string'' musicbrainzalbumid ]
* [ ''number'' rating = "0" ]
* [ ''string'' title ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' votes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Audio.Details.Base"
],
"id": "Audio.Details.Media",
"properties": {
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"artistid": {
"$ref": "Array.Integer",
"name": "artistid"
},
"displayartist": {
"default": "",
"type": "string",
"name": "displayartist"
},
"genreid": {
"$ref": "Array.Integer",
"name": "genreid"
},
"musicbrainzalbumartistid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumartistid"
},
"musicbrainzalbumid": {
"default": "",
"type": "string",
"name": "musicbrainzalbumid"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Role ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' roleid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Audio.Details.Role",
"properties": {
"roleid": {
"$ref": "Library.Id",
"name": "roleid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Audio.Details.Song ====
'''Extends:'''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''string'' comment ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' lyrics ]
* [ ''string'' mood ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''integer'' playcount = "0" ]
* ''[[#Library.Id|Library.Id]]'' songid
* [ ''integer'' track = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Audio.Details.Media"
],
"id": "Audio.Details.Song",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"default": "",
"type": "string",
"name": "mood"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"songid": {
"$ref": "Library.Id",
"name": "songid",
"required": true
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
}
}
}</syntaxhighlight>}}

==== Audio.Fields.Album ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Album",
"items": {
"description": "Requesting the genreid and/or artistid field will result in increased response times",
"enums": [
"title",
"description",
"artist",
"genre",
"theme",
"mood",
"style",
"type",
"albumlabel",
"rating",
"votes",
"userrating",
"year",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"fanart",
"thumbnail",
"playcount",
"genreid",
"artistid",
"displayartist",
"compilation",
"releasetype",
"dateadded"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Artist ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Artist",
"items": {
"description": "Requesting the (song)genreid/genre, or roleid/role fields will result in increased response times",
"enums": [
"instrument",
"style",
"mood",
"born",
"formed",
"description",
"genre",
"died",
"disbanded",
"yearsactive",
"musicbrainzartistid",
"fanart",
"thumbnail",
"compilationartist",
"dateadded",
"roles",
"songgenres",
"isalbumartist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Role ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Role",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Fields.Song ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Audio.Fields.Song",
"items": {
"description": "Requesting the genreid, artistid and/or albumartistid field will result in increased response times",
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"thumbnail",
"file",
"albumid",
"lastplayed",
"disc",
"genreid",
"artistid",
"displayartist",
"albumartistid",
"albumreleasetype",
"dateadded",
"votes",
"userrating",
"mood",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Audio.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"missingartistid"
],
"id": "Audio.Property.Name",
"type": "string",
"default": "missingartistid"
}</syntaxhighlight>}}

==== Audio.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' missingartistid = "-1" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Audio.Property.Value",
"type": "object",
"properties": {
"missingartistid": {
"default": "-1",
"$ref": "Library.Id",
"name": "missingartistid"
}
}
}</syntaxhighlight>}}

=== Configuration ===
==== Configuration.Configuration ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Configuration.Notifications|Configuration.Notifications]]'' notifications
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Configuration",
"type": "object",
"properties": {
"notifications": {
"$ref": "Configuration.Notifications",
"name": "notifications",
"required": true
}
}
}</syntaxhighlight>}}

==== Configuration.Notifications ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' application
* ''boolean'' audiolibrary
* ''boolean'' gui
* ''boolean'' input
* ''boolean'' other
* ''boolean'' player
* ''boolean'' playlist
* ''boolean'' pvr
* ''boolean'' system
* ''boolean'' videolibrary
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Configuration.Notifications",
"type": "object",
"properties": {
"application": {
"type": "boolean",
"name": "application",
"required": true
},
"audiolibrary": {
"type": "boolean",
"name": "audiolibrary",
"required": true
},
"gui": {
"type": "boolean",
"name": "gui",
"required": true
},
"input": {
"type": "boolean",
"name": "input",
"required": true
},
"other": {
"type": "boolean",
"name": "other",
"required": true
},
"player": {
"type": "boolean",
"name": "player",
"required": true
},
"playlist": {
"type": "boolean",
"name": "playlist",
"required": true
},
"pvr": {
"type": "boolean",
"name": "pvr",
"required": true
},
"system": {
"type": "boolean",
"name": "system",
"required": true
},
"videolibrary": {
"type": "boolean",
"name": "videolibrary",
"required": true
}
}
}</syntaxhighlight>}}

=== Favourite ===
==== Favourite.Details.Favourite ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' path ]
* [ ''string'' thumbnail ]
* ''string'' title
* ''[[#Favourite.Type|Favourite.Type]]'' type
* [ ''string'' window ]
* [ ''string'' windowparameter ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Favourite.Details.Favourite",
"type": "object",
"properties": {
"path": {
"default": "",
"type": "string",
"name": "path"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"type": "string",
"name": "title",
"required": true
},
"type": {
"$ref": "Favourite.Type",
"name": "type",
"required": true
},
"window": {
"default": "",
"type": "string",
"name": "window"
},
"windowparameter": {
"default": "",
"type": "string",
"name": "windowparameter"
}
}
}</syntaxhighlight>}}

==== Favourite.Fields.Favourite ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Favourite.Fields.Favourite",
"items": {
"enums": [
"window",
"windowparameter",
"thumbnail",
"path"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Favourite.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"media",
"window",
"script",
"unknown"
],
"id": "Favourite.Type",
"type": "string",
"default": "media"
}</syntaxhighlight>}}

=== Files ===
==== Files.Media ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"video",
"music",
"pictures",
"files",
"programs"
],
"id": "Files.Media",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

=== Global ===
==== Global.IncrementDecrement ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"increment",
"decrement"
],
"id": "Global.IncrementDecrement",
"type": "string",
"default": "increment"
}</syntaxhighlight>}}

==== Global.String.NotEmpty ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Global.String.NotEmpty",
"type": "string",
"default": ""
}</syntaxhighlight>}}

==== Global.Time ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' hours
* ''integer'' milliseconds
* ''integer'' minutes
* ''integer'' seconds
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Global.Time",
"type": "object",
"properties": {
"hours": {
"type": "integer",
"name": "hours",
"required": true
},
"milliseconds": {
"type": "integer",
"name": "milliseconds",
"required": true
},
"minutes": {
"type": "integer",
"name": "minutes",
"required": true
},
"seconds": {
"type": "integer",
"name": "seconds",
"required": true
}
}
}</syntaxhighlight>}}

==== Global.Toggle ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Global.Toggle",
"type": [
{
"type": "boolean"
},
{
"enums": [
"toggle"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== Global.Weekday ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"id": "Global.Weekday",
"type": "string",
"default": "monday"
}</syntaxhighlight>}}

=== GUI ===
==== GUI.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"currentwindow",
"currentcontrol",
"skin",
"fullscreen",
"stereoscopicmode"
],
"id": "GUI.Property.Name",
"type": "string",
"default": "currentwindow"
}</syntaxhighlight>}}

==== GUI.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' currentcontrol ]
* [ ''mixed'' currentwindow ]
* [ ''boolean'' fullscreen = false ]
* [ ''mixed'' skin ]
* [ ''[[#GUI.Stereoscopy.Mode|GUI.Stereoscopy.Mode]]'' stereoscopicmode ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "GUI.Property.Value",
"type": "object",
"properties": {
"currentcontrol": {
"type": "object",
"name": "currentcontrol"
},
"currentwindow": {
"type": "object",
"name": "currentwindow"
},
"fullscreen": {
"default": "false",
"type": "boolean",
"name": "fullscreen"
},
"skin": {
"type": "object",
"name": "skin"
},
"stereoscopicmode": {
"$ref": "GUI.Stereoscopy.Mode",
"name": "stereoscopicmode"
}
}
}</syntaxhighlight>}}

==== GUI.Stereoscopy.Mode ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
* ''string'' mode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "GUI.Stereoscopy.Mode",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
},
"mode": {
"type": "string",
"name": "mode",
"required": true
}
}
}</syntaxhighlight>}}

==== GUI.Window ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"home",
"programs",
"pictures",
"filemanager",
"settings",
"music",
"videos",
"tvchannels",
"tvrecordings",
"tvguide",
"tvtimers",
"tvsearch",
"radiochannels",
"radiorecordings",
"radioguide",
"radiotimers",
"radiosearch",
"gamecontrollers",
"pvrguideinfo",
"pvrrecordinginfo",
"pvrradiordsinfo",
"pvrtimersetting",
"pvrgroupmanager",
"pvrchannelmanager",
"pvrguidesearch",
"pvrchannelscan",
"pvrupdateprogress",
"pvrosdchannels",
"pvrosdguide",
"pvrosdteletext",
"systeminfo",
"testpattern",
"screencalibration",
"systemsettings",
"servicesettings",
"pvrsettings",
"playersettings",
"mediasettings",
"interfacesettings",
"appearancesettings",
"videoplaylist",
"loginscreen",
"profiles",
"skinsettings",
"addonbrowser",
"yesnodialog",
"progressdialog",
"virtualkeyboard",
"volumebar",
"submenu",
"favourites",
"contextmenu",
"notification",
"numericinput",
"gamepadinput",
"shutdownmenu",
"playercontrols",
"playerprocessinfo",
"seekbar",
"musicosd",
"addonsettings",
"visualisationpresetlist",
"osdcmssettings",
"osdvideosettings",
"osdaudiosettings",
"audiodspmanager",
"osdaudiodspsettings",
"videobookmarks",
"filebrowser",
"networksetup",
"mediasource",
"profilesettings",
"locksettings",
"contentsettings",
"songinformation",
"smartplaylisteditor",
"smartplaylistrule",
"busydialog",
"pictureinfo",
"accesspoints",
"fullscreeninfo",
"sliderdialog",
"addoninformation",
"subtitlesearch",
"musicplaylist",
"musicplaylisteditor",
"teletext",
"selectdialog",
"musicinformation",
"okdialog",
"movieinformation",
"textviewer",
"fullscreenvideo",
"fullscreenlivetv",
"fullscreenradio",
"visualisation",
"slideshow",
"weather",
"screensaver",
"videoosd",
"videomenu",
"videotimeseek",
"startwindow",
"startup",
"peripheralsettings",
"extendedprogressdialog",
"mediafilter",
"addon",
"eventlog",
"tvtimerrules",
"radiotimerrules"
],
"id": "GUI.Window",
"type": "string",
"default": "home"
}</syntaxhighlight>}}

=== Input ===
==== Input.Action ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"left",
"right",
"up",
"down",
"pageup",
"pagedown",
"select",
"highlight",
"parentdir",
"parentfolder",
"back",
"menu",
"previousmenu",
"info",
"pause",
"stop",
"skipnext",
"skipprevious",
"fullscreen",
"aspectratio",
"stepforward",
"stepback",
"bigstepforward",
"bigstepback",
"chapterorbigstepforward",
"chapterorbigstepback",
"osd",
"showsubtitles",
"nextsubtitle",
"cyclesubtitle",
"playerdebug",
"codecinfo",
"playerprocessinfo",
"nextpicture",
"previouspicture",
"zoomout",
"zoomin",
"playlist",
"queue",
"zoomnormal",
"zoomlevel1",
"zoomlevel2",
"zoomlevel3",
"zoomlevel4",
"zoomlevel5",
"zoomlevel6",
"zoomlevel7",
"zoomlevel8",
"zoomlevel9",
"nextcalibration",
"resetcalibration",
"analogmove",
"analogmovex",
"analogmovey",
"rotate",
"rotateccw",
"close",
"subtitledelayminus",
"subtitledelay",
"subtitledelayplus",
"audiodelayminus",
"audiodelay",
"audiodelayplus",
"subtitleshiftup",
"subtitleshiftdown",
"subtitlealign",
"audionextlanguage",
"verticalshiftup",
"verticalshiftdown",
"nextresolution",
"audiotoggledigital",
"number0",
"number1",
"number2",
"number3",
"number4",
"number5",
"number6",
"number7",
"number8",
"number9",
"smallstepback",
"fastforward",
"rewind",
"play",
"playpause",
"switchplayer",
"delete",
"copy",
"move",
"screenshot",
"rename",
"togglewatched",
"scanitem",
"reloadkeymaps",
"volumeup",
"volumedown",
"mute",
"backspace",
"scrollup",
"scrolldown",
"analogfastforward",
"analogrewind",
"moveitemup",
"moveitemdown",
"contextmenu",
"shift",
"symbols",
"cursorleft",
"cursorright",
"showtime",
"analogseekforward",
"analogseekback",
"showpreset",
"nextpreset",
"previouspreset",
"lockpreset",
"randompreset",
"increasevisrating",
"decreasevisrating",
"showvideomenu",
"enter",
"increaserating",
"decreaserating",
"setrating",
"togglefullscreen",
"nextscene",
"previousscene",
"nextletter",
"prevletter",
"jumpsms2",
"jumpsms3",
"jumpsms4",
"jumpsms5",
"jumpsms6",
"jumpsms7",
"jumpsms8",
"jumpsms9",
"filter",
"filterclear",
"filtersms2",
"filtersms3",
"filtersms4",
"filtersms5",
"filtersms6",
"filtersms7",
"filtersms8",
"filtersms9",
"firstpage",
"lastpage",
"guiprofile",
"red",
"green",
"yellow",
"blue",
"increasepar",
"decreasepar",
"volampup",
"volampdown",
"volumeamplification",
"createbookmark",
"createepisodebookmark",
"settingsreset",
"settingslevelchange",
"stereomode",
"nextstereomode",
"previousstereomode",
"togglestereomode",
"stereomodetomono",
"channelup",
"channeldown",
"previouschannelgroup",
"nextchannelgroup",
"playpvr",
"playpvrtv",
"playpvrradio",
"record",
"togglecommskip",
"showtimerrule",
"leftclick",
"rightclick",
"middleclick",
"doubleclick",
"longclick",
"wheelup",
"wheeldown",
"mousedrag",
"mousemove",
"tap",
"longpress",
"pangesture",
"zoomgesture",
"rotategesture",
"swipeleft",
"swiperight",
"swipeup",
"swipedown",
"error",
"noop"
],
"id": "Input.Action",
"type": "string",
"default": "left"
}</syntaxhighlight>}}

=== Item ===
==== Item.Details.Base ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Item.Details.Base",
"type": "object",
"properties": {
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Item.Fields.Base ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Item.Fields.Base",
"type": "array",
"items": {
"type": "string"
}
}</syntaxhighlight>}}

=== Library ===
==== Library.Details.Genre ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' genreid
* [ ''string'' thumbnail ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Genre",
"properties": {
"genreid": {
"$ref": "Library.Id",
"name": "genreid",
"required": true
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Details.Tag ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' tagid
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Library.Details.Tag",
"properties": {
"tagid": {
"$ref": "Library.Id",
"name": "tagid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Library.Fields.Genre ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Genre",
"items": {
"enums": [
"title",
"thumbnail"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Fields.Tag ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Library.Fields.Tag",
"items": {
"enums": [
"title"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Library.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Library.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

=== List ===
==== List.Amount ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Amount",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== List.Fields.All ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.All",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"channel",
"channeltype",
"hidden",
"locked",
"channelnumber",
"starttime",
"endtime",
"specialsortseason",
"specialsortepisode",
"compilation",
"releasetype",
"albumreleasetype",
"contributors",
"displaycomposer",
"displayconductor",
"displayorchestra",
"displaylyricist",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Fields.Files ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "List.Fields.Files",
"items": {
"enums": [
"title",
"artist",
"albumartist",
"genre",
"year",
"rating",
"album",
"track",
"duration",
"comment",
"lyrics",
"musicbrainztrackid",
"musicbrainzartistid",
"musicbrainzalbumid",
"musicbrainzalbumartistid",
"playcount",
"fanart",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"premiered",
"productioncode",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"firstaired",
"season",
"episode",
"showtitle",
"thumbnail",
"file",
"resume",
"artistid",
"albumid",
"tvshowid",
"setid",
"watchedepisodes",
"disc",
"tag",
"art",
"genreid",
"displayartist",
"albumartistid",
"description",
"theme",
"mood",
"style",
"albumlabel",
"sorttitle",
"episodeguide",
"uniqueid",
"dateadded",
"size",
"lastmodified",
"mimetype",
"specialsortseason",
"specialsortepisode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== List.Filter.Albums ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Albums",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Albums"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Albums"
}
]
}</syntaxhighlight>}}

==== List.Filter.Artists ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Artists",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Artists"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Artists"
}
]
}</syntaxhighlight>}}

==== List.Filter.Episodes ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Episodes",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Episodes"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Episodes"
}
]
}</syntaxhighlight>}}

==== List.Filter.Fields.Albums ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"year",
"review",
"themes",
"moods",
"styles",
"compilation",
"type",
"label",
"rating",
"userrating",
"playcount",
"lastplayed",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Albums",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Artists ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"artist",
"genre",
"moods",
"styles",
"instruments",
"biography",
"born",
"bandformed",
"disbanded",
"died",
"role",
"path",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Artists",
"type": "string",
"default": "artist"
}</syntaxhighlight>}}

==== List.Filter.Fields.Episodes ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"title",
"tvshow",
"plot",
"votes",
"rating",
"userrating",
"time",
"writers",
"airdate",
"playcount",
"lastplayed",
"inprogress",
"genre",
"year",
"director",
"actor",
"episode",
"season",
"filename",
"path",
"studio",
"mpaarating",
"dateadded",
"tag",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Episodes",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Movies ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"title",
"plot",
"plotoutline",
"tagline",
"votes",
"rating",
"userrating",
"time",
"writers",
"playcount",
"lastplayed",
"inprogress",
"genre",
"country",
"year",
"director",
"actor",
"mpaarating",
"top250",
"studio",
"hastrailer",
"filename",
"path",
"set",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Movies",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.MusicVideos ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"title",
"genre",
"album",
"year",
"artist",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"time",
"director",
"studio",
"plot",
"tag",
"dateadded",
"videoresolution",
"audiochannels",
"audiocount",
"subtitlecount",
"videocodec",
"audiocodec",
"audiolanguage",
"subtitlelanguage",
"videoaspect",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.MusicVideos",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Fields.Songs ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"genre",
"album",
"artist",
"albumartist",
"title",
"year",
"time",
"tracknumber",
"filename",
"path",
"playcount",
"lastplayed",
"rating",
"userrating",
"comment",
"moods",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.Songs",
"type": "string",
"default": "genre"
}</syntaxhighlight>}}

==== List.Filter.Fields.Textures ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"textureid",
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"width",
"height",
"usecount",
"lastused"
],
"id": "List.Filter.Fields.Textures",
"type": "string",
"default": "textureid"
}</syntaxhighlight>}}

==== List.Filter.Fields.TVShows ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"title",
"plot",
"status",
"votes",
"rating",
"userrating",
"year",
"genre",
"director",
"actor",
"numepisodes",
"numwatched",
"playcount",
"path",
"studio",
"mpaarating",
"dateadded",
"lastplayed",
"inprogress",
"tag",
"playlist",
"virtualfolder"
],
"id": "List.Filter.Fields.TVShows",
"type": "string",
"default": "title"
}</syntaxhighlight>}}

==== List.Filter.Movies ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Movies",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Movies"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Movies"
}
]
}</syntaxhighlight>}}

==== List.Filter.MusicVideos ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.MusicVideos",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.MusicVideos"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.MusicVideos"
}
]
}</syntaxhighlight>}}

==== List.Filter.Operators ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"contains",
"doesnotcontain",
"is",
"isnot",
"startswith",
"endswith",
"greaterthan",
"lessthan",
"after",
"before",
"inthelast",
"notinthelast",
"true",
"false",
"between"
],
"id": "List.Filter.Operators",
"type": "string",
"default": "contains"
}</syntaxhighlight>}}

==== List.Filter.Rule ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Operators|List.Filter.Operators]]'' operator
* ''mixed: string|array'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Rule",
"type": "object",
"properties": {
"operator": {
"$ref": "List.Filter.Operators",
"name": "operator",
"required": true
},
"value": {
"type": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Albums ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Albums|List.Filter.Fields.Albums]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Albums",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Albums",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Artists ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Artists|List.Filter.Fields.Artists]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Artists",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Artists",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Episodes ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Episodes|List.Filter.Fields.Episodes]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Episodes",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Episodes",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Movies ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Movies|List.Filter.Fields.Movies]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Movies",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Movies",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.MusicVideos ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.MusicVideos|List.Filter.Fields.MusicVideos]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.MusicVideos",
"properties": {
"field": {
"$ref": "List.Filter.Fields.MusicVideos",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Songs ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Songs|List.Filter.Fields.Songs]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Songs",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Songs",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.Textures ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.Textures|List.Filter.Fields.Textures]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.Textures",
"properties": {
"field": {
"$ref": "List.Filter.Fields.Textures",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Rule.TVShows ====
'''Extends:'''
* ''[[#List.Filter.Rule|List.Filter.Rule]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.Filter.Fields.TVShows|List.Filter.Fields.TVShows]]'' field
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Filter.Rule"
],
"id": "List.Filter.Rule.TVShows",
"properties": {
"field": {
"$ref": "List.Filter.Fields.TVShows",
"name": "field",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Filter.Songs ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Songs",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Songs"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Songs"
}
]
}</syntaxhighlight>}}

==== List.Filter.Textures ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.Textures",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.Textures"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.Textures"
}
]
}</syntaxhighlight>}}

==== List.Filter.TVShows ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Filter.TVShows",
"type": [
{
"properties": {
"and": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"properties": {
"or": {
"items": {
"$ref": "List.Filter.TVShows"
},
"minItems": 1,
"required": true,
"type": "array"
}
},
"type": "object"
},
{
"$ref": "List.Filter.Rule.TVShows"
}
]
}</syntaxhighlight>}}

==== List.Item.All ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' channel ]
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''string'' endtime ]
* [ ''boolean'' hidden = false ]
* [ ''boolean'' locked = false ]
* [ ''string'' starttime ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.All",
"properties": {
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
}
}
}</syntaxhighlight>}}

==== List.Item.Base ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
* ''[[#Audio.Details.Media|Audio.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' albumartist ]
* [ ''[[#Array.Integer|Array.Integer]]'' albumartistid ]
* [ ''[[#Library.Id|Library.Id]]'' albumid = "-1" ]
* [ ''string'' albumlabel ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' albumreleasetype = "album" ]
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''string'' comment ]
* [ ''boolean'' compilation = false ]
* [ ''[[#Audio.Contributors|Audio.Contributors]]'' contributors ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''string'' description ]
* [ ''integer'' disc = "0" ]
* [ ''string'' displaycomposer ]
* [ ''string'' displayconductor ]
* [ ''string'' displaylyricist ]
* [ ''string'' displayorchestra ]
* [ ''integer'' duration = "0" ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''string'' firstaired ]
* [ ''[[#Library.Id|Library.Id]]'' id = "-1" ]
* [ ''string'' imdbnumber ]
* [ ''string'' lyrics ]
* [ ''[[#Array.String|Array.String]]'' mood ]
* [ ''string'' mpaa ]
* [ ''string'' musicbrainzartistid ]
* [ ''string'' musicbrainztrackid ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''string'' productioncode ]
* [ ''[[#Audio.Album.ReleaseType|Audio.Album.ReleaseType]]'' releasetype = "album" ]
* [ ''integer'' season = "0" ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' showtitle ]
* [ ''string'' sorttitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' style ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''[[#Array.String|Array.String]]'' theme ]
* [ ''integer'' top250 = "0" ]
* [ ''integer'' track = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''string'' type = "unknown" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.File",
"Audio.Details.Media"
],
"id": "List.Item.Base",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"albumartist": {
"$ref": "Array.String",
"name": "albumartist"
},
"albumartistid": {
"$ref": "Array.Integer",
"name": "albumartistid"
},
"albumid": {
"default": "-1",
"$ref": "Library.Id",
"name": "albumid"
},
"albumlabel": {
"default": "",
"type": "string",
"name": "albumlabel"
},
"albumreleasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "albumreleasetype"
},
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"comment": {
"default": "",
"type": "string",
"name": "comment"
},
"compilation": {
"default": "false",
"type": "boolean",
"name": "compilation"
},
"contributors": {
"$ref": "Audio.Contributors",
"name": "contributors"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"description": {
"default": "",
"type": "string",
"name": "description"
},
"disc": {
"default": "0",
"type": "integer",
"name": "disc"
},
"displaycomposer": {
"default": "",
"type": "string",
"name": "displaycomposer"
},
"displayconductor": {
"default": "",
"type": "string",
"name": "displayconductor"
},
"displaylyricist": {
"default": "",
"type": "string",
"name": "displaylyricist"
},
"displayorchestra": {
"default": "",
"type": "string",
"name": "displayorchestra"
},
"duration": {
"default": "0",
"type": "integer",
"name": "duration"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"id": {
"default": "-1",
"$ref": "Library.Id",
"name": "id"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"lyrics": {
"default": "",
"type": "string",
"name": "lyrics"
},
"mood": {
"$ref": "Array.String",
"name": "mood"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"musicbrainzartistid": {
"default": "",
"type": "string",
"name": "musicbrainzartistid"
},
"musicbrainztrackid": {
"default": "",
"type": "string",
"name": "musicbrainztrackid"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"releasetype": {
"default": "album",
"$ref": "Audio.Album.ReleaseType",
"name": "releasetype"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"style": {
"$ref": "Array.String",
"name": "style"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"theme": {
"$ref": "Array.String",
"name": "theme"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"type": {
"default": "unknown",
"type": "string",
"name": "type"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== List.Item.File ====
'''Extends:'''
* ''[[#List.Item.Base|List.Item.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' file
* ''string'' filetype
* [ ''string'' lastmodified ]
* [ ''string'' mimetype ]
* [ ''integer'' size = "0" ] ''Size of the file in bytes''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"List.Item.Base"
],
"id": "List.Item.File",
"properties": {
"file": {
"type": "string",
"name": "file",
"required": true
},
"filetype": {
"type": "string",
"name": "filetype",
"required": true
},
"lastmodified": {
"default": "",
"type": "string",
"name": "lastmodified"
},
"mimetype": {
"default": "",
"type": "string",
"name": "mimetype"
},
"size": {
"default": "0",
"description": "Size of the file in bytes",
"type": "integer",
"name": "size"
}
}
}</syntaxhighlight>}}

==== List.Items.Sources ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Items.Sources",
"type": "array",
"items": {
"extends": "Item.Details.Base",
"properties": {
"file": {
"required": true,
"type": "string"
}
}
}
}</syntaxhighlight>}}

==== List.Limits ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ] ''Index of the last item to return''
* [ ''integer'' start = "0" ] ''Index of the first item to return''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Limits",
"type": "object",
"properties": {
"end": {
"default": "-1",
"description": "Index of the last item to return",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"description": "Index of the first item to return",
"type": "integer",
"name": "start"
}
}
}</syntaxhighlight>}}

==== List.LimitsReturned ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#List.Amount|List.Amount]]'' end = "-1" ]
* [ ''integer'' start = "0" ]
* ''integer'' total
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.LimitsReturned",
"type": "object",
"properties": {
"end": {
"default": "-1",
"$ref": "List.Amount",
"name": "end"
},
"start": {
"default": "0",
"type": "integer",
"name": "start"
},
"total": {
"type": "integer",
"name": "total",
"required": true
}
}
}</syntaxhighlight>}}

==== List.Sort ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' ignorearticle = false ]
* [ ''string'' method = "none" ]
* [ ''string'' order = "ascending" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "List.Sort",
"type": "object",
"properties": {
"ignorearticle": {
"default": "false",
"type": "boolean",
"name": "ignorearticle"
},
"method": {
"default": "none",
"type": "string",
"name": "method"
},
"order": {
"default": "ascending",
"type": "string",
"name": "order"
}
}
}</syntaxhighlight>}}

=== Media ===
==== Media.Artwork ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' banner ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' fanart ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' poster ]
* [ ''[[#Global.String.NotEmpty|Global.String.NotEmpty]]'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Media.Artwork",
"type": "object",
"properties": {
"banner": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "banner"
},
"fanart": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "fanart"
},
"poster": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "poster"
},
"thumb": {
"default": "",
"$ref": "Global.String.NotEmpty",
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Artwork.Set ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''mixed'' banner ]
* [ ''mixed'' fanart ]
* [ ''mixed'' poster ]
* [ ''mixed'' thumb ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Media.Artwork.Set",
"type": "object",
"properties": {
"banner": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "banner"
},
"fanart": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "fanart"
},
"poster": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "poster"
},
"thumb": {
"default": "",
"type": [
{
"type": "null"
},
{
"$ref": "Global.String.NotEmpty"
}
],
"name": "thumb"
}
}
}</syntaxhighlight>}}

==== Media.Details.Base ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' fanart ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Media.Details.Base",
"properties": {
"fanart": {
"default": "",
"type": "string",
"name": "fanart"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Media.UniqueID ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Media.UniqueID",
"type": "object"
}</syntaxhighlight>}}

==== Media.UniqueID.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Media.UniqueID.Set",
"type": "object"
}</syntaxhighlight>}}

=== Notifications ===
==== Notifications.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Notifications.Item",
"type": [
{
"description": "An unknown item does not have any additional information.",
"properties": {
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "An item known to the database has an identification.",
"properties": {
"id": {
"$ref": "Library.Id",
"required": true
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A movie item has a title and may have a release year.",
"properties": {
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
},
"year": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
{
"description": "A tv episode has a title and may have an episode number, season number and the title of the show it belongs to.",
"properties": {
"episode": {
"default": 0,
"type": "integer"
},
"season": {
"default": 0,
"type": "integer"
},
"showtitle": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A music video has a title and may have an album and an artist.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A song has a title and may have an album, an artist and a track number.",
"properties": {
"album": {
"default": "",
"type": "string"
},
"artist": {
"default": "",
"type": "string"
},
"title": {
"required": true,
"type": "string"
},
"track": {
"default": 0,
"type": "integer"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A picture has a file path.",
"properties": {
"file": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
},
{
"description": "A PVR channel is either a radio or tv channel and has a title.",
"properties": {
"channeltype": {
"$ref": "PVR.Channel.Type",
"required": true
},
"id": {
"$ref": "Library.Id",
"required": true
},
"title": {
"required": true,
"type": "string"
},
"type": {
"$ref": "Notifications.Item.Type",
"required": true
}
},
"type": "object"
}
]
}</syntaxhighlight>}}

==== Notifications.Item.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"unknown",
"movie",
"episode",
"musicvideo",
"song",
"picture",
"channel"
],
"id": "Notifications.Item.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Optional ===
==== Optional.Boolean ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Optional.Boolean",
"type": [
{
"type": "null"
},
{
"type": "boolean"
}
]
}</syntaxhighlight>}}

==== Optional.Integer ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Optional.Integer",
"type": [
{
"type": "null"
},
{
"type": "integer"
}
]
}</syntaxhighlight>}}

==== Optional.Number ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Optional.Number",
"type": [
{
"type": "null"
},
{
"type": "number"
}
]
}</syntaxhighlight>}}

==== Optional.String ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Optional.String",
"type": [
{
"type": "null"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.Audio.Stream ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' bitrate
* ''integer'' channels
* ''string'' codec
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Audio.Stream",
"type": "object",
"properties": {
"bitrate": {
"type": "integer",
"name": "bitrate",
"required": true
},
"channels": {
"type": "integer",
"name": "channels",
"required": true
},
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Player.Notifications.Data ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Notifications.Item|Notifications.Item]]'' item
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Notifications.Data",
"type": "object",
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item",
"required": true
},
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Player.Id|Player.Id]]'' playerid
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Notifications.Player",
"type": "object",
"properties": {
"playerid": {
"$ref": "Player.Id",
"name": "playerid",
"required": true
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Notifications.Player.Seek ====
'''Extends:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Global.Time|Global.Time]]'' seekoffset ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Player.Notifications.Player"
],
"id": "Player.Notifications.Player.Seek",
"properties": {
"seekoffset": {
"$ref": "Global.Time",
"name": "seekoffset"
},
"time": {
"$ref": "Global.Time",
"name": "time"
}
}
}</syntaxhighlight>}}

==== Player.Position.Percentage ====
'''Type:''' ''number''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Position.Percentage",
"type": "number",
"default": 0
}</syntaxhighlight>}}

==== Player.Position.Time ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' hours = "0" ]
* [ ''integer'' milliseconds = "0" ]
* [ ''integer'' minutes = "0" ]
* [ ''integer'' seconds = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Position.Time",
"type": "object",
"properties": {
"hours": {
"default": "0",
"type": "integer",
"name": "hours"
},
"milliseconds": {
"default": "0",
"type": "integer",
"name": "milliseconds"
},
"minutes": {
"default": "0",
"type": "integer",
"name": "minutes"
},
"seconds": {
"default": "0",
"type": "integer",
"name": "seconds"
}
}
}</syntaxhighlight>}}

==== Player.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"type",
"partymode",
"speed",
"time",
"percentage",
"totaltime",
"playlistid",
"position",
"repeat",
"shuffled",
"canseek",
"canchangespeed",
"canmove",
"canzoom",
"canrotate",
"canshuffle",
"canrepeat",
"currentaudiostream",
"audiostreams",
"subtitleenabled",
"currentsubtitle",
"subtitles",
"live",
"currentvideostream",
"videostreams"
],
"id": "Player.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Player.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]''[] audiostreams ]
* [ ''boolean'' canchangespeed = false ]
* [ ''boolean'' canmove = false ]
* [ ''boolean'' canrepeat = false ]
* [ ''boolean'' canrotate = false ]
* [ ''boolean'' canseek = false ]
* [ ''boolean'' canshuffle = false ]
* [ ''boolean'' canzoom = false ]
* [ ''[[#Player.Audio.Stream|Player.Audio.Stream]]'' currentaudiostream ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]'' currentsubtitle ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]'' currentvideostream ]
* [ ''boolean'' live = false ]
* [ ''boolean'' partymode = false ]
* [ ''[[#Player.Position.Percentage|Player.Position.Percentage]]'' percentage = "0" ]
* [ ''[[#Playlist.Id|Playlist.Id]]'' playlistid = "-1" ]
* [ ''[[#Playlist.Position|Playlist.Position]]'' position = "-1" ]
* [ ''[[#Player.Repeat|Player.Repeat]]'' repeat = "off" ]
* [ ''boolean'' shuffled = false ]
* [ ''integer'' speed = "0" ]
* [ ''boolean'' subtitleenabled = false ]
* [ ''[[#Player.Subtitle|Player.Subtitle]]''[] subtitles ]
* [ ''[[#Global.Time|Global.Time]]'' time ]
* [ ''[[#Global.Time|Global.Time]]'' totaltime ]
* [ ''[[#Player.Type|Player.Type]]'' type = "video" ]
* [ ''[[#Player.Video.Stream|Player.Video.Stream]]''[] videostreams ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Property.Value",
"type": "object",
"properties": {
"audiostreams": {
"items": {
"$ref": "Player.Audio.Stream"
},
"type": "array",
"name": "audiostreams"
},
"canchangespeed": {
"default": "false",
"type": "boolean",
"name": "canchangespeed"
},
"canmove": {
"default": "false",
"type": "boolean",
"name": "canmove"
},
"canrepeat": {
"default": "false",
"type": "boolean",
"name": "canrepeat"
},
"canrotate": {
"default": "false",
"type": "boolean",
"name": "canrotate"
},
"canseek": {
"default": "false",
"type": "boolean",
"name": "canseek"
},
"canshuffle": {
"default": "false",
"type": "boolean",
"name": "canshuffle"
},
"canzoom": {
"default": "false",
"type": "boolean",
"name": "canzoom"
},
"currentaudiostream": {
"$ref": "Player.Audio.Stream",
"name": "currentaudiostream"
},
"currentsubtitle": {
"$ref": "Player.Subtitle",
"name": "currentsubtitle"
},
"currentvideostream": {
"$ref": "Player.Video.Stream",
"name": "currentvideostream"
},
"live": {
"default": "false",
"type": "boolean",
"name": "live"
},
"partymode": {
"default": "false",
"type": "boolean",
"name": "partymode"
},
"percentage": {
"default": "0",
"$ref": "Player.Position.Percentage",
"name": "percentage"
},
"playlistid": {
"default": "-1",
"$ref": "Playlist.Id",
"name": "playlistid"
},
"position": {
"default": "-1",
"$ref": "Playlist.Position",
"name": "position"
},
"repeat": {
"default": "off",
"$ref": "Player.Repeat",
"name": "repeat"
},
"shuffled": {
"default": "false",
"type": "boolean",
"name": "shuffled"
},
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
},
"subtitleenabled": {
"default": "false",
"type": "boolean",
"name": "subtitleenabled"
},
"subtitles": {
"items": {
"$ref": "Player.Subtitle"
},
"type": "array",
"name": "subtitles"
},
"time": {
"$ref": "Global.Time",
"name": "time"
},
"totaltime": {
"$ref": "Global.Time",
"name": "totaltime"
},
"type": {
"default": "video",
"$ref": "Player.Type",
"name": "type"
},
"videostreams": {
"items": {
"$ref": "Player.Video.Stream"
},
"type": "array",
"name": "videostreams"
}
}
}</syntaxhighlight>}}

==== Player.Repeat ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"off",
"one",
"all"
],
"id": "Player.Repeat",
"type": "string",
"default": "off"
}</syntaxhighlight>}}

==== Player.Speed ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' speed = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Speed",
"type": "object",
"properties": {
"speed": {
"default": "0",
"type": "integer",
"name": "speed"
}
}
}</syntaxhighlight>}}

==== Player.Subtitle ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' index
* ''string'' language
* ''string'' name
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Subtitle",
"type": "object",
"properties": {
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
}
}
}</syntaxhighlight>}}

==== Player.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"video",
"audio",
"picture"
],
"id": "Player.Type",
"type": "string",
"default": "video"
}</syntaxhighlight>}}

==== Player.Video.Stream ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' codec
* ''integer'' height
* ''integer'' index
* ''string'' language
* ''string'' name
* ''integer'' width
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Player.Video.Stream",
"type": "object",
"properties": {
"codec": {
"type": "string",
"name": "codec",
"required": true
},
"height": {
"type": "integer",
"name": "height",
"required": true
},
"index": {
"type": "integer",
"name": "index",
"required": true
},
"language": {
"type": "string",
"name": "language",
"required": true
},
"name": {
"type": "string",
"name": "name",
"required": true
},
"width": {
"type": "integer",
"name": "width",
"required": true
}
}
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.Id ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Playlist.Id",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Item ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Playlist.Item",
"type": [
{
"additionalProperties": false,
"properties": {
"file": {
"description": "Path to a file (not a directory) to be added to the playlist",
"required": true,
"type": "string"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"directory": {
"required": true,
"type": "string"
},
"media": {
"$ref": "Files.Media",
"default": "files"
},
"recursive": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"movieid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"episodeid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"musicvideoid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"artistid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"albumid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"songid": {
"$ref": "Library.Id",
"required": true
}
},
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"genreid": {
"$ref": "Library.Id",
"description": "Identification of a genre from the AudioLibrary",
"required": true
}
},
"type": "object"
}
]
}</syntaxhighlight>}}

==== Playlist.Position ====
'''Type:''' ''integer''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Playlist.Position",
"type": "integer",
"default": -1
}</syntaxhighlight>}}

==== Playlist.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"type",
"size"
],
"id": "Playlist.Property.Name",
"type": "string",
"default": "type"
}</syntaxhighlight>}}

==== Playlist.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' size = "0" ]
* [ ''[[#Playlist.Type|Playlist.Type]]'' type = "unknown" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Playlist.Property.Value",
"type": "object",
"properties": {
"size": {
"default": "0",
"type": "integer",
"name": "size"
},
"type": {
"default": "unknown",
"$ref": "Playlist.Type",
"name": "type"
}
}
}</syntaxhighlight>}}

==== Playlist.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"unknown",
"video",
"audio",
"picture",
"mixed"
],
"id": "Playlist.Type",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Profiles ===
==== Profiles.Details.Profile ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' lockmode = "0" ]
* [ ''string'' thumbnail ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "Profiles.Details.Profile",
"properties": {
"lockmode": {
"default": "0",
"type": "integer",
"name": "lockmode"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
}
}
}</syntaxhighlight>}}

==== Profiles.Fields.Profile ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Profiles.Fields.Profile",
"items": {
"enums": [
"thumbnail",
"lockmode"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Profiles.Password ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' encryption = "md5" ] ''Password Encryption''
* ''string'' value ''Password''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Profiles.Password",
"type": "object",
"properties": {
"encryption": {
"default": "md5",
"description": "Password Encryption",
"type": "string",
"name": "encryption"
},
"value": {
"description": "Password",
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

=== PVR ===
==== PVR.Channel.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"tv",
"radio"
],
"id": "PVR.Channel.Type",
"type": "string",
"default": "tv"
}</syntaxhighlight>}}

==== PVR.ChannelGroup.Id ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "PVR.ChannelGroup.Id",
"type": [
{
"$ref": "Library.Id"
},
{
"enums": [
"alltv",
"allradio"
],
"type": "string"
}
]
}</syntaxhighlight>}}

==== PVR.Details.Broadcast ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' broadcastid
* [ ''string'' cast ]
* [ ''string'' director ]
* [ ''string'' endtime ]
* [ ''string'' episodename ]
* [ ''integer'' episodenum = "0" ]
* [ ''integer'' episodepart = "0" ]
* [ ''string'' firstaired ]
* [ ''string'' genre ]
* [ ''boolean'' hasrecording = false ]
* [ ''boolean'' hastimer = false ]
* [ ''boolean'' hastimerrule = false ]
* [ ''integer'' imdbnumber = "0" ]
* [ ''boolean'' isactive = false ]
* [ ''boolean'' isseries = false ]
* [ ''string'' originaltitle ]
* [ ''integer'' parentalrating = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''integer'' progress = "0" ]
* [ ''number'' progresspercentage = "0" ]
* [ ''integer'' rating = "0" ]
* [ ''string'' recording ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' thumbnail ]
* [ ''string'' title ]
* [ ''boolean'' wasactive = false ]
* [ ''string'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Broadcast",
"properties": {
"broadcastid": {
"$ref": "Library.Id",
"name": "broadcastid",
"required": true
},
"cast": {
"default": "",
"type": "string",
"name": "cast"
},
"director": {
"default": "",
"type": "string",
"name": "director"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"episodename": {
"default": "",
"type": "string",
"name": "episodename"
},
"episodenum": {
"default": "0",
"type": "integer",
"name": "episodenum"
},
"episodepart": {
"default": "0",
"type": "integer",
"name": "episodepart"
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"hasrecording": {
"default": "false",
"type": "boolean",
"name": "hasrecording"
},
"hastimer": {
"default": "false",
"type": "boolean",
"name": "hastimer"
},
"hastimerrule": {
"default": "false",
"type": "boolean",
"name": "hastimerrule"
},
"imdbnumber": {
"default": "0",
"type": "integer",
"name": "imdbnumber"
},
"isactive": {
"default": "false",
"type": "boolean",
"name": "isactive"
},
"isseries": {
"default": "false",
"type": "boolean",
"name": "isseries"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"parentalrating": {
"default": "0",
"type": "integer",
"name": "parentalrating"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"progress": {
"default": "0",
"type": "integer",
"name": "progress"
},
"progresspercentage": {
"default": "0",
"type": "number",
"name": "progresspercentage"
},
"rating": {
"default": "0",
"type": "integer",
"name": "rating"
},
"recording": {
"default": "",
"type": "string",
"name": "recording"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"wasactive": {
"default": "false",
"type": "boolean",
"name": "wasactive"
},
"writer": {
"default": "",
"type": "string",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Channel ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnext ]
* [ ''[[#PVR.Details.Broadcast|PVR.Details.Broadcast]]'' broadcastnow ]
* [ ''string'' channel ]
* ''[[#Library.Id|Library.Id]]'' channelid
* [ ''integer'' channelnumber = "0" ]
* [ ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype = "tv" ]
* [ ''boolean'' hidden = false ]
* [ ''string'' icon ]
* [ ''boolean'' isrecording = false ]
* [ ''string'' lastplayed ]
* [ ''boolean'' locked = false ]
* [ ''integer'' subchannelnumber = "0" ]
* [ ''string'' thumbnail ]
* ''integer'' uniqueid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Channel",
"properties": {
"broadcastnext": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnext"
},
"broadcastnow": {
"$ref": "PVR.Details.Broadcast",
"name": "broadcastnow"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channelid": {
"$ref": "Library.Id",
"name": "channelid",
"required": true
},
"channelnumber": {
"default": "0",
"type": "integer",
"name": "channelnumber"
},
"channeltype": {
"default": "tv",
"$ref": "PVR.Channel.Type",
"name": "channeltype"
},
"hidden": {
"default": "false",
"type": "boolean",
"name": "hidden"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isrecording": {
"default": "false",
"type": "boolean",
"name": "isrecording"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"locked": {
"default": "false",
"type": "boolean",
"name": "locked"
},
"subchannelnumber": {
"default": "0",
"type": "integer",
"name": "subchannelnumber"
},
"thumbnail": {
"default": "",
"type": "string",
"name": "thumbnail"
},
"uniqueid": {
"type": "integer",
"name": "uniqueid",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Library.Id|Library.Id]]'' channelgroupid
* ''[[#PVR.Channel.Type|PVR.Channel.Type]]'' channeltype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.ChannelGroup",
"properties": {
"channelgroupid": {
"$ref": "Library.Id",
"name": "channelgroupid",
"required": true
},
"channeltype": {
"$ref": "PVR.Channel.Type",
"name": "channeltype",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.ChannelGroup.Extended ====
'''Extends:'''
* ''[[#PVR.Details.ChannelGroup|PVR.Details.ChannelGroup]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#PVR.Details.Channel|PVR.Details.Channel]]''[] channels ]
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"PVR.Details.ChannelGroup"
],
"id": "PVR.Details.ChannelGroup.Extended",
"properties": {
"channels": {
"items": {
"$ref": "PVR.Details.Channel"
},
"type": "array",
"name": "channels"
},
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
}
}
}</syntaxhighlight>}}

==== PVR.Details.Recording ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''string'' channel ]
* [ ''integer'' channeluid = "0" ]
* [ ''string'' directory ]
* [ ''string'' endtime ]
* [ ''integer'' epgeventid = "0" ]
* [ ''string'' file ]
* [ ''string'' genre ]
* [ ''string'' icon ]
* [ ''boolean'' isdeleted = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' playcount = "0" ]
* [ ''string'' plot ]
* [ ''string'' plotoutline ]
* [ ''boolean'' radio = false ]
* ''[[#Library.Id|Library.Id]]'' recordingid
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ]
* [ ''string'' starttime ]
* [ ''string'' streamurl ]
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Recording",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"channel": {
"default": "",
"type": "string",
"name": "channel"
},
"channeluid": {
"default": "0",
"type": "integer",
"name": "channeluid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgeventid": {
"default": "0",
"type": "integer",
"name": "epgeventid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"genre": {
"default": "",
"type": "string",
"name": "genre"
},
"icon": {
"default": "",
"type": "string",
"name": "icon"
},
"isdeleted": {
"default": "false",
"type": "boolean",
"name": "isdeleted"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"radio": {
"default": "false",
"type": "boolean",
"name": "radio"
},
"recordingid": {
"$ref": "Library.Id",
"name": "recordingid",
"required": true
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"streamurl": {
"default": "",
"type": "string",
"name": "streamurl"
},
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== PVR.Details.Timer ====
'''Extends:'''
* ''[[#Item.Details.Base|Item.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Library.Id|Library.Id]]'' channelid = "-1" ]
* [ ''string'' directory ]
* [ ''boolean'' endanytime = false ]
* [ ''integer'' endmargin = "0" ]
* [ ''string'' endtime ]
* [ ''string'' epgsearchstring ]
* [ ''integer'' epguid = "0" ]
* [ ''string'' file ]
* [ ''string'' firstday ]
* [ ''boolean'' fulltextepgsearch = false ]
* [ ''boolean'' ismanual = false ]
* [ ''boolean'' isradio = false ]
* [ ''boolean'' isreadonly = false ]
* [ ''boolean'' istimerrule = false ]
* [ ''integer'' lifetime = "0" ]
* [ ''integer'' maxrecordings = "0" ]
* [ ''integer'' preventduplicateepisodes = "0" ]
* [ ''integer'' priority = "0" ]
* [ ''integer'' recordinggroup = "0" ]
* [ ''integer'' runtime = "0" ]
* [ ''boolean'' startanytime = false ]
* [ ''integer'' startmargin = "0" ]
* [ ''string'' starttime ]
* [ ''[[#PVR.TimerState|PVR.TimerState]]'' state = "unknown" ]
* [ ''string'' summary ]
* ''[[#Library.Id|Library.Id]]'' timerid
* [ ''string'' title ]
* [ ''[[#Global.Weekday|Global.Weekday]]''[] weekdays ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Details.Base"
],
"id": "PVR.Details.Timer",
"properties": {
"channelid": {
"default": "-1",
"$ref": "Library.Id",
"name": "channelid"
},
"directory": {
"default": "",
"type": "string",
"name": "directory"
},
"endanytime": {
"default": "false",
"type": "boolean",
"name": "endanytime"
},
"endmargin": {
"default": "0",
"type": "integer",
"name": "endmargin"
},
"endtime": {
"default": "",
"type": "string",
"name": "endtime"
},
"epgsearchstring": {
"default": "",
"type": "string",
"name": "epgsearchstring"
},
"epguid": {
"default": "0",
"type": "integer",
"name": "epguid"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"firstday": {
"default": "",
"type": "string",
"name": "firstday"
},
"fulltextepgsearch": {
"default": "false",
"type": "boolean",
"name": "fulltextepgsearch"
},
"ismanual": {
"default": "false",
"type": "boolean",
"name": "ismanual"
},
"isradio": {
"default": "false",
"type": "boolean",
"name": "isradio"
},
"isreadonly": {
"default": "false",
"type": "boolean",
"name": "isreadonly"
},
"istimerrule": {
"default": "false",
"type": "boolean",
"name": "istimerrule"
},
"lifetime": {
"default": "0",
"type": "integer",
"name": "lifetime"
},
"maxrecordings": {
"default": "0",
"type": "integer",
"name": "maxrecordings"
},
"preventduplicateepisodes": {
"default": "0",
"type": "integer",
"name": "preventduplicateepisodes"
},
"priority": {
"default": "0",
"type": "integer",
"name": "priority"
},
"recordinggroup": {
"default": "0",
"type": "integer",
"name": "recordinggroup"
},
"runtime": {
"default": "0",
"type": "integer",
"name": "runtime"
},
"startanytime": {
"default": "false",
"type": "boolean",
"name": "startanytime"
},
"startmargin": {
"default": "0",
"type": "integer",
"name": "startmargin"
},
"starttime": {
"default": "",
"type": "string",
"name": "starttime"
},
"state": {
"default": "unknown",
"$ref": "PVR.TimerState",
"name": "state"
},
"summary": {
"default": "",
"type": "string",
"name": "summary"
},
"timerid": {
"$ref": "Library.Id",
"name": "timerid",
"required": true
},
"title": {
"default": "",
"type": "string",
"name": "title"
},
"weekdays": {
"items": {
"$ref": "Global.Weekday"
},
"type": "array",
"name": "weekdays"
}
}
}</syntaxhighlight>}}

==== PVR.Fields.Broadcast ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Broadcast",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"starttime",
"endtime",
"runtime",
"progress",
"progresspercentage",
"genre",
"episodename",
"episodenum",
"episodepart",
"firstaired",
"hastimer",
"isactive",
"parentalrating",
"wasactive",
"thumbnail",
"rating",
"originaltitle",
"cast",
"director",
"writer",
"year",
"imdbnumber",
"hastimerrule",
"hasrecording",
"recording",
"isseries"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Channel ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Channel",
"items": {
"enums": [
"thumbnail",
"channeltype",
"hidden",
"locked",
"channel",
"lastplayed",
"broadcastnow",
"broadcastnext",
"uniqueid",
"icon",
"channelnumber",
"subchannelnumber",
"isrecording"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Recording ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Recording",
"items": {
"enums": [
"title",
"plot",
"plotoutline",
"genre",
"playcount",
"resume",
"channel",
"starttime",
"endtime",
"runtime",
"lifetime",
"icon",
"art",
"streamurl",
"file",
"directory",
"radio",
"isdeleted",
"epgeventid",
"channeluid"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Fields.Timer ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "PVR.Fields.Timer",
"items": {
"enums": [
"title",
"summary",
"channelid",
"isradio",
"istimerrule",
"ismanual",
"starttime",
"endtime",
"runtime",
"lifetime",
"firstday",
"weekdays",
"priority",
"startmargin",
"endmargin",
"state",
"file",
"directory",
"preventduplicateepisodes",
"startanytime",
"endanytime",
"epgsearchstring",
"fulltextepgsearch",
"recordinggroup",
"maxrecordings",
"epguid",
"isreadonly"
],
"type": "string"
}
}</syntaxhighlight>}}

==== PVR.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"available",
"recording",
"scanning"
],
"id": "PVR.Property.Name",
"type": "string",
"default": "available"
}</syntaxhighlight>}}

==== PVR.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' available = false ]
* [ ''boolean'' recording = false ]
* [ ''boolean'' scanning = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "PVR.Property.Value",
"type": "object",
"properties": {
"available": {
"default": "false",
"type": "boolean",
"name": "available"
},
"recording": {
"default": "false",
"type": "boolean",
"name": "recording"
},
"scanning": {
"default": "false",
"type": "boolean",
"name": "scanning"
}
}
}</syntaxhighlight>}}

==== PVR.TimerState ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"unknown",
"new",
"scheduled",
"recording",
"completed",
"aborted",
"cancelled",
"conflict_ok",
"conflict_notok",
"error",
"disabled"
],
"id": "PVR.TimerState",
"type": "string",
"default": "unknown"
}</syntaxhighlight>}}

=== Setting ===
==== Setting.Details.Base ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' help ]
* ''string'' id
* ''string'' label
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Details.Base",
"type": "object",
"properties": {
"help": {
"default": "",
"type": "string",
"name": "help"
},
"id": {
"type": "string",
"name": "id",
"required": true
},
"label": {
"type": "string",
"name": "label",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Category ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Group|Setting.Details.Group]]''[] groups ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Category",
"properties": {
"groups": {
"items": {
"$ref": "Setting.Details.Group"
},
"type": "array",
"name": "groups"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Control ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Details.Control",
"type": [
{
"$ref": "Setting.Details.ControlCheckmark"
},
{
"$ref": "Setting.Details.ControlSpinner"
},
{
"$ref": "Setting.Details.ControlEdit"
},
{
"$ref": "Setting.Details.ControlButton"
},
{
"$ref": "Setting.Details.ControlList"
},
{
"$ref": "Setting.Details.ControlSlider"
},
{
"$ref": "Setting.Details.ControlRange"
}
]
}</syntaxhighlight>}}

==== Setting.Details.ControlBase ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' delayed
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Details.ControlBase",
"type": "object",
"properties": {
"delayed": {
"type": "boolean",
"name": "delayed",
"required": true
},
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlButton ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlButton",
"properties": {
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlCheckmark ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' format
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlCheckmark",
"properties": {
"format": {
"type": "string",
"name": "format",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlEdit ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' hidden
* ''string'' type
* ''boolean'' verifynewvalue
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlEdit",
"properties": {
"hidden": {
"type": "boolean",
"name": "hidden",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"verifynewvalue": {
"type": "boolean",
"name": "verifynewvalue",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlHeading ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' heading ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlHeading",
"properties": {
"heading": {
"default": "",
"type": "string",
"name": "heading"
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlList ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' multiselect
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlList",
"properties": {
"multiselect": {
"type": "boolean",
"name": "multiselect",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlRange ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''string'' formatvalue
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlRange",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"formatvalue": {
"type": "string",
"name": "formatvalue",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSlider ====
'''Extends:'''
* ''[[#Setting.Details.ControlHeading|Setting.Details.ControlHeading]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' formatlabel
* ''boolean'' popup
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlHeading"
],
"id": "Setting.Details.ControlSlider",
"properties": {
"formatlabel": {
"type": "string",
"name": "formatlabel",
"required": true
},
"popup": {
"type": "boolean",
"name": "popup",
"required": true
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.ControlSpinner ====
'''Extends:'''
* ''[[#Setting.Details.ControlBase|Setting.Details.ControlBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' formatlabel ]
* [ ''string'' minimumlabel ]
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.ControlBase"
],
"id": "Setting.Details.ControlSpinner",
"properties": {
"formatlabel": {
"default": "",
"type": "string",
"name": "formatlabel"
},
"minimumlabel": {
"default": "",
"type": "string",
"name": "minimumlabel"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.Group ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''string'' id
* [ ''[[#Setting.Details.Setting|Setting.Details.Setting]]''[] settings ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Details.Group",
"type": "object",
"properties": {
"id": {
"type": "string",
"name": "id",
"required": true
},
"settings": {
"items": {
"$ref": "Setting.Details.Setting"
},
"type": "array",
"name": "settings"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Section ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Category|Setting.Details.Category]]''[] categories ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.Section",
"properties": {
"categories": {
"items": {
"$ref": "Setting.Details.Category"
},
"type": "array",
"name": "categories"
}
}
}</syntaxhighlight>}}

==== Setting.Details.Setting ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Details.Setting",
"type": [
{
"$ref": "Setting.Details.SettingBool"
},
{
"$ref": "Setting.Details.SettingInt"
},
{
"$ref": "Setting.Details.SettingNumber"
},
{
"$ref": "Setting.Details.SettingString"
},
{
"$ref": "Setting.Details.SettingAction"
},
{
"$ref": "Setting.Details.SettingList"
},
{
"$ref": "Setting.Details.SettingPath"
},
{
"$ref": "Setting.Details.SettingAddon"
}
]
}</syntaxhighlight>}}

==== Setting.Details.SettingAction ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingAction"
}</syntaxhighlight>}}

==== Setting.Details.SettingAddon ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Addon.Types|Addon.Types]]'' addontype
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingAddon",
"properties": {
"addontype": {
"$ref": "Addon.Types",
"name": "addontype",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBase ====
'''Extends:'''
* ''[[#Setting.Details.Base|Setting.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Setting.Details.Control|Setting.Details.Control]]'' control ]
* ''boolean'' enabled
* ''[[#Setting.Level|Setting.Level]]'' level
* [ ''string'' parent ]
* ''[[#Setting.Type|Setting.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.Base"
],
"id": "Setting.Details.SettingBase",
"properties": {
"control": {
"$ref": "Setting.Details.Control",
"name": "control"
},
"enabled": {
"type": "boolean",
"name": "enabled",
"required": true
},
"level": {
"$ref": "Setting.Level",
"name": "level",
"required": true
},
"parent": {
"default": "",
"type": "string",
"name": "parent"
},
"type": {
"$ref": "Setting.Type",
"name": "type",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingBool ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' default
* ''boolean'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingBool",
"properties": {
"default": {
"type": "boolean",
"name": "default",
"required": true
},
"value": {
"type": "boolean",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingInt ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''integer'' default
* [ ''integer'' maximum = "0" ]
* [ ''integer'' minimum = "0" ]
* [ ''object'' options ]
* [ ''integer'' step = "0" ]
* ''integer'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingInt",
"properties": {
"default": {
"type": "integer",
"name": "default",
"required": true
},
"maximum": {
"default": "0",
"type": "integer",
"name": "maximum"
},
"minimum": {
"default": "0",
"type": "integer",
"name": "minimum"
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"step": {
"default": "0",
"type": "integer",
"name": "step"
},
"value": {
"type": "integer",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingList ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#Setting.Value.List|Setting.Value.List]]'' default
* ''[[#Setting.Details.Setting|Setting.Details.Setting]]'' definition
* ''string'' delimiter
* ''[[#Setting.Type|Setting.Type]]'' elementtype
* [ ''integer'' maximumitems = "0" ]
* [ ''integer'' minimumitems = "0" ]
* ''[[#Setting.Value.List|Setting.Value.List]]'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingList",
"properties": {
"default": {
"$ref": "Setting.Value.List",
"name": "default",
"required": true
},
"definition": {
"$ref": "Setting.Details.Setting",
"name": "definition",
"required": true
},
"delimiter": {
"type": "string",
"name": "delimiter",
"required": true
},
"elementtype": {
"$ref": "Setting.Type",
"name": "elementtype",
"required": true
},
"maximumitems": {
"default": "0",
"type": "integer",
"name": "maximumitems"
},
"minimumitems": {
"default": "0",
"type": "integer",
"name": "minimumitems"
},
"value": {
"$ref": "Setting.Value.List",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingNumber ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''number'' default
* ''number'' maximum
* ''number'' minimum
* ''number'' step
* ''number'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingNumber",
"properties": {
"default": {
"type": "number",
"name": "default",
"required": true
},
"maximum": {
"type": "number",
"name": "maximum",
"required": true
},
"minimum": {
"type": "number",
"name": "minimum",
"required": true
},
"step": {
"type": "number",
"name": "step",
"required": true
},
"value": {
"type": "number",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingPath ====
'''Extends:'''
* ''[[#Setting.Details.SettingString|Setting.Details.SettingString]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string''[] sources ]
* ''boolean'' writable
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingString"
],
"id": "Setting.Details.SettingPath",
"properties": {
"sources": {
"items": {
"type": "string"
},
"type": "array",
"name": "sources"
},
"writable": {
"type": "boolean",
"name": "writable",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Details.SettingString ====
'''Extends:'''
* ''[[#Setting.Details.SettingBase|Setting.Details.SettingBase]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''boolean'' allowempty
* ''string'' default
* [ ''object'' options ]
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Setting.Details.SettingBase"
],
"id": "Setting.Details.SettingString",
"properties": {
"allowempty": {
"type": "boolean",
"name": "allowempty",
"required": true
},
"default": {
"type": "string",
"name": "default",
"required": true
},
"options": {
"items": {
"properties": {
"label": {
"required": true,
"type": "string"
},
"value": {
"required": true,
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "options"
},
"value": {
"type": "string",
"name": "value",
"required": true
}
}
}</syntaxhighlight>}}

==== Setting.Level ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"basic",
"standard",
"advanced",
"expert"
],
"id": "Setting.Level",
"type": "string",
"default": "basic"
}</syntaxhighlight>}}

==== Setting.Type ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"boolean",
"integer",
"number",
"string",
"action",
"list",
"path",
"addon"
],
"id": "Setting.Type",
"type": "string",
"default": "boolean"
}</syntaxhighlight>}}

==== Setting.Value ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Value",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
}</syntaxhighlight>}}

==== Setting.Value.Extended ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Value.Extended",
"type": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"$ref": "Setting.Value.List"
}
]
}</syntaxhighlight>}}

==== Setting.Value.List ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Setting.Value.List",
"type": "array",
"items": {
"$ref": "Setting.Value"
}
}</syntaxhighlight>}}

=== System ===
==== System.Property.Name ====
'''Type:''' ''string''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"enums": [
"canshutdown",
"cansuspend",
"canhibernate",
"canreboot"
],
"id": "System.Property.Name",
"type": "string",
"default": "canshutdown"
}</syntaxhighlight>}}

==== System.Property.Value ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' canhibernate = false ]
* [ ''boolean'' canreboot = false ]
* [ ''boolean'' canshutdown = false ]
* [ ''boolean'' cansuspend = false ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "System.Property.Value",
"type": "object",
"properties": {
"canhibernate": {
"default": "false",
"type": "boolean",
"name": "canhibernate"
},
"canreboot": {
"default": "false",
"type": "boolean",
"name": "canreboot"
},
"canshutdown": {
"default": "false",
"type": "boolean",
"name": "canshutdown"
},
"cansuspend": {
"default": "false",
"type": "boolean",
"name": "cansuspend"
}
}
}</syntaxhighlight>}}

=== Textures ===
==== Textures.Details.Size ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' height = "0" ] ''Height of texture''
* [ ''string'' lastused ] ''Date of last use''
* [ ''integer'' size = "0" ] ''Size of the texture (1 == largest)''
* [ ''integer'' usecount = "0" ] ''Number of uses''
* [ ''integer'' width = "0" ] ''Width of texture''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Textures.Details.Size",
"type": "object",
"properties": {
"height": {
"default": "0",
"description": "Height of texture",
"type": "integer",
"name": "height"
},
"lastused": {
"default": "",
"description": "Date of last use",
"type": "string",
"name": "lastused"
},
"size": {
"default": "0",
"description": "Size of the texture (1 == largest)",
"type": "integer",
"name": "size"
},
"usecount": {
"default": "0",
"description": "Number of uses",
"type": "integer",
"name": "usecount"
},
"width": {
"default": "0",
"description": "Width of texture",
"type": "integer",
"name": "width"
}
}
}</syntaxhighlight>}}

==== Textures.Details.Texture ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' cachedurl ] ''Cached URL on disk''
* [ ''string'' imagehash ] ''Hash of image''
* [ ''string'' lasthashcheck ] ''Last time source was checked for changes''
* [ ''[[#Textures.Details.Size|Textures.Details.Size]]''[] sizes ]
* [ ''[[#Library.Id|Library.Id]]'' textureid = "-1" ]
* [ ''string'' url ] ''Original source URL''
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Textures.Details.Texture",
"type": "object",
"properties": {
"cachedurl": {
"default": "",
"description": "Cached URL on disk",
"type": "string",
"name": "cachedurl"
},
"imagehash": {
"default": "",
"description": "Hash of image",
"type": "string",
"name": "imagehash"
},
"lasthashcheck": {
"default": "",
"description": "Last time source was checked for changes",
"type": "string",
"name": "lasthashcheck"
},
"sizes": {
"items": {
"$ref": "Textures.Details.Size"
},
"type": "array",
"name": "sizes"
},
"textureid": {
"default": "-1",
"$ref": "Library.Id",
"name": "textureid"
},
"url": {
"default": "",
"description": "Original source URL",
"type": "string",
"name": "url"
}
}
}</syntaxhighlight>}}

==== Textures.Fields.Texture ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Textures.Fields.Texture",
"items": {
"enums": [
"url",
"cachedurl",
"lasthashcheck",
"imagehash",
"sizes"
],
"type": "string"
}
}</syntaxhighlight>}}

=== Video ===
==== Video.Cast ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Video.Cast",
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"required": true,
"type": "string"
},
"order": {
"required": true,
"type": "integer"
},
"role": {
"required": true,
"type": "string"
},
"thumbnail": {
"default": "",
"type": "string"
}
},
"type": "object"
}
}</syntaxhighlight>}}

==== Video.Details.Base ====
'''Extends:'''
* ''[[#Media.Details.Base|Media.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Media.Artwork|Media.Artwork]]'' art ]
* [ ''integer'' playcount = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Media.Details.Base"
],
"id": "Video.Details.Base",
"properties": {
"art": {
"$ref": "Media.Artwork",
"name": "art"
},
"playcount": {
"default": "0",
"type": "integer",
"name": "playcount"
}
}
}</syntaxhighlight>}}

==== Video.Details.Episode ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* ''[[#Library.Id|Library.Id]]'' episodeid
* [ ''string'' firstaired ]
* [ ''string'' originaltitle ]
* [ ''string'' productioncode ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' season = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' seasonid = "-1" ]
* [ ''string'' showtitle ]
* [ ''integer'' specialsortepisode = "0" ]
* [ ''integer'' specialsortseason = "0" ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Episode",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeid": {
"$ref": "Library.Id",
"name": "episodeid",
"required": true
},
"firstaired": {
"default": "",
"type": "string",
"name": "firstaired"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"productioncode": {
"default": "",
"type": "string",
"name": "productioncode"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"seasonid": {
"default": "-1",
"$ref": "Library.Id",
"name": "seasonid"
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"specialsortepisode": {
"default": "0",
"type": "integer",
"name": "specialsortepisode"
},
"specialsortseason": {
"default": "0",
"type": "integer",
"name": "specialsortseason"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
}
}
}</syntaxhighlight>}}

==== Video.Details.File ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Array.String|Array.String]]'' director ]
* [ ''[[#Video.Resume|Video.Resume]]'' resume ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''[[#Video.Streams|Video.Streams]]'' streamdetails ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.File",
"properties": {
"director": {
"$ref": "Array.String",
"name": "director"
},
"resume": {
"$ref": "Video.Resume",
"name": "resume"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"streamdetails": {
"$ref": "Video.Streams",
"name": "streamdetails"
}
}
}</syntaxhighlight>}}

==== Video.Details.Item ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' dateadded ]
* [ ''string'' file ]
* [ ''string'' lastplayed ]
* [ ''string'' plot ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.Item",
"properties": {
"dateadded": {
"default": "",
"type": "string",
"name": "dateadded"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"lastplayed": {
"default": "",
"type": "string",
"name": "lastplayed"
},
"plot": {
"default": "",
"type": "string",
"name": "plot"
}
}
}</syntaxhighlight>}}

==== Video.Details.Media ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' title ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Media",
"properties": {
"title": {
"default": "",
"type": "string",
"name": "title"
}
}
}</syntaxhighlight>}}

==== Video.Details.Movie ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''[[#Array.String|Array.String]]'' country ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* ''[[#Library.Id|Library.Id]]'' movieid
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' plotoutline ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''string'' set ]
* [ ''[[#Library.Id|Library.Id]]'' setid = "-1" ]
* [ ''[[#Array.String|Array.String]]'' showlink ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''string'' tagline ]
* [ ''integer'' top250 = "0" ]
* [ ''string'' trailer ]
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''[[#Array.String|Array.String]]'' writer ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.Movie",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"country": {
"$ref": "Array.String",
"name": "country"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"movieid": {
"$ref": "Library.Id",
"name": "movieid",
"required": true
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"plotoutline": {
"default": "",
"type": "string",
"name": "plotoutline"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"set": {
"default": "",
"type": "string",
"name": "set"
},
"setid": {
"default": "-1",
"$ref": "Library.Id",
"name": "setid"
},
"showlink": {
"$ref": "Array.String",
"name": "showlink"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tagline": {
"default": "",
"type": "string",
"name": "tagline"
},
"top250": {
"default": "0",
"type": "integer",
"name": "top250"
},
"trailer": {
"default": "",
"type": "string",
"name": "trailer"
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"writer": {
"$ref": "Array.String",
"name": "writer"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet ====
'''Extends:'''
* ''[[#Video.Details.Media|Video.Details.Media]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' plot ]
* ''[[#Library.Id|Library.Id]]'' setid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.Media"
],
"id": "Video.Details.MovieSet",
"properties": {
"plot": {
"default": "",
"type": "string",
"name": "plot"
},
"setid": {
"$ref": "Library.Id",
"name": "setid",
"required": true
}
}
}</syntaxhighlight>}}

==== Video.Details.MovieSet.Extended ====
'''Extends:'''
* ''[[#Video.Details.MovieSet|Video.Details.MovieSet]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* ''[[#List.LimitsReturned|List.LimitsReturned]]'' limits
* [ ''[[#Video.Details.Movie|Video.Details.Movie]]''[] movies ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.MovieSet"
],
"id": "Video.Details.MovieSet.Extended",
"properties": {
"limits": {
"$ref": "List.LimitsReturned",
"name": "limits",
"required": true
},
"movies": {
"items": {
"$ref": "Video.Details.Movie"
},
"type": "array",
"name": "movies"
}
}
}</syntaxhighlight>}}

==== Video.Details.MusicVideo ====
'''Extends:'''
* ''[[#Video.Details.File|Video.Details.File]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''string'' album ]
* [ ''[[#Array.String|Array.String]]'' artist ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* ''[[#Library.Id|Library.Id]]'' musicvideoid
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* [ ''integer'' track = "0" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.File"
],
"id": "Video.Details.MusicVideo",
"properties": {
"album": {
"default": "",
"type": "string",
"name": "album"
},
"artist": {
"$ref": "Array.String",
"name": "artist"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"musicvideoid": {
"$ref": "Library.Id",
"name": "musicvideoid",
"required": true
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"track": {
"default": "0",
"type": "integer",
"name": "track"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Details.Season ====
'''Extends:'''
* ''[[#Video.Details.Base|Video.Details.Base]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''integer'' episode = "0" ]
* ''integer'' season
* ''[[#Library.Id|Library.Id]]'' seasonid
* [ ''string'' showtitle ]
* [ ''[[#Library.Id|Library.Id]]'' tvshowid = "-1" ]
* [ ''integer'' userrating = "0" ]
* [ ''integer'' watchedepisodes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.Base"
],
"id": "Video.Details.Season",
"properties": {
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"season": {
"type": "integer",
"name": "season",
"required": true
},
"seasonid": {
"$ref": "Library.Id",
"name": "seasonid",
"required": true
},
"showtitle": {
"default": "",
"type": "string",
"name": "showtitle"
},
"tvshowid": {
"default": "-1",
"$ref": "Library.Id",
"name": "tvshowid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
}
}
}</syntaxhighlight>}}

==== Video.Details.TVShow ====
'''Extends:'''
* ''[[#Video.Details.Item|Video.Details.Item]]''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''[[#Video.Cast|Video.Cast]]'' cast ]
* [ ''integer'' episode = "0" ]
* [ ''string'' episodeguide ]
* [ ''[[#Array.String|Array.String]]'' genre ]
* [ ''string'' imdbnumber ]
* [ ''string'' mpaa ]
* [ ''string'' originaltitle ]
* [ ''string'' premiered ]
* [ ''number'' rating = "0" ]
* [ ''mixed'' ratings ]
* [ ''integer'' runtime = "0" ] ''Runtime in seconds''
* [ ''integer'' season = "0" ]
* [ ''string'' sorttitle ]
* [ ''[[#Array.String|Array.String]]'' studio ]
* [ ''[[#Array.String|Array.String]]'' tag ]
* ''[[#Library.Id|Library.Id]]'' tvshowid
* [ ''[[#Media.UniqueID|Media.UniqueID]]'' uniqueid ]
* [ ''integer'' userrating = "0" ]
* [ ''string'' votes ]
* [ ''integer'' watchedepisodes = "0" ]
* [ ''integer'' year = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Video.Details.Item"
],
"id": "Video.Details.TVShow",
"properties": {
"cast": {
"$ref": "Video.Cast",
"name": "cast"
},
"episode": {
"default": "0",
"type": "integer",
"name": "episode"
},
"episodeguide": {
"default": "",
"type": "string",
"name": "episodeguide"
},
"genre": {
"$ref": "Array.String",
"name": "genre"
},
"imdbnumber": {
"default": "",
"type": "string",
"name": "imdbnumber"
},
"mpaa": {
"default": "",
"type": "string",
"name": "mpaa"
},
"originaltitle": {
"default": "",
"type": "string",
"name": "originaltitle"
},
"premiered": {
"default": "",
"type": "string",
"name": "premiered"
},
"rating": {
"default": "0",
"type": "number",
"name": "rating"
},
"ratings": {
"type": "any",
"name": "ratings"
},
"runtime": {
"default": "0",
"description": "Runtime in seconds",
"type": "integer",
"name": "runtime"
},
"season": {
"default": "0",
"type": "integer",
"name": "season"
},
"sorttitle": {
"default": "",
"type": "string",
"name": "sorttitle"
},
"studio": {
"$ref": "Array.String",
"name": "studio"
},
"tag": {
"$ref": "Array.String",
"name": "tag"
},
"tvshowid": {
"$ref": "Library.Id",
"name": "tvshowid",
"required": true
},
"uniqueid": {
"$ref": "Media.UniqueID",
"name": "uniqueid"
},
"userrating": {
"default": "0",
"type": "integer",
"name": "userrating"
},
"votes": {
"default": "",
"type": "string",
"name": "votes"
},
"watchedepisodes": {
"default": "0",
"type": "integer",
"name": "watchedepisodes"
},
"year": {
"default": "0",
"type": "integer",
"name": "year"
}
}
}</syntaxhighlight>}}

==== Video.Fields.Episode ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.Episode",
"items": {
"description": "Requesting the cast, ratings, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"plot",
"votes",
"rating",
"writer",
"firstaired",
"playcount",
"runtime",
"director",
"productioncode",
"season",
"episode",
"originaltitle",
"showtitle",
"cast",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"tvshowid",
"dateadded",
"uniqueid",
"art",
"specialsortseason",
"specialsortepisode",
"userrating",
"seasonid",
"ratings"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.Movie ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.Movie",
"items": {
"description": "Requesting the cast, ratings, showlink, streamdetails, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"director",
"trailer",
"tagline",
"plot",
"plotoutline",
"originaltitle",
"lastplayed",
"playcount",
"writer",
"studio",
"mpaa",
"cast",
"country",
"imdbnumber",
"runtime",
"set",
"showlink",
"streamdetails",
"top250",
"votes",
"fanart",
"thumbnail",
"file",
"sorttitle",
"resume",
"setid",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"premiered",
"uniqueid"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.MovieSet ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.MovieSet",
"items": {
"enums": [
"title",
"playcount",
"fanart",
"thumbnail",
"art",
"plot"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.MusicVideo ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.MusicVideo",
"items": {
"description": "Requesting the streamdetails and/or tag field will result in increased response times",
"enums": [
"title",
"playcount",
"runtime",
"director",
"studio",
"year",
"plot",
"album",
"artist",
"genre",
"track",
"streamdetails",
"lastplayed",
"fanart",
"thumbnail",
"file",
"resume",
"dateadded",
"tag",
"art",
"rating",
"userrating",
"premiered"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.Season ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.Season",
"items": {
"enums": [
"season",
"showtitle",
"playcount",
"episode",
"fanart",
"thumbnail",
"tvshowid",
"watchedepisodes",
"art",
"userrating"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Fields.TVShow ====
'''Extends:'''
* ''[[#Item.Fields.Base|Item.Fields.Base]]''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"extends": [
"Item.Fields.Base"
],
"id": "Video.Fields.TVShow",
"items": {
"description": "Requesting the cast, ratings, uniqueid and/or tag field will result in increased response times",
"enums": [
"title",
"genre",
"year",
"rating",
"plot",
"studio",
"mpaa",
"cast",
"playcount",
"episode",
"imdbnumber",
"premiered",
"votes",
"lastplayed",
"fanart",
"thumbnail",
"file",
"originaltitle",
"sorttitle",
"episodeguide",
"season",
"watchedepisodes",
"dateadded",
"tag",
"art",
"userrating",
"ratings",
"runtime",
"uniqueid"
],
"type": "string"
}
}</syntaxhighlight>}}

==== Video.Rating ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''boolean'' default = false ]
* ''number'' rating
* [ ''integer'' votes = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Video.Rating",
"type": "object",
"properties": {
"default": {
"default": "false",
"type": "boolean",
"name": "default"
},
"rating": {
"type": "number",
"name": "rating",
"required": true
},
"votes": {
"default": "0",
"type": "integer",
"name": "votes"
}
}
}</syntaxhighlight>}}

==== Video.Ratings ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Video.Ratings",
"type": "object"
}</syntaxhighlight>}}

==== Video.Ratings.Set ====
'''Type:''' ''mixed''
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Video.Ratings.Set",
"type": "object"
}</syntaxhighlight>}}

==== Video.Resume ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''number'' position = "0" ]
* [ ''number'' total = "0" ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Video.Resume",
"type": "object",
"properties": {
"position": {
"default": "0",
"type": "number",
"name": "position"
},
"total": {
"default": "0",
"type": "number",
"name": "total"
}
}
}</syntaxhighlight>}}

==== Video.Streams ====
'''Type:''' ''mixed''
<br />
'''Properties:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
* [ ''object'' audio ]
* [ ''object'' subtitle ]
* [ ''object'' video ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"id": "Video.Streams",
"type": "object",
"properties": {
"audio": {
"items": {
"properties": {
"channels": {
"default": 0,
"type": "integer"
},
"codec": {
"default": "",
"type": "string"
},
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "audio"
},
"subtitle": {
"items": {
"properties": {
"language": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"name": "subtitle"
},
"video": {
"items": {
"properties": {
"aspect": {
"default": 0,
"type": "number"
},
"codec": {
"default": "",
"type": "string"
},
"duration": {
"default": 0,
"type": "integer"
},
"height": {
"default": 0,
"type": "integer"
},
"width": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"name": "video"
}
}
}</syntaxhighlight>}}

== Notifications ==
=== Application ===
==== Application.OnVolumeChanged ====
The volume of the application has changed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' muted
* ''integer'' volume
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The volume of the application has changed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"muted": {
"type": "boolean",
"name": "muted",
"required": true
},
"volume": {
"type": "integer",
"name": "volume",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== AudioLibrary ===
==== AudioLibrary.OnCleanFinished ====
The audio library has been cleaned.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The audio library has been cleaned.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnCleanStarted ====
An audio library clean operation has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "An audio library clean operation has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnExport ====
An audio library export has finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''integer'' failcount = "0" ]
* [ ''string'' file ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "An audio library export has finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"failcount": {
"default": "0",
"type": "integer",
"name": "failcount"
},
"file": {
"default": "",
"type": "string",
"name": "file"
}
},
"type": "object",
"name": "data"
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnRemove ====
An audio item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the removal is being performed within a transaction.''
* ''[[#Notifications.Library.Audio.Type|Notifications.Library.Audio.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "An audio item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the removal is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"$ref": "Notifications.Library.Audio.Type",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnScanFinished ====
Scanning the audio library has been finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Scanning the audio library has been finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnScanStarted ====
An audio library scan has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "An audio library scan has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== AudioLibrary.OnUpdate ====
An audio item has been updated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the update is being performed within a transaction.''
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "An audio item has been updated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the update is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== GUI ===
==== GUI.OnDPMSActivated ====
Energy saving/DPMS has been activated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Energy saving/DPMS has been activated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnDPMSDeactivated ====
Energy saving/DPMS has been deactivated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Energy saving/DPMS has been deactivated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnScreensaverActivated ====
The screensaver has been activated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The screensaver has been activated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== GUI.OnScreensaverDeactivated ====
The screensaver has been deactivated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' shuttingdown
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The screensaver has been deactivated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"shuttingdown": {
"type": "boolean",
"name": "shuttingdown",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Input ===
==== Input.OnInputFinished ====
The user has provided the requested input.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The user has provided the requested input.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Input.OnInputRequested ====
The user is requested to provide some information.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''string'' title ]
* ''string'' type
* ''string'' value
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The user is requested to provide some information.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"title": {
"type": "string",
"name": "title"
},
"type": {
"type": "string",
"name": "type",
"required": true
},
"value": {
"type": "string",
"name": "value",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Player ===
==== Player.OnAVChange ====
Audio- or videostream has changed. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
Audio- or videostream has changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnAVStart ====
Will be triggered on playback start if the first frame was drawn. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
Will be triggered on playback start if the first frame was drawn. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnPause ====
Playback of a media item has been paused. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnPlay ====
Playback of a media item has been started. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Playback of a media item has been started. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnPropertyChanged ====
A property of the playing items has changed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Player.Notifications.Player|Player.Notifications.Player]]'' player
* [ ''[[#Player.Property.Value|Player.Property.Value]]'' property ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A property of the playing items has changed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"player": {
"$ref": "Player.Notifications.Player",
"name": "player",
"required": true
},
"property": {
"$ref": "Player.Property.Value",
"name": "property"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnResume ====
Playback of a media item has been resumed. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
Playback of a media item has been resumed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnSeek ====
The playback position has been changed. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Player.Notifications.Player.Seek|Player.Notifications.Player.Seek]]'' player
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The playback position has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item"
},
"player": {
"$ref": "Player.Notifications.Player.Seek",
"name": "player",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnSpeedChanged ====
Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# '''' data
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"$ref": "Player.Notifications.Data",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Player.OnStop ====
Playback of a media item has been stopped. If there is no ID available extra information will be provided.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''boolean'' end ''Whether the player has reached the end of the playable item(s) or not''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"end": {
"description": "Whether the player has reached the end of the playable item(s) or not",
"type": "boolean",
"name": "end",
"required": true
},
"item": {
"$ref": "Notifications.Item",
"name": "item"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== Playlist ===
==== Playlist.OnAdd ====
A playlist item has been added.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''[[#Notifications.Item|Notifications.Item]]'' item ]
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A playlist item has been added.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"item": {
"$ref": "Notifications.Item",
"name": "item"
},
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"name": "position"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Playlist.OnClear ====
A playlist item has been cleared.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A playlist item has been cleared.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== Playlist.OnRemove ====
A playlist item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Playlist.Id|Playlist.Id]]'' playlistid
* [ ''[[#Playlist.Position|Playlist.Position]]'' position ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A playlist item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"playlistid": {
"$ref": "Playlist.Id",
"name": "playlistid",
"required": true
},
"position": {
"$ref": "Playlist.Position",
"name": "position"
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== System ===
==== System.OnLowBattery ====
The system is on low battery.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The system is on low battery.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnQuit ====
Kodi will be closed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''integer'' exitcode
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Kodi will be closed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"exitcode": {
"type": "integer",
"name": "exitcode",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnRestart ====
The system will be restarted.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The system will be restarted.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnSleep ====
The system will be suspended.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The system will be suspended.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== System.OnWake ====
The system woke up from suspension.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The system woke up from suspension.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

=== VideoLibrary ===
==== VideoLibrary.OnCleanFinished ====
The video library has been cleaned.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "The video library has been cleaned.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnCleanStarted ====
A video library clean operation has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A video library clean operation has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnExport ====
A video library export has finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* [ ''integer'' failcount = "0" ]
* [ ''string'' file ]
* [ ''string'' root ]
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A video library export has finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"failcount": {
"default": "0",
"type": "integer",
"name": "failcount"
},
"file": {
"default": "",
"type": "string",
"name": "file"
},
"root": {
"default": "",
"type": "string",
"name": "root"
}
},
"type": "object",
"name": "data"
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnRemove ====
A video item has been removed.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the removal is being performed within a transaction.''
* ''[[#Notifications.Library.Video.Type|Notifications.Library.Video.Type]]'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A video item has been removed.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"transaction": {
"description": "True if the removal is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"$ref": "Notifications.Library.Video.Type",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnScanFinished ====
Scanning the video library has been finished.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "Scanning the video library has been finished.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnScanStarted ====
A video library scan has started.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A video library scan has started.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"type": "null",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

==== VideoLibrary.OnUpdate ====
A video item has been updated.
'''Parameters:'''
<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
# ''string'' sender
# ''object'' data
'''Properties:'''
* ''[[#Library.Id|Library.Id]]'' id
* [ ''integer'' playcount = "-1" ]
* [ ''[[#Optional.Boolean|Optional.Boolean]]'' transaction ] ''True if the update is being performed within a transaction.''
* ''string'' type
</div>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang=javascript enclose="div">{
"description": "A video item has been updated.",
"params": [
{
"type": "string",
"name": "sender",
"required": true
},
{
"properties": {
"id": {
"$ref": "Library.Id",
"name": "id",
"required": true
},
"playcount": {
"default": "-1",
"type": "integer",
"name": "playcount"
},
"transaction": {
"description": "True if the update is being performed within a transaction.",
"$ref": "Optional.Boolean",
"name": "transaction"
},
"type": {
"type": "string",
"name": "type",
"required": true
}
},
"type": "object",
"name": "data",
"required": true
}
]
}</syntaxhighlight>}}

== See also ==
* [[JSON-RPC API]]
* [[JSON-RPC API/v4|JSON-RPC API v4 (Eden)]]
* [[JSON-RPC API/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[JSON-RPC API/v8|JSON-RPC API v8 (Krypton)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

[[Category:Development]]

JSON-RPC API

2019-07-25T07:01:57Z

DaveBlake: Remove v9 reference. The Leia verion is v10 and no accurate page has been created for v10 yet will all the changes

{{mininav|[[Development]]}}

{{JSON-RPC API nav}}
<br />

{{cleanup}}

JSON-RPC is a HTTP- and/or raw TCP socket-based interface for communicating with Kodi. It replaces the deprecated [[HTTP API]], and offers a more secure and robust mechanism in the same format. It is based upon the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification].

Each method in the interface can have different security needs which means one client may be allowed to only control playback while another can only read and manipulate the library. In version 2 (first stable) and 4 all clients are granted full authority but will later be forced to ask for privileges and the user of Kodi will have to grant said client access. The design of JSON-RPC is that most methods should behave roughly the same and maintain consistency while hiding the mechanics of Kodi from the client creator.

In Kodi JSON-RPC can be accessed over a variety of transports and has been designed from the ground up to be flexible to allow control over new transports easily. Some of the transports have different limitations which will be enforced upon the interaction over that transport. As an example HTTP transports allow response and downloading of files while the raw TCP transport allows response and notifications (events and information Kodi sends to its clients). Depending on the client's needs it will choose one (or many) of the available transports.<br />

== Enabling JSON-RPC ==
Since the interface is available on many transports enabling it depends on the transport.
* Python: Always enabled
* HTTP: In System/Settings/Network/Services activate ''Allow control of Kodi via HTTP'' (see [[Webserver#Enabling the webserver|Enabling the webserver]])
* TCP: In System/Settings/Network/Services activate ''Allow programs on this system to control Kodi'' for localhost access only and ''Allow programs on other systems to control Kodi'' for access from other computers as well

Note: The [[EventServer]] is a different interface for sending remote keypresses to Kodi, and must be enabled separately, some programs may use both interfaces.

== Transports & Functionalities ==
=== Transports ===
==== Python ====
The ''Python'' transport can only be used by Kodi addons through the '''executeJSONRPC''' method provided by the '''xbmc''' python library. As it must be available to every addon in an Kodi installation it must not be enabled or disabled by the user.

==== HTTP ====
The ''HTTP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP] protocol. Because this transport allows applications outside Kodi to control Kodi, it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user.

===== POST =====
Third-party applications can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in HTTP [http://en.wikipedia.org/wiki/POST_(HTTP) POST] requests to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc</pre>

Starting with Frodo nightly builds it is mandatory to set the HTTP header field '''Content-Type: application/json'''

===== GET =====
Third-party application can access Kodi's JSON-RPC API by sending JSON-RPC requests embedded in a HTTP GET parameter called ''request''. The JSON-RPC request must be URL encoded and sent to the following URL
<pre>http://<your-ip>:<your-port>/jsonrpc?request=<url-encoded-request></pre>

==== TCP ====
The ''TCP'' transport can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP] protocol. Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by opening a TCP [http://en.wikipedia.org/wiki/Internet_socket socket] on port 9090 (this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file) and sending raw JSON-RPC requests over that socket. Please note that no delimiters are provided in between notifications and/or responses. As such, your client needs to be able to deal with this, eg. by counting and matching curly braces ({}).

==== WebSocket ====
The ''WebSocket'' transport has been added since Version 5 and can be used by third-party applications running on the same machine as Kodi or on a different machine which can access the machine running Kodi using the [http://en.wikipedia.org/wiki/WebSocket Websocket] protocol. The supported versions are 8 (draft [http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 hybi-10]) and 13 ([http://tools.ietf.org/html/rfc6455 RFC 6455]). Because this transport allows applications outside Kodi to control Kodi it has to be manually enabled (see [[#Enabling JSON-RPC|Enabling JSON-RPC]]) by the user. Once enabled, third-party applications can access Kodi's JSON-RPC API by sending a WebSocket protocol handshake to the following URI
<pre>ws://<your-ip>:<configured tcp port>/jsonrpc</pre>
It is important to send the handshake on the port of Kodi's TCP server (by default 9090, but this port can be configured in the [[Advancedsettings.xml#<jsonrpc>|advanced settings]] file). After having successfully finished the handshake third-party applications can send WebSocket protocl messages over that connection.

=== Functionalities ===
==== Response ====
The ''Response'' functionality is the only functionality that should be present in every transport available as it describes the functionality to respond to a JSON-RPC request with a valid JSON-RPC response (be it an error message or an actual response).

==== Notifications ====
The ''Notifications'' functionality includes both server-side (from the server to clients) and client-side (from clients to the server) notifications. A JSON-RPC notification is a valid JSON-RPC request with no ''id'' property. Following the JSON-RPC 2.0 specification any JSON-RPC request with no ''id'' must be considered as a notification and the receiver must not send a response upon a notification.

In the specific case of Kodi, server-side notifications are used to inform clients about certain events to relieve clients of the need to periodically poll for certain events. Furthermore there are two ways of client-side notifications. Using [[/#JSONRPC.NotifyAll|JSONRPC.NotifyAll]] it is possible to ask Kodi to relay the message in the JSON-RPC request to all other connected clients. The second way is to send JSON-RPC requests without an ''id'' property in case the client does not care about the response (e.g. the method [[/#Player.Stop|Player.Stop]] does not return any useful information to the client).

==== Direct file download ====
The ''Direct file download'' functionality is the ability to directly download files from Kodi by calling [[/#Files.Download|Files.Download]]. In this case the term ''direct'' means that the download happens within the JSON-RPC response of the [[/#Files.Download|Files.Download]] request.

==== Redirected file download ====
The ''Redirected file download'' functionality is the ability to indirectly download files from Kodi by calling [[/#Files.PrepareDownload|Files.PrepareDownload]] and using the data received in the response to download the file over a different protocol (like HTTP, FTP ...) or another socket. As the ''Redirected file download'' is very transport specific, it must be handled separately for every transport supporting it.

=== Comparison ===
The following table shows all the available transports and what functionalities they support
{| class="prettytable" style="margin-right: 0;"
!style="padding-left: 5px; padding-right: 10px;" colspan="2"|Transport
!style="padding-left: 10px; padding-right: 10px;"|Response
!style="padding-left: 10px; padding-right: 10px;"|Notifications
!style="padding-left: 10px; padding-right: 10px;"|Direct file<br />download
!style="padding-left: 10px; padding-right: 10px;"|Redirected file<br />download
|-
|style="padding-left: 5px;" colspan="2"|[[Python Development|Python]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/Transmission_Control_Protocol TCP]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right:5px;" rowspan="2"|[http://en.wikipedia.org/wiki/HTTP HTTP]
|style="padding-left: 5px; padding-right:5px;"|POST
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right:5px;"|GET<sup>1</sup>
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;" colspan="2"|[http://en.wikipedia.org/wiki/WebSocket WebSocket]<sup>1</sup>
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|}
<sup>1</sup> Added in Version 5

== API versions ==
The JSON-RPC API exposed by Kodi is constantly extended to provide better and more functionality to third party applications. For that reason Kodi provides a version information through the '''JSONRPC.Version''' method. The rule is that odd version numbers describe an API state, that is not stable and under heavy development whereas even version numbers describe a stable API. Therefore the version number can be used by third-party clients to check if their application might not be fully compatible with the JSON-RPC API exposed by a user's Kodi installation.

Starting with XBMC v12 (Frodo) we started using a new versioning system (<major>.<minor>.<patch>) for the JSON-RPC API. Frodo stable is version 6.0.0 and from now on with every bugfix the <patch> part of the version is increased, with every feature addition to the API, the <minor> version is increased (and the <patch> version reset to 0) and with every backwards incompatible change, the <major> version is increased.

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!colspan="6"|JSON-RPC 2.0 specification
!colspan="5"|Transports
|-
!style="padding-left: 5px; padding-right: 5px; width: 6em; text-align: left;"|API Version
!style="padding-left: 10px; padding-right: 10px; width: 5em;"|Version
!style="padding-left: 10px; padding-right: 10px; width: 4em;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Method calls
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(server-side)
!style="padding-left: 10px; padding-right: 10px;"|Notifications<br />(client-side)
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-name
!style="padding-left: 10px; padding-right: 10px;"|Parameters<br />by-position
!style="padding-left: 10px; padding-right: 10px;"|Batch requests

!style="padding-left: 10px; padding-right: 10px;"|Python
!style="padding-left: 10px; padding-right: 10px;"|TCP
!style="padding-left: 10px; padding-right: 10px;"|HTTP POST
!style="padding-left: 10px; padding-right: 10px;"|HTTP GET
!style="padding-left: 10px; padding-right: 10px;"|WebSocket
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v2|Version 2]]
|style="padding-left: 5px; padding-right: 5px;"|10.0
|style="padding-left: 5px; padding-right: 5px;"|Dharma
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v3|Version 3]] / [[/v4|4]]
|style="padding-left: 5px; padding-right: 5px;"|pre-11 / 11.0
|style="padding-left: 5px; padding-right: 5px;"|Eden
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v5|Version 5]] / [[/v6|6]]
|style="padding-left: 5px; padding-right: 5px;"|pre-12 / 12.0
|style="padding-left: 5px; padding-right: 5px;"|Frodo
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.0
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.1
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|13.2
|style="padding-left: 5px; padding-right: 5px;"|Gotham
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.0
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.1
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|14.2
|style="padding-left: 5px; padding-right: 5px;"|Helix
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.0
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.1
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|15.2
|style="padding-left: 5px; padding-right: 5px;"|Isengard
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.0
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v6|Version 6]]
|style="padding-left: 5px; padding-right: 5px;"|16.1
|style="padding-left: 5px; padding-right: 5px;"|Jarvis
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px; padding-right: 5px;"|[[/v8|Version 8]]
|style="padding-left: 5px; padding-right: 5px;"|17.0
|style="padding-left: 5px; padding-right: 5px;"|Krypton
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}

|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}<sup>1</sup>
|{{yes}}
|-
|}
<sup>1</sup>For information requests only, actions require POST

{| class="prettytable" style="margin-right: 0;"
!colspan="3"|Release
!|JSONRPC.Version
|-
!style="padding-left: 10px; padding-right: 10px;"|Date
!style="padding-left: 10px; padding-right: 10px;"|Version
!style="padding-left: 10px; padding-right: 10px;"|Codename
!style="padding-left: 10px; padding-right: 10px;"|["version"]
|-
|18 December 2010
|10.0
|Dharma
|2
|-
|10 March 2011
|10.1
|Dharma
|2
|-
| style="background:#eee;" |24 March 2012
| style="background:#eee;" |11.0
| style="background:#eee;" |Eden
| style="background:#eee;" |4
|-
|29 January 2013
|12.0
|Frodo
|{"major":6,"minor":0,"patch":0}
|-
|18 March 2013
|12.1
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|03 May 2013
|12.2
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
|24 December 2013
|12.3
|Frodo
|{"major":6,"minor":0,"patch":3}
|-
| style="background:#eee;" | 04 May 2014
| style="background:#eee;" | 13.0
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 05 June 2014
| style="background:#eee;" | 13.1
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
| style="background:#eee;" | 17 August 2014
| style="background:#eee;" | 13.2
| style="background:#eee;" | Gotham
| style="background:#eee;" | {"major":6,"minor":14,"patch":3}
|-
|23 December 2014
|14.0
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|30 January 2014
|14.1
|Helix
|{"major":6,"minor":21,"patch":2}
|-
|26 March 2014
|14.2
|Helix
|{"major":6,"minor":21,"patch":2}
|-
| style="background:#eee;" | 21 July 2015
| style="background:#eee;" | 15.0
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 16 August 2015
| style="background:#eee;" | 15.1
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
| style="background:#eee;" | 19 October 2015
| style="background:#eee;" | 15.2
| style="background:#eee;" | Isengard
| style="background:#eee;" | {"major":6,"minor":25,"patch":2}
|-
|21 February 2016
|16.0
|Jarvis
|{"major":6,"minor":32,"patch":4}
|-
|24 April 2016
|16.1
|Jarvis
|{"major":6,"minor":32,"patch":5}
|-
| style="background:#eee;" | 5 February 2017
| style="background:#eee;" | 17.0
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 20 March 2017
| style="background:#eee;" | 17.1
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 23 May 2017
| style="background:#eee;" | 17.2
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 24 May 2017
| style="background:#eee;" | 17.3
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 22 August 2017
| style="background:#eee;" | 17.4
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 23 October 2017
| style="background:#eee;" | 17.5
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
| style="background:#eee;" | 14 November 2017
| style="background:#eee;" | 17.6
| style="background:#eee;" | Krypton
| style="background:#eee;" | {"major":8,"minor":0,"patch":0}
|-
|}

== Documentation ==
Kodi's JSON-RPC API has been designed to be self-documented i.e. a call to [[/#JSONRPC.Introspect|JSONRPC.Introspect]] results in a JSON-RPC response containing a documentation for all the available methods and data types. While this documentation is very incomplete and partly wrong for [[/v2|version 2]] it is provided as a full [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON schema] starting with [[/v3|version 3]]. As the documentation retrieved in that way is always specific to the used version of Kodi, it is (especially for development versions) the best documentation available and should be preferred over the wiki documentation as the latter always documents the API of the latest development.

== Debugging ==
=== Output format ===
To be able to support easier debugging of (third-party) development using the JSON-RPC API, the JSON output generated by Kodi can be pretty-printed by setting
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
</jsonrpc>
</syntaxhighlight>
in the [[Advancedsettings.xml#.3Cjsonrpc.3E|advancedsettings.xml]]. Default JSON output will be in compact format to minimize sent data (especially useful for mobile devices).

=== Direct interaction ===
To be able to test some methods of Kodi's JSON-RPC API, it can be of great help to be able to send a single hand-written JSON-RPC request to Kodi to see its effect and the generated response. Depending on the transport protocol used there are different possibilities to do that:

==== TCP ====
With a [http://en.wikipedia.org/wiki/Telnet telnet] connection (using [http://en.wikipedia.org/wiki/PuTTY PuTTY] on Windows or telnet on Linux) to port 9090 of the machine running Kodi it is possible to send and receive raw json data to/from Kodi. {{see also|SSH}}

==== HTTP ====
A simple way of manually sending HTTP requests containing a JSON-RPC request to Kodi is using the [http://chrome.google.com/extensions/detail/fhjcajmcbmldlhcimfajhfbgofnpcjmb Simple REST Client] extension for Google's Chrome/Chromium browser. It allows defining a URL and the HTTP request type ('''POST''' is what we need). The actual JSON-RPC request can be defined in the '''Data''' field and then sent to Kodi.

== See also ==
* [[/v2|JSON-RPC API v2 (Dharma)]]
* [[/v4|JSON-RPC API v4 (Eden)]]
* [[/v6|JSON-RPC API v6 (Frodo - Jarvis)]]
* [[/v8|JSON-RPC API v8 (Krypton)]]

== External links ==
* [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]
* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

== Examples ==
These examples take their base from v4. Any that require a higher version will be marked.

[[JSON-RPC API/Examples]]

[[Category:Manual]]
[[Category:Development]]

Settings/Media/Music

2019-05-26T15:59:49Z

DaveBlake: Clarification of some settings

{{MusicLibraryCreate}}
{{bigger|This category contains the settings for how information for music is collected, stored, shown and navigated.}}
__TOC__

== Creating Your Music Library ==
Have you arrived at this page by following the Music Library Creation Guide? If yes, then all you are required to do is check that your settings match the default settings of Section 4. The images show the default settings.

== All ==
[[File:Settings_media_music_all.JPG|500px]]
{|
These settings apply to both File View mode and when viewing the music library.
|}
=== Track naming template ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| The track naming template is a format mask made up of certain mask characters that represent specific music data and simple format instructions like italic. The track naming template controls how names of songs are displayed in the UI '''when sorted by track number'''. In order to function properly in File View mode, this requires tag reading to be enabled. The default setting is [%N.]%A-%T
<section begin="Track naming template" />
{| class="prettytable"
|-
! scope="row"| Music Data
| TrackNumber || DiscNumber || Artist || Title || Album || Genre || Year || FileName || Duration || Date || Rating || File Size || User Rating
|-
! scope="row"| Mask Characters
| style="text-align:center;" | %N
| style="text-align:center;" | %S
| style="text-align:center;" | %A
| style="text-align:center;" | %T
| style="text-align:center;" | %B
| style="text-align:center;" | %G
| style="text-align:center;" | %Y
| style="text-align:center;" | %F
| style="text-align:center;" | %D
| style="text-align:center;" | %J
| style="text-align:center;" | %R
| style="text-align:center;" | %I
| style="text-align:center;" | %r
|}
<section end="Track naming template" />
{| class="prettytable"
!colspan="2" style="width:150px; text-align:left" | Format Characters
!style="width:10px; text-align:left;" |
!colspan="2" style="text-align:left"| Usage Example
|-
! scope="row"| Bold
| [[B]...[/B]] ||
| style="background-color:#d3d3d3;" | Raw tag
| [%N] [[I]%A[/I]] - %B : [[B]%T[/B]]
|-
! scope="row"| Italic
| [[I]...[/I]] ||
| style="background-color:#d3d3d3;" | Output
| [track nr.] ''artist'' - album : '''title'''
|}
|}

=== Search for thumbs on remote shares ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When this option is enabled, Kodi will search for thumbs on remote shares including DVD and CD. Due to the long seek/read times required to perform this function this will slow the listing of network folders quite dramatically (particularly if there are many items that have no thumbs). The default setting is enabled. The recommended setting is disabled
|}

== Files ==
[[File:Settings_media_music_files.JPG|500px]]
{|
These settings apply to File View mode only.
|}

=== Enable tag reading ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When viewing music files in File View read the embedded tag information (for those files that have not already been scanned into the library). When enabled File View will be able to display the song name along with other details rather than just the file name. However reading tags from every music file in real time can make viewing them slow, especially for folders with a lot of music files or when accessed over a network. It is recommended that you can “Scan” your songs into the library by following the guide. Among many advantages this will allow File View to show additional song details without having to re-read tags everytime. The default setting is Enabled.
|}
{{-}}

<section begin="Settings Media Music Library" />
== Library ==
[[File:SettingsMediaMusic-leia2.jpg|500px]]

=== Show "All items" entry ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show an "All items" entry on the music library screens, e. g. "All albums" or "All artists". The default setting is Enabled.
|}

=== Show song and album artists ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| When enabled both song and album artists are shown. When disabled only album artists are shown, artists that appear only on songs on compliation albums or as guest artist on an album by another artist are excluded. This effects what artists are shown when browsing the default artists node. Use is a personal choice. The default setting is Enabled.
|}

=== Use artist sortname when sorting by artist ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When Enabled, this setting will change the order Artists are listed in from using the name to using the sortname (if one has been provided in tagging). So for example ''Taylor Swift'' with a sort name of ''Swift, Taylor'' will be see in the ''S'' not the ''T''.
|}

=== Prefer online information ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| With this enabled some artist and album data in the library, which had been derived from music file tags, will be overwritten by information that is downloaded from the scraper site or from a NFO file. For a list of library fields and tags that will be overwritten see [[NFO_files/Music]]. To clarify, this will not modify the music file themselves in any way, only the library entries. However this option is being deprecated, only enable if you are absolutely sure you want to do it and understand the consequences. It can not be used compensate for bad tagging of music files. The default setting is disabled.
|}

=== Fetch additional information during updates ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| With this enabled album and artist information will be automatically fetched, via scrapers from remote sites or NFO files, as a final phase of library scanning. This can be a slow process if you have a large music collection. If this is the initial creation of your library, and you are unsure about the quality of your music file tagging, leave this setting disabled (rather than try to fetch extra data). The additional information can be fetched later from the Context Menu in the Artists and Albums listing. The default setting is Disabled.
|}

=== Artist information folder ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the folder where artist nfo files and local artwork are located.
|-
| '''See Also:'''
| '''''[[Artist information folder]]'''''
|}

=== Prefer online album art ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| With this enabled, when no local album cover exists online art will be used. Any cover images embedded in music files will only be used where neither local art nor online art is available. This is useful if the covers embedded in music files are low resolution and the user would prefer the higher quality results fetched by the album information provider. The default setting is Disabled.
|-
| '''See Also:'''
| '''''[[Music artwork#Library_Artwork_Source_Priority| Library Artwork Source Priority]]'''''
|}

=== Default provider for album information ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Selects the default album information provider, see the add-ons manager for options. The default setting is the Universal Album Scraper.
|}

=== Default provider for artist information ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Selects the default artist information provider. The default setting is the Universal Artist Scraper
|}
<section end="Settings Media Music Library" />

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Music artwork

2019-05-26T15:24:15Z

DaveBlake: /* Library Artwork Source Ppriority */

{{Artwork_Contents}}
{{mininav|[[:Category:Music_library|Music Library Index]] |[[Artwork]]}}

<section begin="intro" />Music artwork are images directly related to an artist or an album, preferably of high quality, that are displayed when viewing the album or artist entry in the library. They may also be used as visualizations while playing music. The artwork support in {{Kodi}}'s music library is very flexible and able to display many types of artwork, depending on the skin in use.<section end="intro" />

{{red|'''It is important to note the following:'''}}
* To enable '''local artwork''' from separate image files to be added when scanning new media items, the image files must be arranged in a certain folder hierarchy.
** For Albums see '''''[[Music tagging#Folder_and_File_Structure| Music folder and file structure]]''''' for a basic option
** For Artists see '''''[[Artist information folder]]''''' which is new for v18 and separates Artist artwork from music files and overcomes the inherent limitations of that previous method.
* Each artwork type, other than the basic thumb and fanart types (that are sufficient for Estuary), must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' in order to be added to the library automatically during scanning or scraping.
* Kodi 18 is required for expanded artwork type support in the music library.

= Artist Information Folder =
:{{main|Artist information folder}}
{{#lst:Artist_information_folder|intro}}

= Fetching Additional Artwork =
v18 introduces an '''experimental''' feature that will auto-load extended artwork from local files without the use of additional add-ons, and can be adapted to future changes in the results returned by the music information providers (album and artist scrapers) without changes to Kodi itself. It is considered an advanced feature. Usage and practicality of this feature are being monitored and may change in later releases.

The common types of art available for items in the Music library can be categorised as follows:

{| class="prettytable"
! colspan="8" style="text-align:left; background-color:#72d2f7;" | Artist Artwork
|-
! colspan="2" style="text-align:left;" | Basic Art Types
! colspan="1" style="text-align:left;" |
! colspan="5" style="text-align:left;" | Extended Art Types
|-
|style="width:80px; text-align:left;"|fanart
|style="width:80px; text-align:left;"|thumb
! colspan="1" style="text-align:left;" |
|style="width:80px; text-align:left;"|banner
|style="width:80px; text-align:left;"|clearart
|style="width:80px; text-align:left;"|clearlogo
|style="width:100px; text-align:left;"|fanart''xx'' (extrafanart)
|style="width:80px; text-align:left;"|landscape
|-
! colspan="12" style="text-align:left; background-color:#72d2f7;" | Album Artwork
|-
! colspan="2" style="text-align:left;" | Basic Art Types
! colspan="1" style="text-align:left;" |
! colspan="8" style="text-align:left;" | Extended Art Types
|-
|style="width:80px; text-align:left;"|thumb
|style="width:80px; text-align:left;"|
! colspan="1" style="text-align:left;" |
|style="width:80px; text-align:left;"|back
|style="width:80px; text-align:left;"|discart
|style="width:80px; text-align:left;"|spine
|-
|}

'''Basic'''- These types of artwork require no special setup as they have always been natively fetched by {{kodi}} from local files and by the default music scrapers. These are displayed by Estuary.

'''Extended'''- Many skins are more rich in art than Estuary and can show extended artwork as well. Historically cdART (now defunct) was used to fetch and apply this art, and more recently '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' is used.

Users now have the facility to load any type of artwork without add-ons providing either they have that art locally or use a scraper that returns that type of art. However the default skin Estuary does not display the extended art types, '''if you are using Estuary then there is no need to consider this feature.'''

To enable this feature first the art types must be whitelisted in advancedsettings.xml, an example is given below.

<syntaxhighlight lang="xml" line='line'>
<advancedsettings>
<musiclibrary>
<artistextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>fanart1</arttype> 
<arttype>fanart2</arttype> 
<arttype>fanart3</arttype>
<arttype>landscape</arttype>
</artistextraart>
<albumextraart>
<arttype>back</arttype>
<arttype>discart</arttype>
<arttype>spine</arttype>
</albumextraart>
</musiclibrary>
</advancedsettings>
</syntaxhighlight>

:'''Note:''' The code box adds common extended artwork that many skins will utilise. It is your choice which extended artwork you add. If you add additional to that shown, ensure the skin has support to display it.

Then decide where the art is going to come from, most likely this will be via the music scrapers. The '''[[Add-on:Universal_Artist_Scraper|Universal Artist Scraper]]''' and '''[[Add-on:Universal_Album_Scraper|Universal Album Scraper]]''' for v18 can fetch extended types of artwork. They currently have settings that enable what art types are fetched as well as the remote sources these come from (see images below). This over complicates matters, where things come from will always be part of the scraper settings, but the decision what to apply belongs to Kodi and the whitelist. For now ensure that the types of art you want are enabled here too, so the scraper fetches a full list of the art available, but these settings should be simplified in due course.

Extended artwork can also be provide in correctly located and named local files. The general rule for local extended artwork file naming is <arttype>.<ext>, for where these need to be located see below.

Extended art from local files is automatically picked up and applied as part of music library scanning or scrapin When local art of the types in the whitelist is not found then the first avialable art of that type returned by the scraper is automatically applied as part of scraping.

The process applied is as described in ''[[Artwork#What Artwork is Used Automatically | What Artwork is Used Automatically]]''

<gallery mode="packed-overlay" widths="500px" heights="283px">
File:UniversalArtistScraper03.jpg|Artist Scraper- Enable Extra Artwork
File:UniversalAlbumScraper02.jpg|Album Scraper- Enable Extra Artwork
</gallery>

= Local Artwork =
All types of artwork can be read from and saved to local artwork files.

Local artist artwork can be located in the '''[[Artist information folder]]''' (shown in image) where the name of the artist subfolder does matter, '''or''' a '''[[Music tagging#Folder and File Structure| common unique artist folder]]''' among your music files if Kodi can find one (where the name of the subfolder does not matter).

Local album artwork can be located in the '''[[Music tagging#Folder and File Structure| album folder]]''' (shown in image). This folder is identified from the music files it contains, not the folder name.

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalMusicArtwork01.jpg
</gallery>

= Embedded Artwork =
<section begin="EmbeddedArtwork" />As of v17, Kodi supports embedded album art in mp3 files with ID3v2 tags, WMA/WMV files with ASF tags, FLAC files with Vorbis comments/Xiph tags, and mp4 files with itunes tags. It does not currently support embedded album art in APEv2 tags or Ogg files.<section end="EmbeddedArtwork" />

Kodi cannot recognise multiple embedded images in a song file. It can only extract the "Front Cover" image assuming they have been tagged correctly within the file. All other images are ignored.

A list of embedded tags recognised by Kodi is available
; '''''see also: [[Music_tagging#Tags_Kodi_reads|Tags Kodi Reads]]'''''

= Library Artwork Source Priority =
Music artwork is automatically allocated using the following order:

# Local artwork files
#* Album and artist artwork from local files always takes precedence.
# Album cover artwork embedded in tracks (when "Prefer scraped album art" is disabled)
#* By default the first embedded front cover art found while processing the music files of the album is taken as the album cover.
# First available scraped art
#* The music information providers (scrapers) return lists of available artist and album artwork. The first of each the type of art for that artist or album is applied as the art if none has already been found locally.
#* Scraping only happens as part of library update if the option in Kodi ''Settings -> Media -> Music -> "Fetch additional information during updates"'' is enabled
# Album cover artwork embedded in tracks (when"Prefer scraped album art" is enabled)
#* Use of cover art from the music files can be unprioritised by enabling the "Prefer scraped album art" setting. This could be desirable if the embedded art is of low quality compared to what the scrapers may return.

Songs also have associated art, most of it is the art of the related album and artists but they can also have individual “thumb” type art automatically set. The thumb type artwork displayed for a '''song''' on both player OSD and library screens has a fallback strategy:
# Art embedded in that music file provided that all songs on an album do '''not''' have the same embedded art
# Falls back to album thumb. This is either from
## Local image file ''e.g. folder.jpg''
## The common embedded art when that is the same in every music file in the album and "Prefer scraped album art" is disabled
## The remotely scraped album thumb result (when "Prefer scraped album art" is enabled or neither a) or b) are found)

This means that if the embedded art is a jumble, say one music file with a different image, then the musc player OSD will show the individual embedded art not the album cover however it is set.

= File View Mode =
File View Mode is similar to using the file manager provided by your operating system- eg Explorer in Windows systems. It is simply a file browser that allows you to view and play your media even though it has not been scanned and/or scraped into the Library. This mode only provides the added benefits of album and artist extended artwork and information when viewing music files that have been scanned into the library (so album and artist enries exist) and these have been sucessfully scraped. However basic artwork from local files is supported for music files that are not scanned into the library.

For non-scanned music files and folders artwork in file view mode is as follows:
*The only type of art supported is ''[[Artwork_types#thumb|thumb]]'' artwork
*Every folder in the hierarchical structure can have an associated “thumb” artwork. The “thumb” for the folder on display is picked up from any suitably named image file found in that folder.
*A thumb for individual music files will be read from tag data embedded in the music file providing the '''''[[Settings/Media/Music#Enable_tag_reading|Enable tag reading]]''''' setting is enabled. Only front cover is currently supported.
*These images are loaded automatically and cached when the folder or music file is first viewed

= {{Kodi}} version updates =
* {{Kodi}} 17 and before did not have the "Artist information folder" option, so could have trouble identifying a local folder for artist artwork in some cases.
* {{Kodi}} 17 and before was '''limited to just "fanart" and "thumb" for artist images''' and '''"thumb" for album images''', it did not have the flexibility to add a wide variety of artwork. Expanded artwork is new and still being explored from multiple angles, so not all skins or scrapers or tools will support a full selection.
** Skins for versions of Kodi prior to v18 could use Skin Helper Service for some support of expanded artwork, but that has been superseded with this Kodi built-in functionality.
* {{Kodi}} 18 adds a flexible collection of artwork for music items, but each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' so that {{Kodi}} will add the specified artwork from scrapers and the file system automatically.

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Music tagging

2019-05-26T08:30:45Z

DaveBlake: /* Tags {{kodi}} reads */ add MUSICBRAINZ_RELEASEGROUPID tag

{{MusicLibraryCreate}}
{{mininav|[[Music library]]}}

= Introduction =
This page provides the following information:

*How the Music section differs from the Video section of {{kodi}}
*The recommended method to organise your music files
*The recommended method for tagging your music files
*Explanation of some commonly misunderstood Music File Tags
*The Audio Files and Tags that {{kodi}} reads and uses

= Understanding the Music Library =
<section begin="understanding" />There is a fundamental differences between video library operation and the music library operation:
*The video library is based on using the filenames or folder names to obtain online data. If they are incorrectly named, then there are no scraper results and there will be no library entry.
*'''The music library is based on scanning tags embedded in the music files.''' It ignores the folder names and structure and file names. Proper tagging is essential to ensure the library is populated correctly. Having slight variations in the tags for artist and album names could mean duplicated and unwanted entries.<section end="understanding" />

= Folder and File Structure =
Although {{kodi}} ignores the folder structure and the names of the folders and files, the structure of your folders is important as it affects the operation of other functions such as Import/Export, nfo files and Artwork. For example, if you have all your music files in one folder (which is possible), then you lose the ability to use local nfo files, local artwork, and the import/export module will not function correctly.

The following is {{kodi}} '''best practice'''. Remember use a layout that is nice for you, but '''tag accurately.'''

== Files ==
Song files require suitable tagging for use in {{kodi}}. While {{kodi}} can scan minimal tags into the library, it can lead to errors in the library and subsequent scraping. We recommend music files are tagged with MusicBrainz as detailed below.

Remember that {{kodi}} does not extract any information from the filename, so the filename is your choice.

== Folders ==
{{kodi}} is quite flexible with the folder structure. The diagram below is an '''example'''. You should group your albums in a manner that makes sense to you.

To ensure {{kodi}} and other add-on processes can function efficently and correctly, the following is recommended.
*Songs from the same album should be in the one folder
*If there is more than one disk in the release, each disk should be in a sub-folder containing the songs from that disk

The following is a typical folder structure:

f:\ ....................................(root)
|__Artist Information ..................(Artist Information Folder)
|
|__Artist Music .......................(source folder)
| |__ Madonna ........................(artist folder)
| | |__ Beautiful Stranger (1999) ..(album folder)
| | | |__ Song 1
| | | |__ Song 2
| | | |__ Song 3 etc
| | |__ Bedtime Stories (1994) .....(album folder)
| | | |__ Song 1
| | | |__ Song 2
| | | |__ Song 3 etc
| | |__ Like A Prayer (1989) .......(album folder)
| | | |__ Song 1
| | | |__ Song 2
| | | |__ Song 3 etc
| |__ Simply Red .....................(artist folder)
| |__ Picture Book (1985) ........(album folder)
| |__ Song 1
| |__ Song 2
| |__ Song 3 etc
|
|__Compilations .......................(Source)
| |__ Essential Eighties .............(album folder)
| | |__ Song 1
| | |__ Song 2
| | |__ Song 3 etc
| |__ 100% Hits- Best of 2005 ........(album folder)
| |__ Song 1
| |__ Song 2
| |__ Song 3 etc
|
|__Classical ..........................(Source)
|
|__Audiobooks .........................(Source)

== Sources ==
A source folder contains your media collection- in this case Music. This folder is then set as a Source in {{kodi}} which enables {{kodi}} to access your Music.

In the diagram from the previous section ''Artist Music, Compilations, Classical'' and ''Audiobooks'' are Sources.

Setting and Scanning of Sources is covered in detail in the next step of the guide.

= Tagging =
Most music files purchased or ripped by your favourite software have only minimal metadata embedded. Normally this is not a problem and works very well on simple music players.
<br /><br />
{{kodi}}, being an advanced and feature rich player, requires greater accuracy with the embedded tags. Any slight variance in, for example, the Album name between the tracks from the same album will see multiple entries in the library for that Album. It is not uncommon to have a single album split into three similarly named albums. Also true for Artists. It is for this reason that there is a separation of the Scanning and Scraping processes for Music. The initial scan allows you to find and correct errors in tagging, before scraping.
<br /><br />
This table has examples of errors in tagging, which will cause duplicated entries in the library...

{|class="prettytable"
!Similar Name 1 || Similar Name 2 || Note
|-
|György Ligeti || Gyorgy Ligeti || Accented and unaccented names will create duplicate entries
|-
|The Best of || The Very Best Of || Inconsistent naming between songs of the same album and/or artist will cause duplicated entries
|-
|Madonna || Madonnna || Spelling mistakes will cause duplicated entries for albums and/or artists
|-
|Sting || Sting and The Police || Seen as two separate and unrelated Artists
|}

As {{kodi}} scans your music collection, it copies the data contained in those tags into the {{kodi}} music database. The benefits of this are:
*Once the scan is complete, the tags are not accessed again
*All information is now obtained from the database. This has the benefit of dramatically increasing efficency and speed when navigating the library.
*Now that a database entry exists, you are able to scrape additional information from online sources. This is covered later in the guide.

== MusicBrainz ==
'''{{kodi}} has strong support for MusicBrainz tagging. It is highly recommended that users tag their music files using MusicBrainz Picard.'''

'''MusicBrainz Picard''' is the music file tagger software that can access the MusicBrainz database to locate metadata to embed into your music files. MBIDs are useful because names are not unique. The bigger and more diverse your music collection is, the more likely you will encounter Artists with the same name.

The advantages of tagging with MusicBrainz are:
*They allow you to have different artists with the same name in your library e.g. "John Williams" the classical guitarist and "John Williams" the film music composer and conductor.
*They negate inconsistencies in artist naming e.g. having "Peter Tchaikovsky" on some albums and "Piotr Czajkowski" on others
*They allow you to have more than one release of an album in your library e.g. the normal and deluxe editions of an album
*They clearly identify the artist and album in ways that names alone can not. This can then be used to accurately scrape additional artist and album information and locate the correct artwork
*They allow the scraping process to be more efficient, otherwise an extra call is made to try and get an mbid first to use at the scraping sites, and each request from Musicbrainz must be throttled to 1 per sec which will slow the scraping process.

Below is a screenshot of the main screen of the Picard software. A brief description of the layout as follows.

*Top Left Box- Folder listing of your music collection
*Top Centre Box- Albums are dragged and dropped here in preparation for matching and tagging. Pressing ''Lookup'' (greyed out) will commence the lookup process
*Top Right Box- Matching albums are displayed here and your songs are overlayed. In the screenshot, songs 01, 08 and 09 have been matched to the suggested album. If all songs match and you agree the correct album was located, simply pressing Save will tag the album with the tags displayed in the Bottom Tag Box.
*Bottom Tag Box - Selecting a song from the Top Right Box will display all available tag fields (left column), the current tags in the music file (Original Value column) and the MusicBrainz tags to be embedded in the music file (right column).

The example in the image below shows the following:
*Most tags are missing (original value column)
*The top three yellow entries are incorrect (original value column) and the corrections are in the right column
*The green entries in the right column indicate new tags to be embedded
*The black entries at the bottom of the list indicate no change to the existing tags as they are correct or not used by MusicBrainz.

<gallery mode="packed" widths="1000px" heights="563px">
File:MusicBrainzPicard01.jpg
</gallery>

Although Picard is very easy to use, you must avoid blindly accepting everything offered by the software. It is important that you confirm the correct album was located. Due to the global nature of the database, there are many releases for a single album. These releases differ between countries, usually due to copyright requirements. This may lead you to inadvertendly select the incorrect release for your album, even though it is named exactly the same. The differences between releases may be as simple as different song ordering or the inclusion of additional bonus tracks.

For the best tagging experience set the correct options in Picard, particularly the "Clear Existing Tags" option in settings. This option means that any old tags that may cause issues are wiped, preserving only the musicbrainz tagging. It will also be wise to tag using ID3v2.4 compatibility.

<gallery mode="packed" widths="500px" heights="283px">
File:Picard options.jpg
</gallery>

== albumartists ==
{{Kodi}} requires the '''albumartists''' tag to correctly handle multiple album artists on the same album. This tag is not a default tag in MusicBrainz Picard and other tagging software. <ref> https://forum.kodi.tv/showthread.php?tid=334729&pid=2760161#pid2760161 </ref>

To include this tag add a new script under ''Options > Options > Scripting > Add new script'' and include the following code...
<syntaxhighlight lang="xml">
$setmulti(albumartists,%_albumartists%)
</syntaxhighlight>

<gallery mode="packed" widths="500px" heights="283px">
File:Picard Script.JPG
</gallery>

Once the music files are tagged, avoid modifying the MusicBrainz tags unless you clearly understand the relationship of the MBID's and the other related tags. For example, embedding MBID tags, but then editing the Artist tag or Album Artist tag will result in incorrect entries in the library.

For example:
*If you need to change the artist or album artist tag you also have to edit the matching artist mbid tag and album artist mbid tag.
*If Kodi finds a release mbid it will expect the artist mbid tags to also be present.

:'''''See: [https://musicbrainz.org/ MusicBrainz Website]'''''
:'''''See: [https://picard.musicbrainz.org/ MusicBrainz Picard Software]'''''

----
<center>{{red|'''The remainder of this page deals with special use cases or provides information for technical interest and reference only. It can be safely disregarded if these do not apply to you'''}}</center>
----

<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Adding_music_to_the_library|Scanning Music into Library]]}} </div>

= Ripping CD's =
{{main|Ripping CDs}}
{{#lst:Ripping CDs|intro}}

There is no requirement to use the {{Kodi}} CD Ripper. If you are comfortable using other ripping software, then we recommend you continue using that software.

= Cue Sheets =
{{#lst:Cue_sheets|intro}}

{{kodi}} does provide basic support for using cue sheets to define individual tracks when an entire CD has been ripped into a single music file. However the information provided by the cue sheet standard is much more limited than that of standard tagging, hence to enjoy the full music library features it is recommended that tracks are ripped into separate files and fully tagged.
<br />
{{red|If you do not use Cue Sheets you can safely move onto the next step.}}
<br />
;{{see also|Cue_sheets}}

= Streams =
{{#lst:Internet_video_and_audio_streams|intro}}

;{{see also|Internet_video_and_audio_streams}}

= Technical Explanation: File tags =
For many categories, such as genres and artists, {{kodi}} supports multiple values in the one field. By default it uses the character sequence " / " to divide the entry into multiple values. This divider may be changed via [[advancedsettings.xml]].

== Resolving Compilations and Multiple Artists ==
{{red|Applies to v17 and below. v18 introduced the [[Artist information folder]] which solved these problems. You are encouraged to update to v18}}

{{kodi}} reads the ''Album Artist'' tag in ID3, Ogg, APE and MP4 tags and uses it if available to assign an artist to the album (independently of the track's artist information). This is the "Album Artist" tag (in ID3 this is represented by the "TPE2" tag; in vorbiscomment (ogg) files "ALBUMARTIST", "ALBUM ARTIST" and "ENSEMBLE" are all supported). Multiple artists for either a track or album artist can be specified in "Artist1 / Artist2 / Artist3" format.

If no ''Album Artist'' tag exists, {{kodi}} will use the first (primary) artist from the tracks as the ''Album Artist''. Essentially we do a string comparison of all the track artists, and assign the common artists as the ''Album artist''. This is generally the TPE1 tag in ID3.

As many users don't yet use the ''Album Artist'' tag, {{kodi}} has an additional filter system for identifying compilation albums, where each track normally has a different artist. As {{kodi}} scans a folder, it does the following:
# Identifies albums based on ''Album'' name alone in the folder and groups the songs that have the same ''Album'' name together as an album.
# Runs through each album's assigned songs. If there is 2 or more tracks with the same ''Track'' number, the group of songs must come from 2 or more albums, so the ''Album'' name is ruled out as a possible compilation.
# If any of the songs assigned to the ''Album'' name have an ''Album Artist'' tag, then {{kodi}} assumes the user knows what they're doing, and this album is also ruled out from being a compilation.
# If two or more songs assigned to the ''Album'' name then have different primary artists, then the ''Album'' name is considered to be a group of songs from a compilation, and the ''Various Artists''" tag is assigned as the album artist.
# Otherwise, if all the songs have the same primary artist but don't have the same full artist list (eg a song or two has an additional artist) then the album is assigned the primary artist as it's ''Album Artist'', and we assume the additional artists are guest artists.

== Ratings in ID3 tags ==
Ratings in ID3 tags are read via the POPM field, and (if this doesn't exist) in a custom (TXXX) field named "RATING". For the RATING field, we accept 1-5 as valid ratings. For the POPM field things are more complicated, as there is no established standard in place. We currently most closely respect what Mediamonkey does, and also have some support for what Windows Media Player 11 does. The POPM tag takes a value from 0..255, with 0 meaning no rating, 1 the worst, and 255 the best. We currently map these as follows:

{| class="prettytable"
|-
!'''POPM value''' || '''Star rating'''
|-
|0 ||
|-
|1 || '''*''' This is a special case for Windows Media Player
|-
| 2-8 ||
|-
|9-49 || '''*'''
|-
|50-113 ||'''**'''
|-
|114-167 || '''***'''
|-
|168-218 || '''****'''
|-
|219-255 ||'''*****'''
|}

= Audio Formats & Tags =

== Supported Audio Formats ==
Although the list of playable formats is quite comprehensive, it is not accurate to say that every {{kodi}} installation will play every format. The ability to play some of the more obscure formats will depend upon the version of {{kodi}} and the operating system in use. Some formats will require the installation of add-ons.

{{#lst:Advancedsettings.xml|musicextensions}}

;{{See also|Advancedsettings.xml}}

== Supported Metadata Containers ==
The following metadata containers are supported by {{kodi}}

{| class="prettytable"
|-
! Metadata Container || Note
|-
|[[wikipedia:APEv2 tag|APEv2 tag]] ||
|-
|[[wikipedia:Advanced_Systems_Format|ASF]] ||
|-
|Generic Tag || A generic tag for basic data from other odd file types
|-
|[[wikipedia:ID3|ID3]] || v1, v2.3 and v2.4
|-
|[[wikipedia:MPEG-4 Part 14#Metadata|MP4]] ||
|-
|[https://xiph.org/ Xiph.org] || Vorbis Comments
|}

== Common File & Tag Combination ==
You will notice that not all the tags listed in the section ''Supported Audio Formats'' above are listed in the following table. Those formats that are ommitted do not have provision to support embedded tags. If your collection contains any of these unsupported formats, you will be unable to scan the music into the library. Your options are:
#Convert your audio file to a supported format and tag using MusicBrainz Picard. (recommended)
#Access your music via the File Manager or via File View

{{kodi}} supports the following common Audio File and Tag Formats

{| class="wikitable sortable" style="text-align:center;"
|-
!| Metadata container
!| Additional Filename extensions
|-
| [[wikipedia:APEv2 tag|APEv2 tag]] || ape, mp3, aac, wv, mpc
|-
| [[wikipedia:Advanced_Systems_Format|ASF]] || asf, wmv, wma
|-
| Generic Tag || it, mod, module, nst, wow, s3m, xm
|-
| [[wikipedia:ID3|ID3 v1]] || mp3, aac
|-
| [[wikipedia:ID3|ID3 v2]] || mp3, aac, tta, aif, aiff, wav, flac
|-
| iTunes [[wikipedia:MPEG-4 Part 14#Metadata|MP4]] || .3g2 .m4a .m4b .m4p .m4r .m4v .mp4
|-
|[https://xiph.org/ Xiph.org] || flac, oga, ogg, opus
|}

Note:
*FLAC files- xiph tags override id3v2 tags
*mp3 files can have either id3 or APE tags
*mka, dsf, dff - ID3v2 format read but are handled by ffmpeg tag reader and it does not support all tags from IDE standard)

== Tags {{kodi}} reads ==
{{kodi}} will scan the following tags embedded in the music file. The column ''{{kodi}} Version'' indicates the version of {{kodi}} that the tag was introduced, and will work in subsequent versions.

<section begin="TagTable" />
{| class="wikitable sortable" style="text-align:center;"
|-
! style="text-align:left;"| {{kodi}} Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|-
|v18
|MUSICBRAINZ_RELEASEGROUPID
|MUSICBRAINZ RELEASE GROUP ID
|MUSICBRAINZ_RELEASEGROUPID
| ----:com.apple.iTunes:MusicBrainz Release Group Id
|MusicBrainz/Release Group Id
|-
|v18
|ARTISTSORT
|TSOP
|ARTISTSORT
|
|WM/ArtistSortOrder
|-
|v18
|ALBUMARTISTSORT
|TS02
|ALBUMARTISTSORT
|soaa
|WM/AlbumArtistSortOrder
|-
|v18
|COMPOSERSORT
|TSOC
|COMPOSERSORT
|soco
|WM/ComposerSortOrder
|-
|v18
|WRITER
|WRITER
|WRITER
|
|-
|}
<section end="TagTable" />

= References =
<references />

{{Top}}

<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Adding_music_to_the_library|Scanning Music into Library]]}} </div>

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Artwork

2019-05-26T07:39:32Z

DaveBlake: /* Obtaining Artwork */ typo

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} }}

<section begin="intro" />The use of artwork will transform your mundane media player into a showpiece to be proud of, especially when teamed up with your favourite skin. Kodi will allow you to display Movie Posters, Fanart, Album Covers, Actor and Artist images to name a few. Install the Kodi slideshow add-on, and you will have a constant display of video or music fanart to brighten your entertainment room.<section end="intro" />

'''{{red|The {{kodi}} scrapers automatically download artwork with little input required by the user. These pages are for those users that want greater control over their artwork by saving artwork locally or creating their own.}}'''

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Make use of the Table of Contents and the NavBox located at the top right of the page. Information common to all categories is located on this page and the Artwork Type page.

'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''

= Obtaining Artwork =
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the various Kodi scrapers (also known as ''information providers'').

== Scrapers ==
The defautl sources for information and artwork that are used by the default scrapers are:

Movies- [https://fanart.tv/ Fanart.tv] and [https://www.themoviedb.org/ The MovieDB]<br />
TV Shows- [https://fanart.tv/ Fanart.tv] and [https://www.themoviedb.org/ The MovieDB]<br />
Music- [https://fanart.tv/ Fanart.tv] and [http://www.theaudiodb.com/ The AudioDB]<br />

Artwork from these sites can also be downloaded manually by visiting and searching the sites and saving the artwork locally as described on the linked pages.

== Media Managers ==
There is a range of software that can create nfo files and download artwork and save them to the correct location and correct naming. They perform the same process and function as the Kodi Scraping operation does natively, but they do not add any entries into the Kodi library. Instead they create what is known as '''[[NFO_files|NFO files]]'''. This file holds all the metadata for that particular movie, tv show or music. The software will also download associated artwork from the scraper site. Kodi can then read this file and scrape it into the library along with the artwork.

Although these programs are quick and easy to use, they are more suited for use where a movie or tv show is not listed at the scraper site. You are then able to create the metadata from scratch. You would normally use this for, say, home movies, sporting events or other items that are not listed at the scraper site.

It is always best to use Kodi for the normal mainstream scrapes and the Media Managers for the non-listed movie, tv show and music scrapes.
; {{see also|NFO_files}}

== Web Search ==
Using an online search engine can help you discover individual artworks, or additional sites where artwork is hosted. When downloading, check that the resolution is of an acceptable standard. Also pay respect to any copyright notices that are attached to the artwork.

Once downloaded, they must be named and saved correctly for the artwork to be visible to Kodi.

== Create Your Own ==
{{main|Artwork/Types}}
So you are not happy with the artwork the scraper downloaded? And you just can't find that perfect artwork by manually searching the internet. Then, you will just have to create your own. For those who are artistically minded and can easily navigate around image editing software, then you should be able to easily create your very own user-defined artwork on your computer. Only your imagination is the limit, but be mindful that the artwork needs to remain true to the movie or tv show it represents.

If you are unsure where to start, the following links may prove useful. Especially if you plan to share your masterpieces. If this is the case, it is best to stick to the posted guidelines.
*Fanart.TV- The premier repository for all things artwork. They have an in-depth guide for artwork requirements
:;''see : [https://fanart.tv/movie-fanart/<nowiki>Fanart.tv- Image Creation Guide</nowiki>]''
*The MovieDB- The go to movie scraper site for Kodi. In addition to metadata, they also hold a large repository of artwork that are created and uploaded to the site by people just like you. Read their easy to understand artwork creation guide.
:; ''see : [https://www.themoviedb.org/bible/image/59f7583e9251416e7100006e#59f758409251416e7100006f themoviedb- Image Creation Guide]''
*The TVDB- The go to TV Show scraper site for Kodi. In addition to metadata, they also hold a large repository of artwork devoted to TV Shows. Read their easy to understand artwork creation guide.
:; ''see : [http://www.thetvdb.com/wiki/index.php/Category:Images<nowiki>theTVDB- Image Creation Guide</nowiki>]''
*IMDB- A comprehensive listing of ensuring artwork is appropriate and suitable.
:; ''see : [https://contribute.imdb.com/updates/guide/images<nowiki>IMDB- Image Submission Guide</nowiki>]''
*TheAudioDB- The go to scraper site for all things music. They hold metadata on Artists, Albums and Songs with a large collection of music artwork.
:; ''see : [http://theaudiodb.com/forum/viewtopic.php?f=2&t=1<nowiki>TheAudioDB- Image Creation Guide</nowiki>]''

= What Artwork is Used Automatically =

== Local Art Comes First ==
'''Local artwork takes priority, so on update of both music and video libraries {{kodi}} will always use local artwork when it can find some. Only when there is no local artwork found, does {{kodi}} use the artwork that the scrapers can fetch from online sources.'''

'''It is important to note that once remote artwork for a movie, tv show, artist or album has been successfully scraped into the library (because there was no local art found when the scraper was run), Kodi will not look for local art to replace it on subsequent library updates.'''

If you have made changes to either local artwork and/or metadata (in the form of a nfo file), you must instruct Kodi to update using one of the following methods...
#If the Library has not yet been created, or the source has not yet been added
#*Ensure your artwork is named and saved correctly. Add the [[Media sources]] to Kodi and allow to update. Artwork will be cached
#This Movie/TV Show/Album/Artist is new and has not been added to the library yet
#*An Update Library will scrape and cache the artwork, or
#*For Videos, navigate Videos>Files, navigate to the item and call up the Information page. This will start an automatic scrape for that single item
#*For Music, navigate Music>Files, locate and highlight the new artist or album. From the context menu select ''Scan item to library''
#I added new artwork for Movie/TV Show/Album/Artist already in the library
#*For videos follow instructions for ''Kodi- Choose Art'' below
#*For music follow instructions in ''Kodi- Choose Art'' below
#I added new artwork for a lot of Movies/TV Shows/Music already in the library
#*Update each Movie/TV Show/Music manually using instructions in the previous option, or
#*Remove the Source and clean library. Re-add the source and allow the Update Library
:'''''See also: [[Updating_or_removing_videos|Update Video Library]]'''''
:'''''See also: [[Update_Music_Library#Scan_Library|Update Music Library]]'''''

== Available Artwork Found By Scrapers ==
Scraper results (and NFO files) can include multiple potential images for each single type of artwork. When a type of art has not been found locally then during scraping the first image will be automatically assigned to the media item so skins and other interfaces can access it for display. The full list from the scraper results will be saved for the "Choose art" dialog (even if using local artwork), where you can select a new image for any art type from those available online and of course local files.

'''Note:''' If you use a Media Manager to download local artwork and create [[NFO files]], the full list may not be available to use in "Choose art" as most, if not all, Media Managers strip out the additional artwork links.

= Choosing Art You Want =
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

'''Note: '''The following is based on the Video Library. Music Library follows the same process, but the screenshots will be slightly different for Choose Art- Artists and Choose Art- Albums

#Highlight the media item whose artwork you want to change.
#Call up the ''Information'' dialog, (Image 1)
#* For seasons and movie sets the "Choose Art" option is in the [[Context menu]].
#Select ''Choose Art''. (Image 1)
#From within this page, you will be given the option to select which type of artwork you would like to change. (Image 2)
#* If the type of artwork you would like to change is not listed, use the '''Add art type''' button to add it. An onscreen keyboard will be displayed. Enter the new type of artwork and select '''Ok'''.
#* Examples of artwork type are those listed in the following pages- eg clearlogo, clearart, banner etc...
#Once selected, you will then be provided with a list of available artwork at the scraper site, or you can navigate to a local or network location. (Image 3)
#Once you select the desired image, it will replace the existing image. You will be returned to the screen displayed in Image 2
#If you do not intend to change any other artwork types, simply Esc or Back out of the screen

<gallery widths=350px heights=200px>
File:Artwork-ChooseArt03.jpg|Image 1- Choose Art on the Information dialog
File:Artwork-ChooseArt01.jpg|Image 2- Select which type of artwork to change
File:Artwork-ChooseArt02.jpg|Image 3- List of available remote artworks from the scraped sites, as well as the ability to ''Browse'' local and network sources
File:Artwork-ChooseArt04.jpg|Image 4- Using the Refresh Method
</gallery>
An alternative method for Music and Video library:
#Choose ''Refresh'' as seen in Image 1.
#You will then be asked ''Locally stored information found. Ignore and refresh from Internet?'' (Image 4)
#*To scrape local metadata - Select '''No'''
#**If no local nfo file is available, Kodi will scrape metadata from the online scraper site
#**Local artwork still has priority. If no local artwork is found, {{Kodi}} will search the NFO file for valid links to artwork and download artwork if links are valid
#*To scrape online metadata (and ignore nfo file, if any) - Select '''Yes'''
#**Local artwork still has priority. If no local artwork is found, the scraper results are used to fetch artwork

= Add-ons to display artwork =
The following add-ons allow you to display your movie, TV show and music artwork.

== Screensavers ==
Want to do more with all that wonderful fanart? Install this Kodi screensaver. Just like a screensaver on computers from yesteryear, the Kodi screensaver will produce a slideshow of your Movie and TV Show fanart, or set it to display your Music Fanart. Don't like either of those? Then setup a directory with your own pictures and it can produce a screensaver from your selection of photos.
; {{see also|Add-on:Picture Slideshow Screensaver}}

= Managing Artwork =
There are a number of ways to maintain and improve Kodi's handling of the artwork.

== Cache ==
{{#lst:Artwork/Cache|intro}}
; {{see also|Artwork/Cache}}

== Recovering Disk Space ==
After years of use, it is expected that your system will gather some clutter- that being either orphaned artwork files or corrupted artwork which will not display.
; {{see also|HOW-TO:Reduce disk space usage}}
; {{see also|Artwork/Cache}}

=== Texture Cache Maintenance ===
{{#lst:Texture_Cache_Maintenance_utility|intro}}
; {{see also|Texture Cache Maintenance utility}}

== Import/Export ==

Kodi has the facility to export and import the library databases and in particular the artwork. The resolution of the artwork when exported is that used internally by Kodi, and may be lower than the original artwork. Export is the way to capture art that has been downloaded from a remote site as a local file.
; {{see also|Import-export library}}

= Accessing with skins and JSON-RPC =
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
; {{see also|Artwork/Accessing with skins and JSON-RPC}}

= Troubleshooting =
There are certain scenarios where attempting to replace existing artwork with new artwork, '''you may experience {{kodi}} refusing to load the new artwork'''. This occurs when replacing one artwork with another artwork having the same name. eg replacing ''poster.jpg'' with a new ''poster.jpg''.

Rest assured that the new image has been accepted, but due to the same filename, {{kodi}} may take upto 24 hrs to check the image hash, realise the image is different and clear out the cached image and replace it with the new one. This is intended behaviour. Further reading available in the following link

; {{see also|Artwork/Cache}}

= See Also =
*[[HOW-TO:Create Music Library]]<br>
*[[HOW-TO:Create Video Library]]<br><br>
*[[Add-on:The Movie Database]]<br>
*[[Add-on:Universal Album Scraper]]<br>
*[[Add-on:Universal Artist Scraper]]

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Artwork

2019-05-26T07:38:48Z

DaveBlake: /* Import/Export */ remove translocation

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} }}

<section begin="intro" />The use of artwork will transform your mundane media player into a showpiece to be proud of, especially when teamed up with your favourite skin. Kodi will allow you to display Movie Posters, Fanart, Album Covers, Actor and Artist images to name a few. Install the Kodi slideshow add-on, and you will have a constant display of video or music fanart to brighten your entertainment room.<section end="intro" />

'''{{red|The {{kodi}} scrapers automatically download artwork with little input required by the user. These pages are for those users that want greater control over their artwork by saving artwork locally or creating their own.}}'''

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Make use of the Table of Contents and the NavBox located at the top right of the page. Information common to all categories is located on this page and the Artwork Type page.

'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''

= Obtaining Artwork =
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the various Kodi scrapers (also known as ''informatio providers'').

== Scrapers ==
The defautl sources for information and artwork that are used by the default scrapers are:

Movies- [https://fanart.tv/ Fanart.tv] and [https://www.themoviedb.org/ The MovieDB]<br />
TV Shows- [https://fanart.tv/ Fanart.tv] and [https://www.themoviedb.org/ The MovieDB]<br />
Music- [https://fanart.tv/ Fanart.tv] and [http://www.theaudiodb.com/ The AudioDB]<br />

Artwork from these sites can also be downloaded manually by visiting and searching the sites and saving the artwork locally as described on the linked pages.

== Media Managers ==
There is a range of software that can create nfo files and download artwork and save them to the correct location and correct naming. They perform the same process and function as the Kodi Scraping operation does natively, but they do not add any entries into the Kodi library. Instead they create what is known as '''[[NFO_files|NFO files]]'''. This file holds all the metadata for that particular movie, tv show or music. The software will also download associated artwork from the scraper site. Kodi can then read this file and scrape it into the library along with the artwork.

Although these programs are quick and easy to use, they are more suited for use where a movie or tv show is not listed at the scraper site. You are then able to create the metadata from scratch. You would normally use this for, say, home movies, sporting events or other items that are not listed at the scraper site.

It is always best to use Kodi for the normal mainstream scrapes and the Media Managers for the non-listed movie, tv show and music scrapes.
; {{see also|NFO_files}}

== Web Search ==
Using an online search engine can help you discover individual artworks, or additional sites where artwork is hosted. When downloading, check that the resolution is of an acceptable standard. Also pay respect to any copyright notices that are attached to the artwork.

Once downloaded, they must be named and saved correctly for the artwork to be visible to Kodi.

== Create Your Own ==
{{main|Artwork/Types}}
So you are not happy with the artwork the scraper downloaded? And you just can't find that perfect artwork by manually searching the internet. Then, you will just have to create your own. For those who are artistically minded and can easily navigate around image editing software, then you should be able to easily create your very own user-defined artwork on your computer. Only your imagination is the limit, but be mindful that the artwork needs to remain true to the movie or tv show it represents.

If you are unsure where to start, the following links may prove useful. Especially if you plan to share your masterpieces. If this is the case, it is best to stick to the posted guidelines.
*Fanart.TV- The premier repository for all things artwork. They have an in-depth guide for artwork requirements
:;''see : [https://fanart.tv/movie-fanart/<nowiki>Fanart.tv- Image Creation Guide</nowiki>]''
*The MovieDB- The go to movie scraper site for Kodi. In addition to metadata, they also hold a large repository of artwork that are created and uploaded to the site by people just like you. Read their easy to understand artwork creation guide.
:; ''see : [https://www.themoviedb.org/bible/image/59f7583e9251416e7100006e#59f758409251416e7100006f themoviedb- Image Creation Guide]''
*The TVDB- The go to TV Show scraper site for Kodi. In addition to metadata, they also hold a large repository of artwork devoted to TV Shows. Read their easy to understand artwork creation guide.
:; ''see : [http://www.thetvdb.com/wiki/index.php/Category:Images<nowiki>theTVDB- Image Creation Guide</nowiki>]''
*IMDB- A comprehensive listing of ensuring artwork is appropriate and suitable.
:; ''see : [https://contribute.imdb.com/updates/guide/images<nowiki>IMDB- Image Submission Guide</nowiki>]''
*TheAudioDB- The go to scraper site for all things music. They hold metadata on Artists, Albums and Songs with a large collection of music artwork.
:; ''see : [http://theaudiodb.com/forum/viewtopic.php?f=2&t=1<nowiki>TheAudioDB- Image Creation Guide</nowiki>]''

= What Artwork is Used Automatically =

== Local Art Comes First ==
'''Local artwork takes priority, so on update of both music and video libraries {{kodi}} will always use local artwork when it can find some. Only when there is no local artwork found, does {{kodi}} use the artwork that the scrapers can fetch from online sources.'''

'''It is important to note that once remote artwork for a movie, tv show, artist or album has been successfully scraped into the library (because there was no local art found when the scraper was run), Kodi will not look for local art to replace it on subsequent library updates.'''

If you have made changes to either local artwork and/or metadata (in the form of a nfo file), you must instruct Kodi to update using one of the following methods...
#If the Library has not yet been created, or the source has not yet been added
#*Ensure your artwork is named and saved correctly. Add the [[Media sources]] to Kodi and allow to update. Artwork will be cached
#This Movie/TV Show/Album/Artist is new and has not been added to the library yet
#*An Update Library will scrape and cache the artwork, or
#*For Videos, navigate Videos>Files, navigate to the item and call up the Information page. This will start an automatic scrape for that single item
#*For Music, navigate Music>Files, locate and highlight the new artist or album. From the context menu select ''Scan item to library''
#I added new artwork for Movie/TV Show/Album/Artist already in the library
#*For videos follow instructions for ''Kodi- Choose Art'' below
#*For music follow instructions in ''Kodi- Choose Art'' below
#I added new artwork for a lot of Movies/TV Shows/Music already in the library
#*Update each Movie/TV Show/Music manually using instructions in the previous option, or
#*Remove the Source and clean library. Re-add the source and allow the Update Library
:'''''See also: [[Updating_or_removing_videos|Update Video Library]]'''''
:'''''See also: [[Update_Music_Library#Scan_Library|Update Music Library]]'''''

== Available Artwork Found By Scrapers ==
Scraper results (and NFO files) can include multiple potential images for each single type of artwork. When a type of art has not been found locally then during scraping the first image will be automatically assigned to the media item so skins and other interfaces can access it for display. The full list from the scraper results will be saved for the "Choose art" dialog (even if using local artwork), where you can select a new image for any art type from those available online and of course local files.

'''Note:''' If you use a Media Manager to download local artwork and create [[NFO files]], the full list may not be available to use in "Choose art" as most, if not all, Media Managers strip out the additional artwork links.

= Choosing Art You Want =
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

'''Note: '''The following is based on the Video Library. Music Library follows the same process, but the screenshots will be slightly different for Choose Art- Artists and Choose Art- Albums

#Highlight the media item whose artwork you want to change.
#Call up the ''Information'' dialog, (Image 1)
#* For seasons and movie sets the "Choose Art" option is in the [[Context menu]].
#Select ''Choose Art''. (Image 1)
#From within this page, you will be given the option to select which type of artwork you would like to change. (Image 2)
#* If the type of artwork you would like to change is not listed, use the '''Add art type''' button to add it. An onscreen keyboard will be displayed. Enter the new type of artwork and select '''Ok'''.
#* Examples of artwork type are those listed in the following pages- eg clearlogo, clearart, banner etc...
#Once selected, you will then be provided with a list of available artwork at the scraper site, or you can navigate to a local or network location. (Image 3)
#Once you select the desired image, it will replace the existing image. You will be returned to the screen displayed in Image 2
#If you do not intend to change any other artwork types, simply Esc or Back out of the screen

<gallery widths=350px heights=200px>
File:Artwork-ChooseArt03.jpg|Image 1- Choose Art on the Information dialog
File:Artwork-ChooseArt01.jpg|Image 2- Select which type of artwork to change
File:Artwork-ChooseArt02.jpg|Image 3- List of available remote artworks from the scraped sites, as well as the ability to ''Browse'' local and network sources
File:Artwork-ChooseArt04.jpg|Image 4- Using the Refresh Method
</gallery>
An alternative method for Music and Video library:
#Choose ''Refresh'' as seen in Image 1.
#You will then be asked ''Locally stored information found. Ignore and refresh from Internet?'' (Image 4)
#*To scrape local metadata - Select '''No'''
#**If no local nfo file is available, Kodi will scrape metadata from the online scraper site
#**Local artwork still has priority. If no local artwork is found, {{Kodi}} will search the NFO file for valid links to artwork and download artwork if links are valid
#*To scrape online metadata (and ignore nfo file, if any) - Select '''Yes'''
#**Local artwork still has priority. If no local artwork is found, the scraper results are used to fetch artwork

= Add-ons to display artwork =
The following add-ons allow you to display your movie, TV show and music artwork.

== Screensavers ==
Want to do more with all that wonderful fanart? Install this Kodi screensaver. Just like a screensaver on computers from yesteryear, the Kodi screensaver will produce a slideshow of your Movie and TV Show fanart, or set it to display your Music Fanart. Don't like either of those? Then setup a directory with your own pictures and it can produce a screensaver from your selection of photos.
; {{see also|Add-on:Picture Slideshow Screensaver}}

= Managing Artwork =
There are a number of ways to maintain and improve Kodi's handling of the artwork.

== Cache ==
{{#lst:Artwork/Cache|intro}}
; {{see also|Artwork/Cache}}

== Recovering Disk Space ==
After years of use, it is expected that your system will gather some clutter- that being either orphaned artwork files or corrupted artwork which will not display.
; {{see also|HOW-TO:Reduce disk space usage}}
; {{see also|Artwork/Cache}}

=== Texture Cache Maintenance ===
{{#lst:Texture_Cache_Maintenance_utility|intro}}
; {{see also|Texture Cache Maintenance utility}}

== Import/Export ==

Kodi has the facility to export and import the library databases and in particular the artwork. The resolution of the artwork when exported is that used internally by Kodi, and may be lower than the original artwork. Export is the way to capture art that has been downloaded from a remote site as a local file.
; {{see also|Import-export library}}

= Accessing with skins and JSON-RPC =
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
; {{see also|Artwork/Accessing with skins and JSON-RPC}}

= Troubleshooting =
There are certain scenarios where attempting to replace existing artwork with new artwork, '''you may experience {{kodi}} refusing to load the new artwork'''. This occurs when replacing one artwork with another artwork having the same name. eg replacing ''poster.jpg'' with a new ''poster.jpg''.

Rest assured that the new image has been accepted, but due to the same filename, {{kodi}} may take upto 24 hrs to check the image hash, realise the image is different and clear out the cached image and replace it with the new one. This is intended behaviour. Further reading available in the following link

; {{see also|Artwork/Cache}}

= See Also =
*[[HOW-TO:Create Music Library]]<br>
*[[HOW-TO:Create Video Library]]<br><br>
*[[Add-on:The Movie Database]]<br>
*[[Add-on:Universal Album Scraper]]<br>
*[[Add-on:Universal Artist Scraper]]

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Artist information folder

2019-05-07T06:31:52Z

DaveBlake: Remove repeated various artists compilation comment

{{MusicLibraryCreate}}
{{mininav|[[Music_library]] }}

<section begin="intro" />In v18 the concept of the Artist Information Folder is introduced as a new way to handle providing local artist artwork and information via nfo files. The Artist Information Folder is a user nominated folder that {{kodi}} will look in first for artwork or NFO files for ''any'' artist. <br>

This topic is of interest to those users that want to provide local artwork for artists, or capture their current artist art and additional data for transfer to another installation of {{kodi}}<section end="intro" />

= History =
In v17 and prior releases of {{kodi}} the ability to automatically fetch local art and information from NFO files depended upon the music files being in a strict '''Artist > Album > Songs''' folder structure.
{{kodi}} populated the basic library by using data embedded in the music files. It did not use the folder structure or filenames to populate the library, but it would try to identify a unique folder for each (album) artist and a unique folder for each album from the location of the related music files, and look there for art and additional information for the artist and album respectively.

Unfortunately not all music fits neatly under such a strict layout. For example:
*Collaboration albums with more than one album artist (very common in Classical music with composer, conductor and orchestra credited, but happens in pop when two artists in their own right make an album together).
*All the albums by an artist had to be on the same music source which made it difficult to organise libraries to suit personal preferences.

Art and additional information could only be provided for album artists, not those artists that only feature as a guest on some songs on an album by another artist or on a various artists compilation album, nor the other musicians and professionals that contribute to the production.

The way {{kodi}} tried to identify folders from their contents, combined with a slightly inaccurate music file arrangement, produced some unexpected art results that were often difficult to pin down. <ref>https://github.com/xbmc/xbmc/pull/12891</ref>

<section begin="intro1" />From v18 the Artist Information Folder can be used to resolve many issues with providing local art and additional information for Artists. Local artist art and nfo files can be provided without requiring a specific folder for music files, and artist NFO files can be kept separately from the music rather than jumbled with it. <section end="intro1" />

= FAQ =
{|
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Do I need to have an Artist Information Folder?
| Answer= No, {{kodi}} will continue to be backwards compatible and pick up artist art and NFO files from the same places it does for v17. Of course, if you choose not to use the Artist Information Folder you will still encounter the same limitations described above. Also if you do not have any local artist artwork or want to use NFO files then there is no need for one either.
}}
{{FAQ|
| BGcolor=
| Question= Why would I want to nominate a folder?
| Answer=*So that you can provide local art and NFO files for artists that are:
** involved in collaboration albums
** only song artists (no albums, only guests or on compilations)
** musicians or other contributors
* To keep artist art and data separate from music files.
* To handle having music from one artist spilt across many music sources.
If you have ever had the wrong local art appear in an odd place then you probably need it.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= How do I setup the Artist Information Folder?
| Answer= See Section 3- Recommended Setup<br>
The folder can be named in whatever way suits you and located with, or away from, your music files. We recommend away from your music files.
Once a folder has been created on your file system, set it as the Artist Information Folder in either one of two ways:
* In the settings page here... '''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]''''', or
* Via the Settings button on the Add to Library dialog that is displayed when you add a new music source. '''''See: [[Adding_music_to_the_library#Adding_Music_to_Library| Adding Sources]]'''''
}}
{{FAQ|
| BGcolor=
| Question= How is the individual artist information organised and populated?
| Answer= Any artist can have a subfolder within the Artist Information Folder which is named same as the artist name. Within that folder can be artwork and additional artist information as XML metadata in an '''''[[NFO_files/Music| NFO file]]''''' called ''artist.nfo''.

The artist folders can be created manually, however it is easiest to create the initial artist folders and contents using the export facility. See Section 4- Using Export. That way folders are created with the correct names, as slight differences in naming could prevent {{kodi}} from locating the artist. The artwork and NFO files can then be manually edited and the library refreshed.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= How does {{kodi}} use the contents?
| Answer= The artwork and NFO files in the Artist Information Folder are read by Kodi as part of scanning and scraping process. <br>
If you have made changes to the NFO Files for Artists already in your library, then these changes need to be '''Refreshed''' into the library.<br>
:'''''See: [[Update_Music_Library#Refresh_Artist|Refresh Artists]]'''''<br>
:'''''See: [[Update_Music_Library#Refresh_Album|Refresh Albums]]'''''<br>
To change existing artwork or to add missing artwork, either use the Refresh method above or manually change the artwork<br>
:'''''See: [[Music_artwork#Manually_Add_Artwork| Manually Add Artwork]]'''''

Note that the music library import facility does not make use of separate nfo files at all. Import only works on the single xml files that can be created via export. <br>
:'''''See: [[Import-export_library#Import_2| Music Library Import]]'''''
}}
{{FAQ|
| BGcolor=
| Question= Does the Artist Information Folder have to be separate from my music files?
| Answer= No, it is the user's choice but it will be less confusing if it is separate. Also note that using the export facility to populate the Artist Information Folder can result in thousands of artist folders. Decide if you want all these folders, containing just art and nfo files, mixed in with your other folders that contain music files.
Finally if you find the explanation in the next question confusing then just don’t do it, make it a separate folder somewhere else.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= What happens if I make the Artist Information Folder the same as my main music source?
| Answer=Say you have a folder called "mymusic" that contains all your music files under an '''Artist > Album > Songs''' folder structure, and you choose to make that the Artist Information Folder, then {{kodi}} will look first for artist artwork and nfo in folders in mymusic\<artistname> where <artistname> is the exact artist name. The names of your existing folders for each artist may match, or may not (remember {{kodi}} does not care how music folders are named). What you read as the same name may not be exactly the same. Say they match, then the art and NFO files in them will be found and used. But if all you want is to use your existing artist art and nfo files already in your music folder layout then setting the Artist Information Folder the same as a music source is unnecessary, {{kodi}} will look there anyway.<br>
For art and NFO for extra artists you can create (or let export create for you) additional artist folders along side your existing folders, however you will end up with some that have music and some that don't. Some of the artwork addons people have used already do this mixing of music and art only folders, so it may be familiar and if the artist folders are correctly named Kodi will start to pick up the art on scanning rather than have the addon set it. However for others being able to use the Artist Information Folder to separate art and music will be a relief.
}}
{{FAQ|
| BGcolor=
| Question= What happens when I have a separate Artist Information Folder but also leave artist NFO and artwork files above my music files?
| Answer= {{kodi}} will look first for the artist under the Artist Information Folder and use that artwork and NFO file. If it does not find a folder for the artist there, then for album artists only it falls back to looking for a suitable artist folder in an '''Artist > Album > Songs''' folder structure as it did for v17. <br>
There are a few more safety checks in v18 to try and avoid some of the cases of mistaken identity, but in doing that it may also not show such art in the one place it is wanted.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Does this affect Album artwork and NFO Files?
| Answer= No, this does not apply to albums. Local album artwork and NFO files still be looked in the folder common to all the music files for that album (if such a unique folder exists).<br>
If album related folders and files are located within the artist folders of the Artist Information Folder then they generally have no effect, unless the Artist Information Folder is the same as the music source and the music files are also located there.
}}
{{FAQ|
| BGcolor=
| Question= When using File View mode will I see the artwork from the Artist Information Folder?
| Answer= No, the Artist Information Folder is a music library feature. In file view you only see the artwork found in the folder you are browsing.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Why won't the scan pick up my artwork?
| Answer= There could be many different reasons for that, only some relate to the Artist Information Folder. <br>
'''''See: [[Music_artwork|Music Artwork]]'''''
}}
|}

= Recommended Setup =
A frequent question from users is ''what do you recommend?'', in the case of the Artist Information Folder the answer is simple: unless you have local artwork for artists, or want to enter artist information via NFO files there is nothing to do. For a first time {{kodi}} user the recommendation is to tag your music files accurately, scan them into the library and allow the scrapers to fetch additional artist and album information and artwork for you.

With v18 you can arrange your music files however you like and still have access to local art and NFO files. We would recommend that all the music files from an album are kept in a unique folder, perhaps with subfolders for each part of a multi-part set. Perhaps you choose to arrange those in artist folders of some kind, but that does not have to be strictly adhered too. You could divide a large music collection by genre (with an artist having albums in more than one), or by decade, or some broader music category e.g. Xmas music. Use an '''Artist > Album > Songs''' structure if it is convenient for you.

Once you start to extend your use of {{kodi}} then a number of situations can arise:
*you have artists that the scraper was unable to find information or art for
*you want to manually edit some of the information
*having selected particular art from the many choices the scraper has found, you want to backup that choice
*you want to transfer your current library to another installation of {{kodi}}

Now it is time to populate the Artist Information Folder with Artist folders. Use the ''Artists folders only'' method in the link below.

:'''''See: [[Import-export_library/Music|Import-Export Music Library]]'''''

= References =
<references />

{{top}}

<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Scraping_Music|Scraping Additional Music Data]]}} </div>

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Music tagging

2019-01-19T15:42:42Z

DaveBlake: /* Tags {{kodi}} reads */ add tags new in v18

{{MusicLibraryCreate}}

= Introduction =
This page, Music File and Tagging, provides the following information:

*How the Music section differs from the Video section of {{kodi}}
*How to organise your music files
*The recommended method for tagging your music files
*Explanation of some commonly misunderstood Music File Tags
*The Audio Files and Tags that {{kodi}} reads and uses

= Understanding the Music Library =
{{Red|'''The Music section of {{kodi}} has many differences to the Video section of {{kodi}}. It is important that you read this section to ensure your music and artwork are correctly scraped and displayed.'''}}
<br />

<section begin="understanding" />It is important to understand the fundamental difference between video library operation and the music library operation:
*The video library is based on using the filenames to obtain online data. If the video files are incorrectly named, then there are no scraper results and there will be no library entry.
*'''The music library is based on scanning tags embedded in the music files.''' It ignores the folder structure and file names you have created to store your music files. Basic and correct tagging is essential to ensure the library is populated correctly. Having slight variations in the tags for artist and album names could mean duplicated and unwanted entries.<section end="understanding" />
<br />

= Folder and File Structure =
Although {{kodi}} ignores the folder structure and the names of the folders and files, the structure of your folders is important as it affects the operation of other functions such as Import/Export, nfo files and Artwork. For example, if you have all your music files in one folder (which is possible), then you lose the ability to use local nfo files, local artwork, and the import/export module will not function correctly.

For this reason, {{kodi}} recommends the use of the following structure.

== Files ==
Remember that {{kodi}} does not extract any information from the filename. The only purpose the file name serves is to provide {{kodi}} a unique id to locate the file.

The name you use for your files is your choice, but it is important that they are:
#Consistent
#Make sense

Example file names:

*Using the simple Song Name only = ''Everybody Wants to Rule the World.flac'' <br />
*Using a more complex combination of Artist-Album-Song = ''Madonna-True Blue-Open Your Heart.flac''

If you would like to use track numbers in the file name, then ensure you include the disc number, even if there is only one disc. eg
*''0102 Everybody Wants to Rule the World.flac'' or ''D01T02 Everybody Wants to Rule the World.flac''
*''Madonna-True Blue-0106 Open Your Heart.flac'' or ''Madonna-True Blue-D01T06 Open Your Heart.flac''

Where 0102 = Disc 01 and Track 02

== Folders ==
Folders are used as follows:
#Album folders - Used to group '''songs''' from the same album into one folder
#Artist folders- Used to group '''albums''' from the same artist into one folder
#Source folder- Used to group '''Collections''' into one folder. (see next section)

The following is a typical recommended structure:

f:\ ....................................(root)
|__Artist Music .......................(source folder)
| |__ Madonna ........................(artist folder)
| | |__ Beautiful Stranger (1999) ..(album folder)
| | | |__ Song 1
| | | |__ Song 2
| | | |__ Song 3 etc
| | |__ Bedtime Stories (1994) .....(album folder)
| | | |__ Song 1
| | | |__ Song 2
| | | |__ Song 3 etc
| | |__ Like A Prayer (1989) .......(album folder)
| | | |__ Song 1
| | | |__ Song 2
| | | |__ Song 3 etc
| |__ Simply Red .....................(artist folder)
| |__ Picture Book (1985) ........(album folder)
| |__ Song 1
| |__ Song 2
| |__ Song 3 etc
|
|__Compilations .......................(Source)
| |__ Essential Eighties .............(album folder)
| | |__ Song 1
| | |__ Song 2
| | |__ Song 3 etc
| |__ 100% Hits- Best of 2005 ........(album folder)
| |__ Song 1
| |__ Song 2
| |__ Song 3 etc
|
|__Classical ..........................(Source)
|
|__Audio Books ........................(Source)

== Sources ==
A source folder contains your media collection- in this case Music. This folder is then set as a Source in {{kodi}} which enables {{kodi}} to access your Music. (remember, Kodi does not know where your media is until you tell it)

In the Video section of Kodi, you would set one, or more, sources for Movies, TV Shows, Music Videos, Home Movies etc. The Music section oparates along the same principle.

As an example, you would save your music folders into separate Sources for the following:
*'''Single Artist type Albums '''
**These are albums released by a single artist or band
**This source will contain the Artist / Album / Song structure
**Examples- Kate Bush, Kylie Minogue, Tears for Fears etc
*'''Various Artists or Compilation Albums'''
**These are albums that contain songs from many different artists or bands.
**As there is multiple artists, there is no Artist folder. This source would contain the Album / Song structure.
**Examples- 2017 Grammy Nominees, So Fresh: Hits of 2016, Open Space: The Classic Chillout Album etc
*'''Classical Music'''
**Albums released by a single Composer. It is a separation from the main stream music in the Single Artist Source, which aids in better sorting in Kodi
**This source would contain the Artist / Album / Song structure, assuming single composer type albums, and groups all classical music in one source
**Examples- Vaughan Williams, Rachmaninov, Mozart etc

The idea is to group similar types of albums. This is not a requirement, and Kodi will still function if you grouped your music into a single source. It is a best practice guide which overcomes some hurdles with local files for compilation and collaboration type albums. These hurdles will no longer be an issue from v18 onwards.

Setting and Scanning of Sources is covered in detail in the next step of the guide.

= Ripping CD's =
{{#lst:Ripping CDs|intro}}

There is no requirement to use this native {{Kodi}} CD Ripper. If you are comfortable using other ripping software, then we recommend you continue using that software. It makes no difference to {{kodi}} which software was used.

{{main|Ripping CDs}}

= Tagging =
Ever wonder how your music player always knows the name of the song, album, artist and track number of the music you play? This information comes from metadata embedded in the music file. If you purchased your music from an online store, then that store would have embedded the metadata in the file. If you ripped your own music, then the ripping software would have embedded the data into the file, probably without you even knowing. It is not uncommon that only minimal metadata is embedded, but this works very well on simple music players and is a convenient solution to sorting your library on these players.
<br /><br />
{{kodi}} also makes use of this embedded metadata. {{kodi}}, being an advanced and feature rich player, requires a greater precision in the embedded tags. Any slight variance in, for example, the Album name between the tracks from the same album will see multiple entries in the library for that Album. Same with Artists. It is not uncommon to have a single album split into three similarly named albums. It is for this reason that there is a separation of the Scanning and Scraping processes for Music. The initial scan allows you to find and correct errors in tagging, before scraping. Failing to do that will create an unmanageable library.
<br /><br />
Example of errors in tagging, which will cause duplicated entries in the library...

{|class="prettytable"
!Similar Name 1 || Similar Name 2 || Note
|-
|György Ligeti || Gyorgy Ligeti || Accented and unaccented names will create duplicate entries
|-
|The Best of || The Very Best Of || Inconsistent naming between songs of the same album and/or artist will cause duplicated entries
|-
|Madonna || Madonnna || Spelling mistakes will cause duplicated entries for albums and/or artists
|-
|Sting || Sting and The Police || Seen as two separate and unrelated Artists
|}

The easiest method to comprehensively tag your music files is with MusicBrainz Picard.

As {{kodi}} scans your music collection, it copies the data contained in those tags into the {{kodi}} music database. The benefits of this are:
*Once the scan is complete, the tags are not accessed again
*All information is now obtained from the database. This has the benefit of dramatically increasing efficency and speed when navigating the library.
*Now that a database entry exists, you are able to scrape additional information from online sources. This is covered later in the guide.

== MusicBrainz ==
'''{{kodi}} has strong support for MusicBrainz tagging. It is highly recommended that users tag their music files using MusicBrainz picard.'''

'''MusicBrainz''' is an open source music encyclopedia that collects music metadata and makes it available to the public. MusicBrainz has a database that, as of Sept 2017, [https://musicbrainz.org/statistics consists of over 1,258,860 Artists, over 1,866,600 albums and over 17,846,800 recordings].

'''MusicBrainz Picard''' is the music file tagger software that can access the MusicBrainz database to locate metadata to embed into your music files. It is recommended that your music collection is correctly tagged using the tagging software [https://picard.musicbrainz.org/ MusicBrainz Picard]. This is a free download. There are other Taggers that are able to access the MusicBraniz database, but Picard seems to be friendliest to use.

Below is a screenshot of the main screen of the Picard software. A brief description of the layout as follows.

*Top Left Box- Folder listing of your music collection
*Top Centre Box- Albums are dragged and dropped here in preparation for matching and tagging. Pressing ''Lookup'' (greyed out) will commence the lookup process
*Top Right Box- Matching albums are displayed here and your songs are overlayed. In the screenshot, songs 01, 08 and 09 have been matched to the suggested album. If all songs match and you agree the correct album was located, simply pressing Save will tag the album with the tags displayed in the Bottom Tag Box.
*Bottom Tag Box - Selecting a song from the Top Right Box will display all available tag fields (left column), the current tags in the music file (Original Value column) and the MusicBrainz tags to be embedded in the music file (right column).

It is important to note that a lot of music is distributed with only the basic metadata embedded, as can be clearly seen in the screenshot below. (Original Value column)

The example in the image below shows the following:
*Most tags are missing (original value column)
*The top three yellow entries are incorrect (original value column) and the corrections are in the right column
*The green entries in the right column indicate new tags to be embedded
*The black entries at the bottom of the list indicate no change to the existing tags as they are correct.

Although {{kodi}} will populate the library with those minimal tags, the errors in those tags would create havoc in the library.

Further information and guides can be found at the [https://picard.musicbrainz.org/ MusicBrainz Picard] site.

[[File:MusicBrainzPicard01.jpg|1300px|centre]]

Although Picard is very easy to use, you must avoid blindly accepting everything offered by the software. It is important that you confirm the correct album was located. Due to the global nature of the database, there are many releases for a single album. These releases differ between countries, usually due to copyright requirements. This may lead you to inadvertendly select the incorrect release for your album, even though it is named exactly the same. The differences between releases may be as simple as different song ordering or the inclusion of additional bonus tracks.

For the best tagging experience, it is important to set the correct options in Picard, particularly the "Clear Existing Tags" option in settings. This option means that any old tags that may cause issues are wiped, preserving only the good, clean musicbrainz tagging.

[[File:Picard options.jpg|400px|centre]]

Once the music files are tagged, it is important to avoid modifying the MusicBrainz tags unless you clearly understand the relationship of the MBID's and the other related tags. For example, embedding MBID tags, but then editing the Artist tag or Album Artist tag will result in incorrect entries in the library.

:'''''See: [https://musicbrainz.org/ MusicBrainz Website]'''''
:'''''See: [https://picard.musicbrainz.org/ MusicBrainz Picard Software]'''''

----
<center>{{red|'''The remainder of this page deals with special use cases or provides information for technical interest and reference only. It can be safely disregarded if these do not apply to you'''}}</center>
----

<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Adding_music_to_the_library|Scanning Music Into Library]]}} </div>

== Cue Sheets ==
{{#lst:Cue_sheets|intro}}

{{kodi}} does provide basic support for using cue sheets to define individual tracks when an entire CD has been ripped into a single music file. However the information provided by the cue sheet standard is much more limited than that of standard tagging, hence to enjoy the full music library features it is recommended that tracks are ripped into separate files and fully tagged.
<br />
{{red|If you do not use Cue Sheets you can safely move onto the next step.}}
<br />
;{{see also|Cue_sheets}}

= Streams =
{{#lst:Internet_video_and_audio_streams|intro}}

;{{see also|Internet_video_and_audio_streams}}

= Technical Explanation: File tags =
For many categories, such as genres and artists, {{kodi}} supports multiple values in the one field. By default it uses the character sequence " / " to divide the entry into multiple values. This divider may be changed via [[advancedsettings.xml]].

== Resolving Compilations and Multiple Artists ==
{{kodi}} reads the ''Album Artist'' tag in ID3, Ogg, APE and MP4 tags and uses it if available to assign an artist to the album (independently of the track's artist information). This is the "Album Artist" tag (in ID3 this is represented by the "TPE2" tag; in vorbiscomment (ogg) files "ALBUMARTIST", "ALBUM ARTIST" and "ENSEMBLE" are all supported). Multiple artists for either a track or album artist can be specified in "Artist1 / Artist2 / Artist3" format.

If no ''Album Artist'' tag exists, {{kodi}} will use the first (primary) artist from the tracks as the ''Album Artist''. Essentially we do a string comparison of all the track artists, and assign the common artists as the ''Album artist''. This is generally the TPE1 tag in ID3.

As many users don't yet use the ''Album Artist'' tag, {{kodi}} has an additional filter system for identifying compilation albums, where each track normally has a different artist. As {{kodi}} scans a folder, it does the following:
# Identifies albums based on ''Album'' name alone in the folder and groups the songs that have the same ''Album'' name together as an album.
# Runs through each album's assigned songs. If there is 2 or more tracks with the same ''Track'' number, the group of songs must come from 2 or more albums, so the ''Album'' name is ruled out as a possible compilation.
# If any of the songs assigned to the ''Album'' name have an ''Album Artist'' tag, then {{kodi}} assumes the user knows what they're doing, and this album is also ruled out from being a compilation.
# If two or more songs assigned to the ''Album'' name then have different primary artists, then the ''Album'' name is considered to be a group of songs from a compilation, and the ''Various Artists''" tag is assigned as the album artist.
# Otherwise, if all the songs have the same primary artist but don't have the same full artist list (eg a song or two has an additional artist) then the album is assigned the primary artist as it's ''Album Artist'', and we assume the additional artists are guest artists.

== Roles Tags ==
WIP / TBA

== Ratings in ID3 tags ==
Ratings in ID3 tags are read via the POPM field, and (if this doesn't exist) in a custom (TXXX) field named "RATING". For the RATING field, we accept 1-5 as valid ratings. For the POPM field things are more complicated, as there is no established standard in place. We currently most closely respect what Mediamonkey does, and also have some support for what Windows Media Player 11 does. The POPM tag takes a value from 0..255, with 0 meaning no rating, 1 the worst, and 255 the best. We currently map these as follows:

{| class="prettytable"
|-
!'''POPM value''' || '''Star rating'''
|-
|0 ||
|-
|1 || '''*''' This is a special case for Windows Media Player
|-
| 2-8 ||
|-
|9-49 || '''*'''
|-
|50-113 ||'''**'''
|-
|114-167 || '''***'''
|-
|168-218 || '''****'''
|-
|219-255 ||'''*****'''
|}

= Audio Formats & Tags =

== Supported Audio Formats ==
Although the list of playable formats is quite comprehensive, it is not accurate to say that every {{kodi}} installation will play every format. The ability to play some of the more obscure formats will depend upon the version of {{kodi}} and the operating system in use. Some formats will require the installation of add-ons.

{{#lst:Advancedsettings.xml|musicextensions}}

;{{See also|Advancedsettings.xml}}

== Supported Metadata Containers ==
The following metadata containers are supported by {{kodi}}

{| class="prettytable"
|-
! Metadata Container || Note
|-
|[[wikipedia:APEv2 tag|APEv2 tag]] ||
|-
|[[wikipedia:Advanced_Systems_Format|ASF]] ||
|-
|Generic Tag || A generic tag for basic data from other odd file types
|-
|[[wikipedia:ID3|ID3]] || v1, v2.3 and v2.4
|-
|[[wikipedia:MPEG-4 Part 14#Metadata|MP4]] ||
|-
|[https://xiph.org/ Xiph.org] || Vorbis Comments
|}

== Common File & Tag Combination ==
You will notice that not all the tags listed in the section ''Supported Audio Formats'' above are listed in the following table. Those formats that are ommitted do not have provision to support embedded tags. If your collection contains any of these unsupported formats, you will be unable to scan the music into the library. Your options are:
#Convert your audio file to a supported format and tag using MusicBrainz Picard. (recommended)
#Access your music via the File Manager or via File View

{{kodi}} supports the following common Audio File and Tag Formats

{| class="wikitable sortable" style="text-align:center;"
|-
!| Metadata container
!| Additional Filename extensions
|-
| [[wikipedia:APEv2 tag|APEv2 tag]] || ape, mp3, aac, wv, mpc
|-
| [[wikipedia:Advanced_Systems_Format|ASF]] || asf, wmv, wma
|-
| Generic Tag || it, mod, module, nst, wow, s3m, xm
|-
| [[wikipedia:ID3|ID3 v1]] || mp3, aac
|-
| [[wikipedia:ID3|ID3 v2]] || mp3, aac, tta, aif, aiff, wav, flac
|-
| iTunes [[wikipedia:MPEG-4 Part 14#Metadata|MP4]] || .3g2 .m4a .m4b .m4p .m4r .m4v .mp4
|-
|[https://xiph.org/ Xiph.org] || flac, oga, ogg, opus
|}

Note:
*FLAC files- xiph tags override id3v2 tags
*mp3 files can have either id3 or APE tags
*mka, dsf, dff - ID3v2 format read but are handled by ffmpeg tag reader and it does not support all tags from IDE standard)

== Tags {{kodi}} reads ==
{{kodi}} will scan the following tags embedded in the music file. The column ''{{kodi}} Version'' indicates the version of {{kodi}} that the tag was introduced, and will work in subsequent versions.

<section begin="TagTable" />
{| class="wikitable sortable" style="text-align:center;"
|-
! style="text-align:left;"| {{kodi}} Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|-
|v18
|ARTISTSORT
|TSOP
|ARTISTSORT
|
|WM/ArtistSortOrder
|-
|v18
|ALBUMARTISTSORT
|TS02
|ALBUMARTISTSORT
|soaa
|WM/AlbumArtistSortOrder
|-
|v18
|COMPOSERSORT
|TSOC
|COMPOSERSORT
|soco
|WM/ComposerSortOrder
|-
|v18
|WRITER
|WRITER
|WRITER
|
|-
|}
<section end="TagTable" />

{{Top}}

<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Adding_music_to_the_library|Scanning Music Into Library]]}} </div>

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

{{DISPLAYTITLE:Music Files & Tagging}}

Artist information folder

2018-08-04T14:54:47Z

DaveBlake: Initial draft introducing the Artist Information Folder

{{mininav|[[:Category:Music_library| Music Library Index]] }}

<section begin="intro" />In v18 the concept of the Artist Information Folder is introduced as a new way to handle providing local artist artwork and information via nfo files. The Artist Information Folder is a user nominated folder that {{kodi}} will look in first for artwork or NFO files for ''any'' artist. <br>
This topic is of interest to those users that want to provide local artwork for artists, or capture their current artist art and additional data for transfer to another installation of {{kodi}}<section end="intro" />

= History =
In v17 and prior releases of {{kodi}} the ability to automatically fetch local art and information from NFO files depended upon the music files being in a strict '''Artist > Album > Songs''' folder structure.
{{kodi}} populated the basic library by using data embedded in the music files. It did not use the folder structure or filenames to populate the library, but it would try to identify a unique folder for each (album) artist and a unique folder for each album from the location of the related music files, and look there for art and additional information for the artist and album respectively.

Unfortunately not all music fits neatly under such a strict layout. For example:
*Collaboration albums with more than one album artist (very common in Classical music with composer, conductor and orchestra credited, but happens in pop when two artists in there own right make an album together).
*All the albums by an artist had to be on the same music source which made it difficult to organise libraries to suit personal preferences.
Art and additional information could only be provided for album artists, not those artists that only feature as a guest on some songs on an album by another artist or on a compilation album, nor the other musicians and professionals that contribute to the production.

The way {{kodi}} tried to identify folders from their contents, combined with a slightly inaccurate music file arrangement, produced some unexpected art results that were often difficult to pin down. <ref>https://github.com/xbmc/xbmc/pull/12891</ref>

<section begin="intro" />From v18 the Artist Information Folder can be used to resolve many issues with providing local art and additional information for Artists. Local artist art and nfo files can be provided without requiring a specific folder for music files, and artist NFO files can be kept separately from the music rather than jumbled with it. <section end="intro" />
= FAQ =
{|
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Do I need to have an Artist Information Folder?
| Answer= No, {{kodi}} will continue to be backwards compatible and pick up artist art and NFO files from the same places it does for v17. Of course, if you choose not to use the Artist Information Folder you will still encounter the same limitations described above. Also if you do not have any local artist artwork or want to use NFO files then there is no need for one either.
}}
{{FAQ|
| BGcolor=
| Question= Why would I want to nominate a folder?
| Answer=*So that you can provide local art and NFO files for artists that are:
** involved in collaboration albums
** only song artists (no albums, only guests or on compilations)
** musicians or other contributors
* To keep artist art and data separate from music files.
* To handle having music from one artist spilt across many music sources.
If you have ever had the wrong local art appear in an odd place then you probably need it.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= How do I setup the Artist Information Folder?
| Answer= See Section 3- Recommended Setup
The folder can be named in whatever way suits you and located with, or away from, your music files. We recommend away from your music files.
Once a folder has been created on your file system, set it as the Artist Information Folder in either one of two ways:
* In the settings page here... '''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]''''', or
* Via the Settings button on the Add to Library dialog that is displayed when you add a new music source. '''''See: [[Adding_music_to_the_library#Adding_Music_to_Library| Adding Sources]]'''''
}}
{{FAQ|
| BGcolor=
| Question= How is the individual artist information organised and populated?
| Answer= Any artist can have a subfolder within the Artist Information Folder which is named same as the artist name. Within that folder can be artwork and additional artist information as XML metadata in an '''''[[NFO_files/Music| NFO file]]''''' called ''artist.nfo''.

The artist folders can be created manually, however it is easiest to create the initial artist folders and contents using the export facility. See 4- Using Export. That way folders are created with the correct names, as slight differences in naming could prevent {{kodi}} from locating the artist. The artwork and NFO files can then be manually edited and the library refreshed.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= How does {{kodi}} use the contents?
| Answer= The artwork and NFO files in the Artist Information Folder are read by Kodi as part of scanning and scraping process.
If you have made changes to the NFO Files for Artists already in your library, then these changes need to be '''Refreshed''' into the library.
'''''See: [[Update_Music_Library#Refresh_Artist|Refresh Artists]]'''''<br>
'''''See: [[Update_Music_Library#Refresh_Album|Refresh Albums]]'''''
To change existing artwork or to add missing artwork, either use the Refresh method above or manually change the artwork
'''''See: [[Music_artwork#Manually_Add_Artwork| Manually Add Artwork]]'''''

Note that the music library import facility does not make use of separate nfo files at all. Import only works on the single xml files that can be created via export. '''''See: [[Import-export_library#Import_2| Music Library Import]]'''''
}}
{{FAQ|
| BGcolor=
| Question= Does the Artist Information Folder have to be separate from my music files?
| Answer= No, it is the user's choice but it will be less confusing if it is separate. Also note that using the export facility to populate the Artist Information Folder can result in thousands of artist folders. Decide if you want all these folders, containing just art and nfo files, mixed in with your other folders that contain music files.
Finally if you find the explanation in the next question confusing then just don’t do it, make it a separate folder somewhere else.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= What happens if I make the Artist Information Folder the same as my main music source?
| Answer=Say you have a folder called "mymusic" that contains all your music files under an '''Artist > Album > Songs''' folder structure, and you choose to make that the Artist Information Folder, then {{kodi}} will look first for artist artwork and nfo in folders in mymusic\<artistname> where <artistname> is the exact artist name. The names of your existing folders for each artist may match, or may not (remember {{kodi}} does not care how music folders are named). What you read as the same name may not be exactly the same. Say they match, then the art and NFO files in them will be found and used. But if all you want is to use your existing artist art and nfo files already in your music folder layout then setting the Artist Information Folder the same as a music source is unnecessary, {{kodi}} will look there anyway.<br>
For art and NFO for extra artists you can create (or let export create for you) additional artist folders along side your existing folders, however you will end up with some that have music and some that don't. Some of the artwork addons people have used already do this mixing of music and art only folders, so it may be familiar and if the artist folders are correctly named Kodi will start to pick up the art on scanning rather than have the addon set it. However for others being able to use the Artist Information Folder to separate art and music will be a relief.
}}
{{FAQ|
| BGcolor=
| Question= What happens when I have a separate Artist Information Folder but also leave artist NFO and artwork files above my music files?
| Answer= {{kodi}} will look first for the artist under the Artist Information Folder and use that artwork and NFO file. If it does not find a folder for the artist there, then for album artists only it falls back to looking for a suitable artist folder in an '''Artist > Album > Songs''' folder structure as it did for v17. <br>
There are a few more safety checks in v18 to try and avoid some of the cases of mistaken identity, but in doing that it may also not show such art in the one place it is wanted.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Does this affect Album artwork and NFO Files?
| Answer= No, this does not apply to albums. Local album artwork and NFO files still be looked in the folder common to all the music files for that album (if such a unique folder exists).<br>
If album related folders and files are located within the artist folders of the Artist Information Folder then they generally have no effect, unless the Artist Information Folder is the same as the music source and the music files are also located there.
}}
{{FAQ|
| BGcolor=
| Question= When using File View mode will I see the artwork from the Aritist Information Folder?
| Answer= No, the Artist Information Folder is only a music library feature. In file view you only see the artwork found in the folder you are browsing.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Why won't the scan pick up my artwork?
| Answer= There could be many different reasons for that, only some relate to the Artist Information Folder.
'''''See: [[Music_artwork|Music Artwork Missing]]'''''
}}
|}
= Recommended Setup =
A frequent question from users is ''what do you recommend?'', in the case of the Artist Information Folder the answer is simple: unless you have local artwork for artists, or want to enter artist information via NFO files there is nothing to do. For a first time {{kodi}} user the recommendation is to tag your music files accurately, scan them into the library and allow the scrapers to fetch additional artist and album information and artwork for you.

With v18 you can arrange your music files however you like and still have access to local art and NFO files. We would recommend that all the music files from an album are kept in a unique folder, perhaps with subfolders for each part of a multi-part set. Perhaps you choose to arrange those in artist folders of some kind, but that does not have to be strictly adhered too. You could divide a large music collection by genre (with an artist having albums in more than one), or by decade, or some broader music category e.g. Xmas music. Use an '''Artist > Album > Songs''' structure if it is convenient for you.

Once you start to extend your use of {{kodi}} then a number of situations can arise:
*you have artists that the scraper was unable to find information or art for
*you want to manually edit some of the information
*having selected particular art from the many choices the scraper has found you want to backup that choice
*you want to transfer your current library to another installation of {{kodi}}

Then it is time to setup an Artist Information Folder.
# Create the Artist Information Folder outside the folders which hold your music files
# Name that folder in whatever way suits you
# Once the folder is created set this folder in the ''Artist Information Folder'' setting here... '''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]'''''
# Use the export facility to populate the Artist Information Folder
A typical folder structure type is displayed below:

<syntaxhighlight lang="xml">
f:\ .......................................(Drive root)
|
|__ArtistInfo ............................(Artist Information Folder)
| |
|
|
|__MyMusic ...............................(Source)
|_____Pop Music .......................(Source)
| |__ Madonna ........................(Artist folder)
| | |__ Beautiful Stranger (1999) ..(Album folder)
| | | |__ Songs
|
|_____Compilations .......................(Source)
| |__ Essential Eighties .............(Album folder)
| | |__ Songs
|
|_____Classical ..........................(Source)
| |
|
|_____Soundtracks ........................(Source)
| |
</syntaxhighlight>

= Using Export With The Artist Information Folder =
The export facility is the easy way to create artist folders in the Artist Information Folder, and populate them with the current artwork and additional artist information that has been already been scraped (or create empty files as templates that can be manually edited).

To do this directly '''''[[Import-export_library#Music_Library_Export_.2F_Import|export the music library]]''''', choosing '''To library folders''' as the kind of export output. Choose in the items to export which artists to do this for:
* album artists
* song artists
* other artists - the musicians and other people involved in production

However if you are concerned about what is going to be created you can choose '''Separate files for each item''' as the kind of export output. This will create the artist folders (and album folders for each artist) in a destination of your choice. Use this as a harmless test to see what is going to be produced without impacting your music files or Artist Information Folder.

The various music export options are described in more detail here.

= References =
<references />
{{top}}
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Advancedsettings.xml

2018-07-17T17:44:32Z

DaveBlake: /* sorttokens */ correct explanation

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

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

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

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

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

== Layout ==

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

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

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

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

= List of available settings =

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

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

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

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

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang=xml enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

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

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

Default: Off



== Video library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Library artwork ==

=== imageres ===
{{anchor|.3Cimageres.3E}}
This tag is new for v12 (Frodo), replacing <thumbsize>.

<section begin="imageres description" />Specify the maximal resolution that art should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

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

=== fanartres ===
{{anchor|.3Cfanartres.3E}}
This tag is new for v12 (Frodo), replacing <fanartheight>.

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

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

=== fanart ===
{{anchor|.3Cfanart.3E}}
As of v12 (Frodo), this tag is only used for music and not video.

A list of additional files to try when searching for fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)

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

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

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

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing/caching i.e. posters, fanart, etc.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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


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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

<syntaxhighlight lang=xml enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
</network>
</syntaxhighlight>

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

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

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

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

== File system settings ==

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

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

Default: False

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}
Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

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

== Input control settings ==

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

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

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed. See [[HOW-TO:Controller deadzone]].

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

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

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

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

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

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

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

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

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Removed tags ==
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[action ID]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang=xml enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

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

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

Music tagging

2017-09-22T18:07:11Z

DaveBlake: Correct NFO section (it was totally inaccurate) but not sure this info should be here at all

{{mininav| [[Music library]] }}

<section begin="intro" />

Starting in v16 "Jarvis", Kodi will ask the user who adds any file music source, if it should be loaded into the library.

We recommend you say yes to this prompt as the Kodi Music library has many extra features that help with music navigation, metadata and artwork retrieval.

Once the music is loaded in Kodi's library, you can start to organize and browse music in all kinds of awesome ways. We have chart views, artist, genre, and many other views. Starting from v15 "Helix" you can also create your own custom music nodes just like smart playlists. For example you can now create an A-Z artist view, or all music from the 2000's. See [[Music nodes]] for a guide.

<section end="intro" />
== Explanation of Music Library Scanning Options ==

Let's go to System >> Settings >> Media >> Music >> Library
and look at the options available:


[[File:Settings_media_music_library.JPG|800px]]

'''Show song and album artists'''

(This option was previously called 'Include Artists who appear only on compilation albums')
Turning this option on will the artists lists will show many more artists than you would normally like to see, it will include all artists found on every track of the album rather than just the main album artist(s). An example could be an album by a band, with 1 track that has a collaboration with a rapper on 1 song. With it on the rapper would be listed, off only the band is shown. Unfortunately this option is poorly named, and has nothing to do with compilations. When you tag your music you can either set the album artist(s) or if all the songs in an album have the same artist that that is taken as the album artist. If all the songs in an album have different artists then the album artist is taken as "various artists". Basically you will normally want to turn this option off if you want a nice clean Artists view.

'''Fetch additional information during updates'''

This option will grab extra metadata and artwork for artists and albums from online sites (or local NFO files). Since we are a media centre and this kind of stuff is great, we recommend you turn this option on. It will download lots of things with scrapers such as artist biographies, moods, artist thumbnails, album artwork etc. However if you have a large music collection it can take some time, and you have to be confident that your files are well tagged first.

'''Prefer online information'''

This option will overide some of the artist and album data, that was initially derived from the tags in your song files, with information it finds online. The song files themselves are not changed in any way, just the data in the library. Providing that the scraper can uniquely identify the artist or album, this could be used to compensate for minimal tagging, but if you have tagged your music well it is better to let them take precedence, hence we recommend you switch it off normally. This makes it easy to tag your music files and know exactly how they will show up in Kodi. It also makes it easy to change data by simply editing the id3 tag.

'''Scraper selection'''

This option lets you choose a scraper to grab metadata such as artist biographies, and artwork such as pictures or artists. Kodi uses 2 scrapers here, one for the artist, and another for the albums. The difference being the album scraper is able to grab cover-art and album descriptions, genres and reviews. We recommend you stick with the universal scraper here, which will use the MusicBrainz API to search and a number of different sites such as Fanart.tv, TheAudioDB.com and Allmusic to grab the additional data. Since some of these sites are open, it is possible to add information to these sites and scrape the new data from them instantly.

== Tagging with MusicBrainz Picard ==

OK.. lets get one thing straight before we start. Kodi uses the Musicbrainz Artist and Album ID's to do all its metadata lookups. If you have these tags present in your music files then Kodi does not need to do a name search on your music which could introduce errors. This means that the chances of accurate artwork and metadata retrieval will be hugely increased. It also helps to avoid problems such as confusion over artists with the same name. Both Mp3tag and Picard tagging software that can add these tags. MusicBrainz Picard is thats what we are going to use in this example. Thankfully, once its installed it takes about 4 clicks to tag something perfectly as the tagger app is based on online lookups.

'''NOTE''': That's not to say the old method of tagging files(with software likehttp://www.mp3tag.de/en/ or MediaMonkey http://www.mediamonkey.com/) with accurate Artist and Album naming doesn't work. We just have a better way these days. Ultimately this method still uses the MusicBrainz ID to lookup metadata and artwork, you are just relying on the musicbrainz NameSearch API.

So with that said, lets look at how to tag an album in Picard to be loaded into Kodi.

Install (https://picard.musicbrainz.org/) then open Picard . Lets try to Auto Tag an Album:

1) Click the Add folder icon in the top left of the toolbar and select the folder the album is in.

2) Click the "Cluster" button (this brings all the files together so picard knows its a single album).

3) Now click "Lookup". You should now see the album on the right hand side box. (Picard has basically preformed an online search for your music on the MB site and selected what it thinks is the album)

4) Assuming its found the correct album, thats basically it. All you need to do is click save and Picard will save a whole wealth of new tags in your music.

Lets now look at those tags:

[[File:Picard1.jpg]]

Now lets click on a file that has 2 artists collaborating. In this case its track number 3

'''03-50_cent-patiently_waiting_ft._eminem.flac'''

[[File:Picard2.jpg]]

So this song has 2 artists "50 Cent" and "Eminem".

As you can see it has them listed in the ARTISTS tag.

This is very important as Kodi will now have 2 artists on the album and treat it as a compilation release.

[[File:Picard3.jpg]]

And if we look further down the list, we can see the release has lots of MBID's now that Kodi can use for online lookups.

That's basically it, picard makes music tagging incredibly easy and quick.

NOTE: Picard works by using drag and drop a lot. If it misidentifies a track or release, try dragging it onto a track to match it up. You can also right click on the album >> other verions. To select the correct release.

== Loading Music into Kodi Music Library==

Lets now add this folder as a source in Kodi and scan in it into the library.

Go to:

Kodi >> Music >> Files >> Add Music >> Select the album folder (or your music folder if you have many albums) >> Scan to library when prompted.

Assuming you have the options to search online for metadata enabled, Kodi will now scan the tags to populate the libarary, and then lookup and additional bits of artwork and metadata for artists and albums.

[[File:Kodimusicimport1.jpg]]

You can now browse the library by artist, album or via many different views.

[[File:Kodimusicimport2.jpg]]

All artwork, artist biographies and details are now loaded into kodi's library.

You can see the biography and additional details by selecting an artist in the Artists view, and hitting the info button ("i" on the keyboard).

[[File:Kodimusicimport3.jpg]]

You can even change your scraper settings to download the biography in many different languages.

== Tags Kodi reads ==

The music library is created by scanning metadata that is embedded in the music files, not by looking at the file names or the folders they are located in. Kodi reads the following tags. The Kodi version shows that the tag was added from that version onwards, and the actual ag name is given in the various tag formats supported.

<section begin="TagTable" />
{| class="wikitable"
! style="text-align:left;"| Kodi Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|}
<section end="TagTable" />

== Data Kodi Scrapes ==
Having created the music library entries, Kodi can then scrape additional artist and album data from either online sources or from local NFO files. This can be automated as part of update library by enabling "Fetch additional information on update" setting. However, it can be best to scan music files and check the resulting library first, before scraping additional information.

The Universal Album Scraper and The Universal Artist Scraper settings allow the user to choose which online sources are used for different pices of information.

TADB - The Audio Database
AM - Allmusic
MB - Musicbrainz

The additional information scraped is:

'''Artist'''
* Life span (Born, Died) - TADB/AM/MB
* Formed, Disbanded
* YearsActive - AM
* Genres - TADB/AM
* Moods - TADB/AM
* Styles - TADB/AM
* Instruments
* Biography - TADB
* Discography - TADB/AM/MB
* Thumb - fanart.tv/TADB/AM/HT
* Fanart - fanart.tv/TADB/HT

'''Album'''
* Genres
* Year
* Compilation
* Moods - TADB/AM
* Styles - TADB/AM
* Themes - TADB/AM
* Review (description) - TADB
* Thumb (cover) - fanart.tv/TADB/AM
* Label
* Rating - TADB/AM/MB
* Votes

Notice that Genres, Year, Compilation and Label may have been derrived from tag data and these will take prescidence. These values can be overwritten by the scarped values if "Prefer Online Information" setting is enabled. But note that if an album is mis-idenitified by the scraper then with "Prefer Online Information" the album artists will also be replaced with those the scraper found.

== NFO files ==
{{main|NFO files}}
MusicBrainz id tags for artists and albums can **not** be added using [[NFO files]]. However both album.nfo and artist.nfo files can contain the artist or album (release) MusicBrainz id, or simply contain a URL to the correct page on the MusicBrainz website, similar to how Movies can contain an IMDb URL NFO file.

== See also ==

NFO files/Music

2017-09-22T14:14:07Z

DaveBlake: /* Technical Details */ Correct music files tags not stored in DB

{|class="infobox" style="width:280px"
! Steps to create your Music Library
|-
|<small>1. [[Music_tagging|Music File Tagging]]</small>
|-
|<small>2. Scanning Music Into Library</small>
|-
|<small>3. Scraping Additional Music Information</small>
|-
|4. '''[[NFO_files|NFO Files]]'''
:*'''[[NFO files/Music|Music]]'''
|-
|<small>5. [[Music_artwork]]</small>

<small>Report NFO corrections:<br />
[https:// here in the forum]</small>
|}
{{mininav|[[NFO_files]]}}

= Requirements =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read this section to ensure your music and artwork are correctly scraped and displayed.'''}}

== Understanding the Music Library ==
{{#lst:Music_artwork|understanding}}

== Adding Music to Library ==
{{#lst:Music_artwork|adding}}

== Music nfo Specific Requirements ==
*A number of database fields can be populated initially by music file tags, but then be overwritten by online or nfo scraping. Whether this occurs depends on the setting '''Prefer Online Information''' in ''Settings>Media Settings>Music''. If ''disabled'', these fields will remain with the data scanned from the Music File tags. If ''enabled'' these fields will be overwritten by information obtained from either the online or local nfo file scrape. The affected fields are shown below in the section [[NFO_files/Music#Available_nfo_Tags|Available nfo Tags]]
*In the ''album.nfo'' the top level <artist> tag has been deprecated and is not shown in any sample nfo files. Applies to v12 and prior.
*There is no XML tag for ''votes'' of individual Songs. This can only come from the music file tags. Album ''votes'' can come from either online or local nfo scraping.
*FLAC rating contained within the Music File Tag is scored out of 100. Kodi converts this value to its equivalent value out of 10. Values less than 10 in the FLAC music file tag will return a rating of 0 in Kodi.<br />

= nfo Placement =
Music will fetch additional album and album artist information from nfo files.

For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional '''album artist''' information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

{{note|There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly. However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.nfo file, and give the artist some other artist's information, or fail to fine the artist.nfo you created}}

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Artist as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |artist.nfo
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Album as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |album.nfo
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
|}
</div>
*The PERFORMER tag can contain many different kinds of musician tags, including ARTIST, ARRANGER, COMPOSER, CONDUCTOR, DJMIXER, ENGINEER, LYRICIST, MIXER, PRODUCER, REMIXER and PERFORMER

= Available nfo Tags =
The following two tables list the available tags that can be used in each nfo file. The Album nfo section includes an example nfo for collaboration type albums.

== Artist nfo ==

{|class="prettytable"
! NFO (xml) Tag || Required || Overwrites || Multiple ** || Notes
|-
|<artist></artist> || Yes || No || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<name></name> || No || Yes || No || Overwrites artist name in artist table, when "prefer online info" is "enabled". Does not change that name anywhere else
|-
|<musicBrainzArtistID></musicBrainzArtistID> || No || No || No || Exported but not imported
|-
|<genre></genre> || No || No || Yes || Artist genre is not related to song genre. <br />Used for display only.
|-
|<style></style> || No || No || Yes ||
|-
|<mood></mood> || No || No || Yes ||
|-
|<yearsactive></yearsactive> || No || No || Yes ||
|-
|<instruments></instruments> || No || No || Yes ||
|-
|<born></born> || No || No || No ||
|-
|<formed></formed> || No || No || No ||
|-
|<biography></biography> || No || No || No ||
|-
|<died></died> || No || No || No ||
|-
|<disbanded></disbanded> || No || No || No ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artist images. <br />Importing will also accept paths to local art files which can subsequently be exported <br />
Export to Single File will export a single path. Export to Separate Files will export multiple paths.
|-
|<path></path> || No || No || No || Exported but not used on Import
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || No || Yes || Path to available online artist images. <br />Importing will also accept paths to local art files which can subsequently be exported <br />
Export to Single File will not export any paths. Export to Separate Files will export multiple paths.
|-
|
<album>
<title></title>
<year></year>
</album>
|| No || No || Yes || Artist discography. <br />A scraped listing not releated to the albums in the library
|-
|
<art>
<fanart></fanart>
<thumb preview="path"></thumb>
</art>
|| No || No || Yes || Path to currently selected artwork. Exported to single file nfo only. Not used on import.
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on expor
|}

== Album nfo ==

{|class="prettytable"
! NFO (xml) Tag || Required || Overwrites || Multiple ** || Notes
|-
|<album></album> || Yes || No || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || No || Yes || No ||
|-
|<musicBrainzAlbumID></musicBrainzAlbumID> || No || No || No || Exported but tag not merged when scraped or imported
|-
|<artistdesc></artistdesc> || No || No || No || Exported but tag not merged when scraped or imported
|-
|<genre></genre> || No || Yes || Yes ||
|-
|<style></style> || No || No|| Yes ||
|-
|<mood></mood> || No || No || Yes ||
|-
|<theme></theme> || No || No || Yes ||
|-
|<compilation></compilation> || No || Yes || No ||
|-
|<review></review> || No || No || No ||
|-
|<type></type> || No || Yes || No ||
|-
|<releasedate></releasedate> || No || No || No || Empty XML tag exported, not not used when scraped or imported
|-
|<label></label> || No || Yes || No ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork <br />Importing will also accept paths to local art files which can subsequently be exported
|-
|<path></path> || No || No || No || Exported but tag not used when scraped or imported
|-
|<rating max="10"></rating> || No || No || No || Optional qualifier gives maximum value score is out of
|-
|<userrating max="10"></userrating> || No || No || No || Optional qualifier gives maximum value score is out of
|-
|<votes></votes> || No || No || No ||
|-
|<year></year> || No || Yes || No ||
|-
|
<albumArtistCredits>
<artist></artist>
<musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
|| No || Yes || Yes || Scraped album artist credits can replace those derrived from music file tags. Note even when overwrite is disabled missing album artists will be added
|-
|
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title></title>
<position></position>
<duration></duration>
</track>
|| No || No || Yes || Album track listing. </br>
Not related in any way to the songs in the music library, it simply provides descriptive info used by some skins.<br />
<musicBrainzTrackID> will always be empty and can be safely ignored if creating your own nfo files.
|-
|<releasetype></releasetype> || No || No || No || Exported with value "album", not used when scraped or imported. </br>
This is an internal flag.
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export
|}

= Sample nfo Files =
An example of the ''artist.nfo'' and the ''album.nfo'' are provided. Use these as a guide to create your own nfo files, or to determine errors in your own files.

== Artist nfo ==
Sample Music Artist nfo extracted from Single File Export. Click the '''Expand''' button, to the right, to view

{{collapse top| Music Artist nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Annie Lennox</name>
<musicBrainzArtistID>3e30aebd-0557-4cfd-8fb9-3945afa5d72b</musicBrainzArtistID>
<genre>Soul</genre>
<style>Rock</style>
<style>Pop</style>
<mood>Bittersweet</mood>
<yearsactive>1970s - 2010s</yearsactive>
<born>Aberdeen, Scotland (1954)</born>
<formed></formed>
<biography>Ann "Annie" Lennox, OBE (born 25 December 1954) is a Scottish singer-songwriter, political activist and philanthropist. After achieving minor success in the late 1970s...</biography>
<died></died>
<disbanded></disbanded>
<thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/vtquqv1353945074.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/vtquqv1353945074.jpg</thumb>
<path>E:\Music-Picard\Annie Lennox\</path>
<fanart />
<album>
<title>Medusa / Live in Central Park</title>
<year>1995</year>
</album>
<album>
<title>Medusa</title>
<year>1995</year>
</album>
<album>
<title>Songs of Mass Destruction</title>
<year>2007</year>
</album>
<album>
<title>Annie Lennox & the BBC Concert Orchestra</title>
<year>2007</year>
</album>
<album>
<title>Nostalgia</title>
<year>2014</year>
</album>
<album>
<title>A Christmas Cornucopia</title>
<year>2010</year>
</album>
<album>
<title>Diva</title>
<year>1992</year>
</album>
<album>
<title>An Evening of Nostalgia With Annie Lennox</title>
<year>2015</year>
</album>
<album>
<title>Die Nixe • The Mermaid</title>
<year>2001</year>
</album>
<art>
<fanart>E:\Music-Picard\Annie Lennox\fanart.jpg</fanart>
<thumb>E:\Music-Picard\Annie Lennox\folder.jpg</thumb>
</art>
</artist>
{{collapse bottom}}

== Music Album nfo ==
Sample Music Album nfo. Click '''Expand''', to the right, to view.

{{collapse top| Music Album nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>Symphony no. 5 & The Water Goblin</title>
<musicBrainzAlbumID>df943086-8bb9-41fa-a984-b70be7286701</musicBrainzAlbumID>
<artistdesc>Dvořák; Antonín Leopold</artistdesc>
<genre>Classical</genre>
<genre>Romantic</genre>
<style>Pastoral</style>
<style>Old and slow</style>
<mood>Happy</mood>
<mood>Dramatic</mood>
<theme>Fantasy theme of water gobin</theme>
<theme>Gratefulness</theme>
<compilation>false</compilation>
<review>Dvořák composed his fifth symphony in the summer months in June and July 1875. The opus number is actually incorrect. The autograph was marked with number 24, but the publisher Simrock gave this symphony a high...</review>
<type>album; live recording</type>
<label>Chandos</label>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg</thumb>
<path>N:\Music\Lib\Classical\Dvořák\Symphony no. 5 , The Water Goblin\</path>
<rating max="10">3.500000</rating>
<userrating max="10">6</userrating>
<votes>502</votes>
<year>1987</year>
<albumArtistCredits>
<artist>Antonín Leopold Dvořák</artist>
<musicBrainzArtistID>819eaeb2-8dd8-48a5-ad07-0bcd137985ef</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Scottish National Orchestra</artist>
<musicBrainzArtistID>c6c4103b-cf07-42ad-91a7-b7eab7586e56</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Neeme J├ñrvi</artist>
<musicBrainzArtistID>8a1d9496-603f-40b1-a38d-2e8985834940</musicBrainzArtistID>
</albumArtistCredits>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: I. Allegro ma non troppo</title>
<position>1</position>
<duration>12:50</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: II. Andante con moto</title>
<position>2</position>
<duration>07:49</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: III. Scherzo. Allegro scherzando</title>
<position>3</position>
<duration>07:39</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: IV. Finale. Allegro molto</title>
<position>4</position>
<duration>12:08</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>The Water Goblin, op. 107</title>
<position>5</position>
<duration>20:39</duration>
</track>
<releasetype>album</releasetype>
</album>

{{collapse bottom}}

= Technical Details =
{{Red|The information in this section is provided for technical interest and reference only. It can be safely disregarded if you have no technical interest in nfo and database functions}}<br />

*The data within the nfo file should, theoretically, all go to/come from somewhere in the database but, because the content source of the data field can be diverse, the data does not always come from a single source or go to a single database field. Scanning is not just about reading data but processing it too. As some fields are initially set from tags and can then be overwritten by nfo data, there is also a merge process involved in scraping.<br />
*There exist peculiarities with some XML tags in the nfo files:
**'''<name>''' in artist.nfo can overwrite the name of the artist in the artist table, if "prefer online info" is "enabled", but does not change that name anywhere else
**'''<releasedate>''' is required as part of the internal function of the online scraping process. It does not map directly to any db field, and nothing (currently) happens with its data. Exporting the library to nfo files will create an empty XML tag. It is not used during import/scrape.
**'''<artistdesc>''' tag in the album.nfo file is related to the strArtists field of the album table of the database. It is derived from ALBUMARTIST and ALBLUMARTISTS tags from the music file tags. If those two tags are empty, then it will be derived from ARTIST and ARTISTS tags in the music files. It is exported to album.nfo as <artistdesc> but the value is not imported/scraped.
**'''<releasetype>''' appears in the album.nfo by mistake. It is an internal flag that, in nfo files, will always be output as ''<releasetype>album</releasetype>'', and it is ignored during import/scrape of the nfo file. It relates to the strReleaseType field of the album table in the database. It does '''not''' relate to the RELEASETYPE tag in the MusicFile, which connects to ''<type>'' in album.nfo.
**'''<track>''' XML tag, and its children tags in the album.nfo, are not related in any way to the songs in the music library or in the Song table of the database. This XML tag and its children are related to the [[Databases#albuminfosong|albuminfosong]] table which simply provides more descriptive details of the album, which can be displayed by some skins. The presence of ''<musicBrainzTrackID>'' under ''<track>'' is a mistake and is always empty. It is recommended that when creating your own nfo, that these XML tags be omitted from the album.nfo. These XML tags have been removed in v18.<br />
*There are music file tags that are not saved to the database, therefore there are no XML tags. The music file tags are accessed by the music player at the commencement of playback.

{|class="prettytable"
! Music File Tags Not Stored In DB
|-
|LYRICS
|-
|REPLAYGAIN_TRACK_GAIN
|-
|REPLAYGAIN_ALBUM_GAIN
|-
|REPLAYGAIN_TRACK_PEAK
|-
|REPLAYGAIN_ALBUM_PEAK
|}

*In music the only XML tags with a qualifier is ''Rating'' and ''User Rating''. It limits the maximum score that is possible for the given rating. This is relevant as Kodi switched from a maximum 5 rating to a maximum of 10 rating.
*A FLAC file can have a cuesheet embedded in the CUESHEET tag. In v17 and prior there is a Cue table in the Database to make possible replaygain handling during playback for those kinds of files, but this slowed down Kodi for all users, even when no cuesheets were in the music file. v17 removed ReplayGain handling, so there is no replay gain applied for songs from FLAC with embedded cuesheets. This made the songs node 30% faster. This function has been redesigned and will be re-implemented in v18.

There are differences in tags used by Single File Export and Separate File Export. Though testing reveals that transposing tages between the two has no detrimental affect on the scrape.

{|class="prettytable"
! colspan="23" style="background-color:#E6E6E6;" | '''Artist nfo<br/>'''
|-
! XML Tag
! Exported in
Single File
! Exported in
Separate File
! Notes
|-
|
<art>
<fanart></fanart>
<poster></poster>
</art>
|| Yes || No || Path to currently selected artwork. Exported to single file nfo only. Not used on import.
|}

{{Top}}

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

NFO files/Music

2017-09-22T14:10:50Z

DaveBlake: /* Album nfo */ Correction of what album xml tags can overwrite data derrived from music file tags

{|class="infobox" style="width:280px"
! Steps to create your Music Library
|-
|<small>1. [[Music_tagging|Music File Tagging]]</small>
|-
|<small>2. Scanning Music Into Library</small>
|-
|<small>3. Scraping Additional Music Information</small>
|-
|4. '''[[NFO_files|NFO Files]]'''
:*'''[[NFO files/Music|Music]]'''
|-
|<small>5. [[Music_artwork]]</small>

<small>Report NFO corrections:<br />
[https:// here in the forum]</small>
|}
{{mininav|[[NFO_files]]}}

= Requirements =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read this section to ensure your music and artwork are correctly scraped and displayed.'''}}

== Understanding the Music Library ==
{{#lst:Music_artwork|understanding}}

== Adding Music to Library ==
{{#lst:Music_artwork|adding}}

== Music nfo Specific Requirements ==
*A number of database fields can be populated initially by music file tags, but then be overwritten by online or nfo scraping. Whether this occurs depends on the setting '''Prefer Online Information''' in ''Settings>Media Settings>Music''. If ''disabled'', these fields will remain with the data scanned from the Music File tags. If ''enabled'' these fields will be overwritten by information obtained from either the online or local nfo file scrape. The affected fields are shown below in the section [[NFO_files/Music#Available_nfo_Tags|Available nfo Tags]]
*In the ''album.nfo'' the top level <artist> tag has been deprecated and is not shown in any sample nfo files. Applies to v12 and prior.
*There is no XML tag for ''votes'' of individual Songs. This can only come from the music file tags. Album ''votes'' can come from either online or local nfo scraping.
*FLAC rating contained within the Music File Tag is scored out of 100. Kodi converts this value to its equivalent value out of 10. Values less than 10 in the FLAC music file tag will return a rating of 0 in Kodi.<br />

= nfo Placement =
Music will fetch additional album and album artist information from nfo files.

For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional '''album artist''' information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

{{note|There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly. However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.nfo file, and give the artist some other artist's information, or fail to fine the artist.nfo you created}}

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Artist as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |artist.nfo
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Album as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |album.nfo
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
|}
</div>
*The PERFORMER tag can contain many different kinds of musician tags, including ARTIST, ARRANGER, COMPOSER, CONDUCTOR, DJMIXER, ENGINEER, LYRICIST, MIXER, PRODUCER, REMIXER and PERFORMER

= Available nfo Tags =
The following two tables list the available tags that can be used in each nfo file. The Album nfo section includes an example nfo for collaboration type albums.

== Artist nfo ==

{|class="prettytable"
! NFO (xml) Tag || Required || Overwrites || Multiple ** || Notes
|-
|<artist></artist> || Yes || No || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<name></name> || No || Yes || No || Overwrites artist name in artist table, when "prefer online info" is "enabled". Does not change that name anywhere else
|-
|<musicBrainzArtistID></musicBrainzArtistID> || No || No || No || Exported but not imported
|-
|<genre></genre> || No || No || Yes || Artist genre is not related to song genre. <br />Used for display only.
|-
|<style></style> || No || No || Yes ||
|-
|<mood></mood> || No || No || Yes ||
|-
|<yearsactive></yearsactive> || No || No || Yes ||
|-
|<instruments></instruments> || No || No || Yes ||
|-
|<born></born> || No || No || No ||
|-
|<formed></formed> || No || No || No ||
|-
|<biography></biography> || No || No || No ||
|-
|<died></died> || No || No || No ||
|-
|<disbanded></disbanded> || No || No || No ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artist images. <br />Importing will also accept paths to local art files which can subsequently be exported <br />
Export to Single File will export a single path. Export to Separate Files will export multiple paths.
|-
|<path></path> || No || No || No || Exported but not used on Import
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || No || Yes || Path to available online artist images. <br />Importing will also accept paths to local art files which can subsequently be exported <br />
Export to Single File will not export any paths. Export to Separate Files will export multiple paths.
|-
|
<album>
<title></title>
<year></year>
</album>
|| No || No || Yes || Artist discography. <br />A scraped listing not releated to the albums in the library
|-
|
<art>
<fanart></fanart>
<thumb preview="path"></thumb>
</art>
|| No || No || Yes || Path to currently selected artwork. Exported to single file nfo only. Not used on import.
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on expor
|}

== Album nfo ==

{|class="prettytable"
! NFO (xml) Tag || Required || Overwrites || Multiple ** || Notes
|-
|<album></album> || Yes || No || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || No || Yes || No ||
|-
|<musicBrainzAlbumID></musicBrainzAlbumID> || No || No || No || Exported but tag not merged when scraped or imported
|-
|<artistdesc></artistdesc> || No || No || No || Exported but tag not merged when scraped or imported
|-
|<genre></genre> || No || Yes || Yes ||
|-
|<style></style> || No || No|| Yes ||
|-
|<mood></mood> || No || No || Yes ||
|-
|<theme></theme> || No || No || Yes ||
|-
|<compilation></compilation> || No || Yes || No ||
|-
|<review></review> || No || No || No ||
|-
|<type></type> || No || Yes || No ||
|-
|<releasedate></releasedate> || No || No || No || Empty XML tag exported, not not used when scraped or imported
|-
|<label></label> || No || Yes || No ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork <br />Importing will also accept paths to local art files which can subsequently be exported
|-
|<path></path> || No || No || No || Exported but tag not used when scraped or imported
|-
|<rating max="10"></rating> || No || No || No || Optional qualifier gives maximum value score is out of
|-
|<userrating max="10"></userrating> || No || No || No || Optional qualifier gives maximum value score is out of
|-
|<votes></votes> || No || No || No ||
|-
|<year></year> || No || Yes || No ||
|-
|
<albumArtistCredits>
<artist></artist>
<musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
|| No || Yes || Yes || Scraped album artist credits can replace those derrived from music file tags. Note even when overwrite is disabled missing album artists will be added
|-
|
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title></title>
<position></position>
<duration></duration>
</track>
|| No || No || Yes || Album track listing. </br>
Not related in any way to the songs in the music library, it simply provides descriptive info used by some skins.<br />
<musicBrainzTrackID> will always be empty and can be safely ignored if creating your own nfo files.
|-
|<releasetype></releasetype> || No || No || No || Exported with value "album", not used when scraped or imported. </br>
This is an internal flag.
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export
|}

= Sample nfo Files =
An example of the ''artist.nfo'' and the ''album.nfo'' are provided. Use these as a guide to create your own nfo files, or to determine errors in your own files.

== Artist nfo ==
Sample Music Artist nfo extracted from Single File Export. Click the '''Expand''' button, to the right, to view

{{collapse top| Music Artist nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Annie Lennox</name>
<musicBrainzArtistID>3e30aebd-0557-4cfd-8fb9-3945afa5d72b</musicBrainzArtistID>
<genre>Soul</genre>
<style>Rock</style>
<style>Pop</style>
<mood>Bittersweet</mood>
<yearsactive>1970s - 2010s</yearsactive>
<born>Aberdeen, Scotland (1954)</born>
<formed></formed>
<biography>Ann "Annie" Lennox, OBE (born 25 December 1954) is a Scottish singer-songwriter, political activist and philanthropist. After achieving minor success in the late 1970s...</biography>
<died></died>
<disbanded></disbanded>
<thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/vtquqv1353945074.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/vtquqv1353945074.jpg</thumb>
<path>E:\Music-Picard\Annie Lennox\</path>
<fanart />
<album>
<title>Medusa / Live in Central Park</title>
<year>1995</year>
</album>
<album>
<title>Medusa</title>
<year>1995</year>
</album>
<album>
<title>Songs of Mass Destruction</title>
<year>2007</year>
</album>
<album>
<title>Annie Lennox & the BBC Concert Orchestra</title>
<year>2007</year>
</album>
<album>
<title>Nostalgia</title>
<year>2014</year>
</album>
<album>
<title>A Christmas Cornucopia</title>
<year>2010</year>
</album>
<album>
<title>Diva</title>
<year>1992</year>
</album>
<album>
<title>An Evening of Nostalgia With Annie Lennox</title>
<year>2015</year>
</album>
<album>
<title>Die Nixe • The Mermaid</title>
<year>2001</year>
</album>
<art>
<fanart>E:\Music-Picard\Annie Lennox\fanart.jpg</fanart>
<thumb>E:\Music-Picard\Annie Lennox\folder.jpg</thumb>
</art>
</artist>
{{collapse bottom}}

== Music Album nfo ==
Sample Music Album nfo. Click '''Expand''', to the right, to view.

{{collapse top| Music Album nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>Symphony no. 5 & The Water Goblin</title>
<musicBrainzAlbumID>df943086-8bb9-41fa-a984-b70be7286701</musicBrainzAlbumID>
<artistdesc>Dvořák; Antonín Leopold</artistdesc>
<genre>Classical</genre>
<genre>Romantic</genre>
<style>Pastoral</style>
<style>Old and slow</style>
<mood>Happy</mood>
<mood>Dramatic</mood>
<theme>Fantasy theme of water gobin</theme>
<theme>Gratefulness</theme>
<compilation>false</compilation>
<review>Dvořák composed his fifth symphony in the summer months in June and July 1875. The opus number is actually incorrect. The autograph was marked with number 24, but the publisher Simrock gave this symphony a high...</review>
<type>album; live recording</type>
<label>Chandos</label>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg</thumb>
<path>N:\Music\Lib\Classical\Dvořák\Symphony no. 5 , The Water Goblin\</path>
<rating max="10">3.500000</rating>
<userrating max="10">6</userrating>
<votes>502</votes>
<year>1987</year>
<albumArtistCredits>
<artist>Antonín Leopold Dvořák</artist>
<musicBrainzArtistID>819eaeb2-8dd8-48a5-ad07-0bcd137985ef</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Scottish National Orchestra</artist>
<musicBrainzArtistID>c6c4103b-cf07-42ad-91a7-b7eab7586e56</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Neeme J├ñrvi</artist>
<musicBrainzArtistID>8a1d9496-603f-40b1-a38d-2e8985834940</musicBrainzArtistID>
</albumArtistCredits>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: I. Allegro ma non troppo</title>
<position>1</position>
<duration>12:50</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: II. Andante con moto</title>
<position>2</position>
<duration>07:49</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: III. Scherzo. Allegro scherzando</title>
<position>3</position>
<duration>07:39</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: IV. Finale. Allegro molto</title>
<position>4</position>
<duration>12:08</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>The Water Goblin, op. 107</title>
<position>5</position>
<duration>20:39</duration>
</track>
<releasetype>album</releasetype>
</album>

{{collapse bottom}}

= Technical Details =
{{Red|The information in this section is provided for technical interest and reference only. It can be safely disregarded if you have no technical interest in nfo and database functions}}<br />

*The data within the nfo file should, theoretically, all go to/come from somewhere in the database but, because the content source of the data field can be diverse, the data does not always come from a single source or go to a single database field. Scanning is not just about reading data but processing it too. As some fields are initially set from tags and can then be overwritten by nfo data, there is also a merge process involved in scraping.<br />
*There exist peculiarities with some XML tags in the nfo files:
**'''<name>''' in artist.nfo can overwrite the name of the artist in the artist table, if "prefer online info" is "enabled", but does not change that name anywhere else
**'''<releasedate>''' is required as part of the internal function of the online scraping process. It does not map directly to any db field, and nothing (currently) happens with its data. Exporting the library to nfo files will create an empty XML tag. It is not used during import/scrape.
**'''<artistdesc>''' tag in the album.nfo file is related to the strArtists field of the album table of the database. It is derived from ALBUMARTIST and ALBLUMARTISTS tags from the music file tags. If those two tags are empty, then it will be derived from ARTIST and ARTISTS tags in the music files. It is exported to album.nfo as <artistdesc> but the value is not imported/scraped.
**'''<releasetype>''' appears in the album.nfo by mistake. It is an internal flag that, in nfo files, will always be output as ''<releasetype>album</releasetype>'', and it is ignored during import/scrape of the nfo file. It relates to the strReleaseType field of the album table in the database. It does '''not''' relate to the RELEASETYPE tag in the MusicFile, which connects to ''<type>'' in album.nfo.
**'''<track>''' XML tag, and its children tags in the album.nfo, are not related in any way to the songs in the music library or in the Song table of the database. This XML tag and its children are related to the [[Databases#albuminfosong|albuminfosong]] table which simply provides more descriptive details of the album, which can be displayed by some skins. The presence of ''<musicBrainzTrackID>'' under ''<track>'' is a mistake and is always empty. It is recommended that when creating your own nfo, that these XML tags be omitted from the album.nfo. These XML tags have been removed in v18.<br />
*There are music file tags that are not saved to the database, therefore there are no XML tags. The music file tags are accessed by the music player at the commencement of playback.

{|class="prettytable"
! Music File Tags Not Stored In DB
|-
|MUSICBRAINZ_TRACKID
|-
|CUESHEET
|-
|LYRICS
|-
|REPLAYGAIN_TRACK_GAIN
|-
|REPLAYGAIN_ALBUM_GAIN
|-
|REPLAYGAIN_TRACK_PEAK
|-
|REPLAYGAIN_ALBUM_PEAK
|-
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|}

*In music the only XML tags with a qualifier is ''Rating'' and ''User Rating''. It limits the maximum score that is possible for the given rating. This is relevant as Kodi switched from a maximum 5 rating to a maximum of 10 rating.
*A FLAC file can have a cuesheet embedded in the CUESHEET tag. In v17 and prior there is a Cue table in the Database to make possible replaygain handling during playback for those kinds of files, but this slowed down Kodi for all users, even when no cuesheets were in the music file. v17 removed ReplayGain handling, so there is no replay gain applied for songs from FLAC with embedded cuesheets. This made the songs node 30% faster. This function has been redesigned and will be re-implemented in v18.

There are differences in tags used by Single File Export and Separate File Export. Though testing reveals that transposing tages between the two has no detrimental affect on the scrape.

{|class="prettytable"
! colspan="23" style="background-color:#E6E6E6;" | '''Artist nfo<br/>'''
|-
! XML Tag
! Exported in
Single File
! Exported in
Separate File
! Notes
|-
|
<art>
<fanart></fanart>
<poster></poster>
</art>
|| Yes || No || Path to currently selected artwork. Exported to single file nfo only. Not used on import.
|}

{{Top}}

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

NFO files/Music

2017-09-14T08:01:17Z

DaveBlake: /* Artist nfo */ Corrections

{|class="infobox" style="width:280px"
! Steps to create your Music Library
|-
|<small>1. [[Music_tagging|Music File Tagging]]</small>
|-
|<small>2. Scanning Music Into Library</small>
|-
|<small>3. Scraping Additional Music Information</small>
|-
|4. '''[[NFO_files|NFO Files]]'''

:*'''[[NFO_files/music|Music]]'''

|-
|<small>5. [[Music_artwork]]</small>

<small>Report NFO corrections:<br />
[https:// here in the forum]</small>
|}
{{mininav|[[NFO_files]]}}

= Requirements =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read this section to ensure your music and artwork are correctly scraped and displayed.'''}}

== Understanding the Music Library ==
{{#lst:Music_artwork|understanding}}

== Adding Music to Library ==
{{#lst:Music_artwork|adding}}

== Music nfo Specific Requirements ==
*A number of database fields can be populated initially by music file tags, but then be overwritten by online or nfo scraping. Whether this occurs depends on the setting '''Prefer Online Information''' in ''Settings>Media Settings>Music''. If ''disabled'', these fields will remain with the data scanned from the Music File tags. If ''enabled'' these fields will be overwritten by information obtained from either the online or local nfo file scrape. The affected fields are shown below in the section [[NFO_files/Music#Available_nfo_Tags|Available nfo Tags]]
*In the ''album.nfo'' the top level <artist> tag has been deprecated and is not shown in any sample nfo files. Applies to v12 and prior.
*There is no XML tag for ''votes'' of individual Songs. This can only come from the music file tags. Album ''votes'' can come from either online or local nfo scraping.
*FLAC rating contained within the Music File Tag is scored out of 100. Kodi converts this value to its equivalent value out of 10. Values less than 10 in the FLAC music file tag will return a rating of 0 in Kodi.<br />

= nfo Placement =
Music will fetch additional album and album artist information from nfo files.

For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional '''album artist''' information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

{{note|There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly.
However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.nfo file, and give the artist some other artist's information, or fail to fine the artist.nfo you created}}

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Artist as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |artist.nfo
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Album as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |album.nfo
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
|}
</div>



= Available nfo Tags =
The following two tables list the available tags that can be used in each nfo file. The Album nfo section includes an example nfo for collaboration type albums.

== Artist nfo ==

{|class="prettytable"
! nfo (XML) Tag || Required || Overwrites || Multiple ** || Notes
|-
|
<album>
<title></title>
<year></year>
</album>
|| No || No || Yes ||Artist discography. <br />A scraped listing not releated to the albums in the library
|-
|<biography></biography> || No || No || No ||
|-
|<born></born> || No || No || No ||
|-
|<died></died> || No || No || No ||
|-
|<disbanded></disbanded> || No || No || No ||
|-
|
<fanart>
<thumb preview="path"></thumb>
</fanart>
|| No || No || Yes || Path to available online fanart. <br />Importing will also accept paths to local art files which can subsequently be exported
|-
|<formed></formed> || No || No || No ||
|-
|<genre></genre> || No || No || Yes ||Artist genre is not related to song genre. <br /> Used for display only.
|-
|<instruments></instruments> || No || No || No ||
|-
|<mood></mood> || No || No || Yes ||
|-
|<musicBrainzArtistID></musicBrainzArtistID> || No || No || No ||Exported but not imported
|-
|<name></name> || No || Yes || No || Overwrites artist name in artist table, when "prefer online info" is "enabled". Does not change that name anywhere else
|-
|<path></path> || No || No || No || Exported but not used on Import
|-
|<style></style> || No || No || Yes ||
|-
|<theme></theme> || No || No || Yes ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork<br />Importing will also accept paths to local art files which can subsequently be exported
|-
|<yearsactive></yearsactive> || No || No || Yes ||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export
|}

== Album nfo ==

{|class="prettytable"
! nfo (XML) Tag || Required || Overwrites || Multiple || Notes
|-
|
<albumArtistCredits>
<artist></artist>
<musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
|| Yes || Yes || Yes ||
|-
|<artistdesc></artistdesc> || Yes || No || No || XML Tag created on Export, not used on Import
|-
|<compilation></compilation> || Yes || Yes || No ||
|-
|<genre></genre> || No || Yes || Yes ||
|-
|<label></label> || No || Yes || No ||
|-
|<mood></mood> || No || Yes || Yes ||
|-
|<musicBrainzAlbumID></musicBrainzAlbumID> || No || Yes || No ||
|-
|<path></path> || Yes || No || No || Exported by not used on Import
|-
|<rating max="10"></rating> || No || Yes || No ||
|-
|<releasedate></releasedate> || No || No || No || Empty XML Tag created on Export, not used on Import/scrape
|-
|<releasetype></releasetype> || No || No || No || Appears by mistake. Is not used
|-
|<review></review> || No || Yes || No ||
|-
|<style></style> || No || Yes || Yes ||
|-
|<theme></theme> || No || Yes || Yes ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork<br />Importing will also accept paths to local art files which can subsequently be exported
|-
|<title></title> || Yes || Yes || No ||
|-
|
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title></title>
<position></position>
<duration></duration>
</track>
|| Yes || Yes || Yes || Not related in any way to the songs in the music library. <br />
It is used by the albuminfosong table which simply provides descriptive data used by some skins.<br />
musicBrainzTrackID is exported in error and will always be empty. <br />
Can be safely ignored if creating your own nfo files.
|-
|<type></type> || No || Yes || No ||
|-
|<userrating max="10"></userrating> || No || No || No ||
|-
|<votes></votes> || No || Yes || No ||
|-
|<year></year> || No || Yes || No ||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export
|}

= Sample nfo Files =
An example of the ''artist.nfo'' and the ''album.nfo'' are provided. Use these as a guide to create your own nfo files, or to determine errors in your own files.

== Artist nfo ==
Sample Music Artist nfo. Click the '''Expand''' button, to the right, to view

{{collapse top| Music Artist nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Fleetwood Mac</name>
<musicBrainzArtistID>bd13909f-1c29-4c27-a874-d4aaf27c5b1a</musicBrainzArtistID>
<genre>Rock</genre>
<genre>Hard Rock</genre>
<style>Rock</style>
<style>Pop</style>
<mood>Happy</mood>
<mood>Relaxed</mood>
<yearsactive>1960s - 2010s</yearsactive>
<born></born>
<formed>London, England (1967)</formed>
<biography>Fleetwood Mac are a British-American rock band formed in 1967 in London. The only original member present in the band is its eponymous drummer...</biography>
<died></died>
<disbanded></disbanded>
<thumb preview="http://assets.fanart.tv/preview/music/bd1...56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd1...f27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd1...4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd1...f27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg</thumb>
<path>E:\Music- Test\Fleetwood Mac\</path>
<fanart>
<thumb preview="http://assets.fanart.tv/preview/music/bd13...mac-54a08371db4e2.jpg">http://assets.fanart.tv/fanart/music/bd13...ground/fleetwood-mac-54a08371db4e2.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13...mac-54a083a3607ed.jpg">http://assets.fanart.tv/fanart/music/bd13...ground/fleetwood-mac-54a083a3607ed.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13...mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13...ground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
</fanart>
<album>
<title>Future Games</title>
<year>1971</year>
</album>
<album>
<title>Live in London 1968</title>
<year>1989</year>
</album>
<album>
<title>Bare Trees</title>
<year>1972</year>
</album>
<album>
<title>Tusk</title>
<year>1979</year>
</album>
<album>
<title>In Concert 1982</title>
<year>2010</year>
</album>
<album>
<title>Rumours</title>
<year>1977</year>
</album>
<album>
<title>Say You Will</title>
<year>2003</year>
</album>
<album>
<title>Kiln House</title>
<year>1970</year>
</album>
<album>
<title>Tango in the Night</title>
<year>1987</year>
</album>
<album>
<title>Fleetwood Mac</title>
<year>1975</year>
</album>
<album>
<title>Penguin</title>
<year>1973</year>
</album>
<album>
<title>Mirage</title>
<year>1982</year>
</album>
<album>
<title>Mystery to Me</title>
<year>1973</year>
</album>
<album>
<title>Peter GreenΓÇÖs Fleetwood Mac</title>
<year>1968</year>
</album>
</artist>
{{collapse bottom}}

== Music Album nfo ==
Sample Music Album nfo. Click '''Expand''', to the right, to view.

{{collapse top| Music Album nfo file (click 'expand' to view)}}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>Symphony no. 5 & The Water Goblin</title>
<musicBrainzAlbumID>df943086-8bb9-41fa-a984-b70be7286701</musicBrainzAlbumID>
<artistdesc>Dvořák; Antonín Leopold</artistdesc>
<genre>Classical</genre>
<genre>Romantic</genre>
<style>Pastoral</style>
<style>Old and slow</style>
<mood>Happy</mood>
<mood>Dramatic</mood>
<theme>Fantasy theme of water gobin</theme>
<theme>Gratefulness</theme>
<compilation>false</compilation>
<review>Dvořák composed his fifth symphony in the summer months in June and July 1875. The opus number is actually incorrect. The autograph was marked with number 24, but the publisher Simrock gave this symphony a high number of 76</review>
<type>album; live recording</type>
<label>Chandos</label>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg</thumb>
<path>N:\Music\Lib\Classical\Dvořák\Symphony no. 5 , The Water Goblin\</path>
<rating max="10">3.500000</rating>
<userrating max="10">6</userrating>
<votes>502</votes>
<year>1987</year>
<albumArtistCredits>
<artist>Antonín Leopold Dvořák</artist>
<musicBrainzArtistID>819eaeb2-8dd8-48a5-ad07-0bcd137985ef</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Scottish National Orchestra</artist>
<musicBrainzArtistID>c6c4103b-cf07-42ad-91a7-b7eab7586e56</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Neeme J├ñrvi</artist>
<musicBrainzArtistID>8a1d9496-603f-40b1-a38d-2e8985834940</musicBrainzArtistID>
</albumArtistCredits>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: I. Allegro ma non troppo</title>
<position>1</position>
<duration>12:50</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: II. Andante con moto</title>
<position>2</position>
<duration>07:49</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: III. Scherzo. Allegro scherzando</title>
<position>3</position>
<duration>07:39</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: IV. Finale. Allegro molto</title>
<position>4</position>
<duration>12:08</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>The Water Goblin, op. 107</title>
<position>5</position>
<duration>20:39</duration>
</track>
<releasetype>album</releasetype>
</album>

{{collapse bottom}}

= Technical Details =
{{Red|The information in this section is provided for technical interest and reference only. It can be safely disregarded if you have no technical interest in nfo and database functions}}<br />

*The data within the nfo file should, theoretically, all go to/come from somewhere in the database but, because the content source of the data field can be diverse, the data does not always come from a single source or go to a single database field. Scanning is not just about reading data but processing it too. As some fields are initially set from tags and can then be overwritten by nfo data, there is also a merge process involved in scraping.<br />

*There exist peculiarities with some XML tags in the nfo files:
**'''<name>''' in artist.nfo can overwrite the name of the artist in the artist table, if "prefer online info" is "enabled", but does not change that name anywhere else
**'''<releasedate>''' is required as part of the internal function of the online scraping process. It does not map directly to any db field, and nothing (currently) happens with its data. Exporting the library to nfo files will create an empty XML tag. It is not used during import/scrape.
**'''<artistdesc>''' tag in the album.nfo file is related to the strArtists field of the album table of the database. It is derived from ALBUMARTIST and ALBLUMARTISTS tags from the music file tags. If those two tags are empty, then it will be derived from ARTIST and ARTISTS tags in the music files. It is exported to album.nfo as <artistdesc> but the value is not imported/scraped.
**'''<releasetype>''' appears in the album.nfo by mistake. It is an internal flag that, in nfo files, will always be output as ''<releasetype>album</releasetype>'', and it is ignored during import/scrape of the nfo file. It relates to the strReleaseType field of the album table in the database. It does '''not''' relate to the RELEASETYPE tag in the MusicFile, which connects to ''<type>'' in album.nfo.
**'''<track>''' XML tag, and its children tags in the album.nfo, are not related in any way to the songs in the music library or in the Song table of the database. This XML tag and its children are related to the [[Databases#albuminfosong|albuminfosong]] table which simply provides more descriptive details of the album, which can be displayed by some skins. The presence of ''<musicBrainzTrackID>'' under ''<track>'' is a mistake and is always empty. It is recommended that when creating your own nfo, that these XML tags be omitted from the album.nfo. These XML tags have been removed in v18.<br />
*There are music file tags that are not saved to the database, therefore there are no XML tags. The music file tags are accessed by the music player at the commencement of playback.
{|class="prettytable"
! Music File Tags Not Stored In DB
|-
|MUSICBRAINZ_TRACKID
|-
|CUESHEET
|-
|LYRICS
|-
|REPLAYGAIN_TRACK_GAIN
|-
|REPLAYGAIN_ALBUM_GAIN
|-
|REPLAYGAIN_TRACK_PEAK
|-
|REPLAYGAIN_ALBUM_PEAK
|-
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|}

*In music the only XML tags with a qualifier is ''Rating'' and ''User Rating''. It limits the maximum score that is possible for the given rating. This is relevant as Kodi switched from a maximum 5 rating to a maximum of 10 rating.
*A FLAC file can have a cuesheet embedded in the CUESHEET tag. In v17 and prior there is a Cue table in the Database to make possible replaygain handling during playback for those kinds of files, but this slowed down Kodi for all users, even when no cuesheets were in the music file. v17 removed ReplayGain handling, so there is no replay gain applied for songs from FLAC with embedded cuesheets. This made the songs node 30% faster. This function has been redesigned and will be re-implemented in v18.

{{Top}}

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

User:Karellen/scratchpad

2017-09-08T13:55:36Z

DaveBlake: /* Music Album nfo */ change album.nfo example

{|class="infobox" style="width:250px"
! Steps to create your Music Library
|-
|<small>1. [[Music_tagging|Music File Tagging]]</small>
|-
|<small>2. Scanning Music Into Library</small>
|-
|<small>3. Scraping Additional Music Information</small>
|-
|4. '''[[NFO_files|NFO Files]]'''

:*'''[[NFO_files/music|Music]]'''

|-
|<small>5. [[Music_artwork]]</small>

<small>Report NFO corrections:<br />
[https:// here in the forum]</small>
|}
{{mininav|[[Video library]] {{l2| [[Music library]] }} }}

= Requirements =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read this section to ensure your music and artwork are correctly scraped and displayed.'''}}

== Understanding the Music Library ==
{{#lst:Music_artwork|understanding}}

== Adding Music to Library ==
{{#lst:Music_artwork|adding}}

== Music nfo Specific Requirements ==
*A number of database fields can be populated initially by music file tags, but then be overwritten by online or nfo scraping. Whether this occurs depends on the setting '''Prefer Online Information''' in ''Settings>Media Settings>Music''. If ''disabled'', these fields will remain with the data scanned from the Music File tags. If ''enabled'' these fields will be overwritten by information obtained from either the online or local nfo file scrape. The affected fields are shown below in the section [http://kodi.wiki/index.php?title=User:Karellen/scratchpad&action#Available_nfo_Tags Available nfo Tags].
*In the ''album.nfo'' the top level <artist> tag has been deprecated and is not shown in any sample nfo files. Applies to v12 and prior.
*There is no XML tag for ''votes'' of individual Songs. This can only come from the music file tags. Album ''votes'' can come from either online or local nfo scraping.
*FLAC rating contained within the Music File Tag is scored out of 100. Kodi converts this value to its equivalent value out of 10. Values less than 10 in the FLAC music file tag will return a rating of 0 in Kodi.<br />

{{Red|The information in the remainder of this section is provided for technical interest only. It can be safely disregarded if you have no technical interest in certain functions}}<br />

*The data within the nfo file should, theoretically, all go to/come from somewhere in the database but, because the content source of the data field can be diverse, the data does not always come from a single source or go to a single database field. Scanning is not just about reading data but processing it too. As some fields are initially set from tags and can then be overwritten by nfo data, there is also a merge process involved in scraping.<br />

*There exist peculiarities with some XML tags in the nfo files:
**'''<name>''' in artist.nfo can overwrite the name of the artist in the artist table, if "prefer online info" is "enabled", but does not change that name anywhere else
**'''<releasedate>''' is required as part of the internal function of the online scraping process. It does not map directly to any db field, and nothing (currently) happens with its data. Exporting the library to nfo files will create an empty XML tag. It is not used during import/scrape.
**'''<artistdesc>''' tag in the album.nfo file is related to the strArtists field of the album table of the database. It is derived from ALBUMARTIST and ALBLUMARTISTS tags from the music file tags. If those two tags are empty, then it will be derived from ARTIST and ARTISTS tags in the music files. It is exported to album.nfo as <artistdesc> but the value is not imported/scraped.
**'''<releasetype>''' appears in the album.nfo by mistake. It is an internal flag that, in nfo files, will always be output as ''<releasetype>album</releasetype>'', and it is ignored during import/scrape of the nfo file. It relates to the strReleaseType field of the album table in the database. It does '''not''' relate to the RELEASETYPE tag in the MusicFile, which connects to ''<type>'' in album.nfo.
**'''<track>''' XML tag, and its children tags in the album.nfo, are not related in any way to the songs in the music library or in the Song table of the database. This XML tag and its children are related to the [[Databases#albuminfosong|albuminfosong]] table which simply provides more descriptive details of the album, which can be displayed by some skins. The presence of ''<musicBrainzTrackID>'' under ''<track>'' is a mistake and is always empty. It is recommended that when creating your own nfo, that these XML tags be omitted from the album.nfo. These XML tags have been removed in v18.<br />
*There are music file tags that are not saved to the database, therefore there are no XML tags. The music file tags are accessed by the music player at the commencement of playback.
{|class="prettytable"
! Music File Tags Not Stored In DB
|-
|MUSICBRAINZ_TRACKID
|-
|CUESHEET
|-
|LYRICS
|-
|REPLAYGAIN_TRACK_GAIN
|-
|REPLAYGAIN_ALBUM_GAIN
|-
|REPLAYGAIN_TRACK_PEAK
|-
|REPLAYGAIN_ALBUM_PEAK
|-
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|}

*In music the only XML tags with a qualifier is ''Rating'' and ''User Rating''. It limits the maximum score that is possible for the given rating. This is relevant as Kodi switched from a maximum 5 rating to a maximum of 10 rating.
*A FLAC file can have a cuesheet embedded in the CUESHEET tag. In v17 and prior there is a Cue table in the Database to make possible replaygain handling during playback for those kinds of files, but this slowed down Kodi for all users, even when no cuesheets were in the music file. v17 removed ReplayGain handling, so there is no replay gain applied for songs from FLAC with embedded cuesheets. This made the songs node 30% faster. This function has been redesigned and will be re-implemented in v18.

= nfo Placement =
Music will fetch additional album and album artist information from nfo files.

For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional '''album artist''' information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

{{note|There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly.
However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.nfo file, and give the artist some other artist's information, or fail to fine the artist.nfo you created}}

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Artist as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |artist.nfo
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Album as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |album.nfo
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
|}
</div>



= Available nfo Tags =
The following two tables list the available tags that can be used in each nfo file. The Album nfo section includes an example nfo for collaboration type albums.

== Artist nfo ==

{|class="prettytable"
! nfo (XML) Tag || Required || Overwrites || Multiple ** || Notes
|-
|<name></name> || Yes || Yes || No || Overwrites artist name in artist table, when "prefer online info" is "enabled". Does not change that name anywhere else
|-
|<musicBrainzArtistID></musicBrainzArtistID> || No || No || No ||
|-
|<genre></genre> || No || Yes || Yes ||
|-
|<style></style> || No || No || Yes ||
|-
|<mood></mood> || No || No || Yes ||
|-
|<theme></theme> || No || Yes || Yes ||
|-
|<yearsactive></yearsactive> || No || No || Yes ||
|-
|<born></born> || No || No || No ||
|-
|<formed></formed> || No || No || No ||
|-
|<instruments></instruments> || No || No || No ||
|-
|<biography></biography> || No || No || No ||
|-
|<died></died> || No || No || No ||
|-
|<disbanded></disbanded> || No || No || No ||
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork
|-
|<path></path> || No || No || No ||
|-
|<fanart></fanart> || No || No || Yes || Path to available online artwork
|-
|
<album>
<title></title>
<year></year>
</album>
|| No || No || Yes || Path to artwork in use
|-
|
<art>
<fanart></fanart>
<thumb preview="path"></thumb>
</art>
|| No || No || Yes || Path to artwork in use
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export
|}

== Album nfo ==

{|class="prettytable"
! nfo (XML) Tag || Required || Overwrites || Multiple || Notes
|-
|<title></title> || Yes || Yes || No ||
|-
|<musicBrainzAlbumID></musicBrainzAlbumID> || No || Yes || No ||
|-
|<artistdesc></artistdesc> || Yes || No || No || XML Tag created on Export, not used on Import
|-
|<genre></genre> || No || Yes || Yes ||
|-
|<style></style> || No || Yes || Yes ||
|-
|<mood></mood> || No || Yes || Yes ||
|-
|<theme></theme> || No || Yes || Yes ||
|-
|<compilation></compilation> || Yes || Yes || No ||
|-
|<review></review> || No || Yes || No ||
|-
|<type></type> || No || Yes || No ||
|-
|<releasedate></releasedate> || No || No || No || Empty XML Tag created on Export, not used on Import/scrape
|-
|<label></label> || No || Yes || No ||
|-
|<thumb preview="path"></thumb> || No || No || Yes ||
|-
|<path></path> || Yes || No || No ||
|-
|<rating max="10"></rating> || No || Yes || No ||
|-
|<userrating max="10"></userrating> || No || No || No ||
|-
|<votes></votes> || No || Yes || No ||
|-
|<year></year> || No || Yes || No ||
|-
|
<albumArtistCredits>
<artist></artist>
<musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
|| Yes || Yes || Yes ||
|-
|
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title></title>
<position></position>
<duration></duration>
</track>
|| Yes || Yes || Yes || Not related in any way to the songs in the music library. <br />
It is used by the albuminfosong table which simply provides descriptive data used by some skins.<br />
musicBrainzTrackID is exported in error and will always be empty. <br />
Can be safely ignored if creating your own nfo files.
|-
|<releasetype></releasetype> || No || No || No || Appears by mistake. Is not used
|}

{|class="prettytable"
!'''Notes'''
|-
|** || With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export
|}

= Sample nfo Files =
An example of the ''artist.nfo'' and the ''album.nfo'' are provided. Use these as a guide to create your own nfo files, or to determine errors in your own files.

== Artist nfo ==
Sample Music Artist nfo. Click the '''Expand''' button, to the right, to view

{{collapse top| Music Artist nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Fleetwood Mac</name>
<musicBrainzArtistID>bd13909f-1c29-4c27-a874-d4aaf27c5b1a</musicBrainzArtistID>
<genre>Rock</genre>
<genre>Hard Rock</genre>
<style>Rock</style>
<style>Pop</style>
<mood>Happy</mood>
<mood>Relaxed</mood>
<yearsactive>1960s - 2010s</yearsactive>
<born></born>
<formed>London, England (1967)</formed>
<biography>Fleetwood Mac are a British-American rock band formed in 1967 in London. The only original member present in the band is its eponymous drummer...</biography>
<died></died>
<disbanded></disbanded>
<thumb preview="http://assets.fanart.tv/preview/music/bd1...56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd1...f27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd1...4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd1...f27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg</thumb>
<path>E:\Music- Test\Fleetwood Mac\</path>
<fanart>
<thumb preview="http://assets.fanart.tv/preview/music/bd13...mac-54a08371db4e2.jpg">http://assets.fanart.tv/fanart/music/bd13...ground/fleetwood-mac-54a08371db4e2.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13...mac-54a083a3607ed.jpg">http://assets.fanart.tv/fanart/music/bd13...ground/fleetwood-mac-54a083a3607ed.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13...mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13...ground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
</fanart>
<album>
<title>Future Games</title>
<year>1971</year>
</album>
<album>
<title>Live in London 1968</title>
<year>1989</year>
</album>
<album>
<title>Bare Trees</title>
<year>1972</year>
</album>
<album>
<title>Tusk</title>
<year>1979</year>
</album>
<album>
<title>In Concert 1982</title>
<year>2010</year>
</album>
<album>
<title>Rumours</title>
<year>1977</year>
</album>
<album>
<title>Say You Will</title>
<year>2003</year>
</album>
<album>
<title>Kiln House</title>
<year>1970</year>
</album>
<album>
<title>Tango in the Night</title>
<year>1987</year>
</album>
<album>
<title>Fleetwood Mac</title>
<year>1975</year>
</album>
<album>
<title>Penguin</title>
<year>1973</year>
</album>
<album>
<title>Mirage</title>
<year>1982</year>
</album>
<album>
<title>Mystery to Me</title>
<year>1973</year>
</album>
<album>
<title>Peter GreenΓÇÖs Fleetwood Mac</title>
<year>1968</year>
</album>
</artist>
{{collapse bottom}}

== Music Album nfo ==
Sample Music Album nfo. Click '''Expand''', to the right, to view.

{{collapse top| Music Album nfo file (click 'expand' to view)}}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>Symphony no. 5 & The Water Goblin</title>
<musicBrainzAlbumID>df943086-8bb9-41fa-a984-b70be7286701</musicBrainzAlbumID>
<artistdesc>Dvo┼Ö├ík; SNO, J├ñrvi</artistdesc>
<genre>Classical</genre>
<genre>Romantic</genre>
<style>Pastoral</style>
<style>Old and slow</style>
<mood>Happy</mood>
<mood>Dramatic</mood>
<theme>Fantasy theme of water gobin</theme>
<theme>Gratefulness</theme>
<compilation>false</compilation>
<review>Dvo┼Ö├ík composed his fifth symphony in the summer months in June and July 1875. The opus number is actually incorrect. The autograph was marked with number 24, but the publisher Simrock (ignoring the protests of the composer) gave this symphony a high number of 76</review>
<type>album; live recording</type>
<label>Chandos</label>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg</thumb>
<path>N:\Music\Lib\Classical\Dvo┼Ö├ík\Symphony no. 5 , The Water Goblin\</path>
<rating max="10">3.500000</rating>
<userrating max="10">6</userrating>
<votes>502</votes>
<year>1987</year>
<albumArtistCredits>
<artist>Anton├¡n Dvo┼Ö├ík</artist>
<musicBrainzArtistID>819eaeb2-8dd8-48a5-ad07-0bcd137985ef</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Scottish National Orchestra</artist>
<musicBrainzArtistID>c6c4103b-cf07-42ad-91a7-b7eab7586e56</musicBrainzArtistID>
</albumArtistCredits>
<albumArtistCredits>
<artist>Neeme J├ñrvi</artist>
<musicBrainzArtistID>8a1d9496-603f-40b1-a38d-2e8985834940</musicBrainzArtistID>
</albumArtistCredits>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: I. Allegro ma non troppo</title>
<position>1</position>
<duration>12:50</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: II. Andante con moto</title>
<position>2</position>
<duration>07:49</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: III. Scherzo. Allegro scherzando</title>
<position>3</position>
<duration>07:39</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>Symphony no. 5 in F major, op. 76: IV. Finale. Allegro molto</title>
<position>4</position>
<duration>12:08</duration>
</track>
<track>
<musicBrainzTrackID></musicBrainzTrackID>
<title>The Water Goblin, op. 107</title>
<position>5</position>
<duration>20:39</duration>
</track>
<releasetype>album</releasetype>
</album>

{{collapse bottom}}

{{Top}}

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Databases

2017-09-07T15:47:00Z

DaveBlake: Music database: correct some NFO (XML) and music file tag entries

{{mininav| [[Development]] {{l2| [[userdata folder]] }} }}
{{see also|Databases/Versions | nfo}}
{{TOC right}}

<section begin="intro" />Kodi uses [http://www.sqlite.org/ SQLite], an open source light-weight SQL database-engine, to store all its library related data ([[Music Library|Music]], [[Video Library|Video]], and Program databases). By default, the database files (*.db) are stored in [[The UserData Folder]], specifically in userdata/Database.

In addition to indexing media files when activated by user-selected Content settings, Kodi also puts a video in its database if you change any OSD setting while watching it. Resume points are stored in this database as well. These entries are added to the database whether the affected video is part of the Video Library or not.<section end="intro" />

== Using the Databases ==
Databasess are automatically maintained whenever you use Kodi. You can activate the most powerful database functionality by setting the Content property on all of your media sources, and using Kodi Library Mode. This view mode allows you to browse your media based on the details available in the databases, rather than using simple folder and filenames for details. You can read more about Library Mode for [[Music Library|Music]] and [[Video Library|Video]] files on their respective pages.

Since Kodi maintains the databases on its own, the only time a developer really needs to access the databases is for display information. The following sections discuss how you can access the information contained in Kodi's databases, and give some brief examples of how to use it.

=== Building SQL Queries ===
SQLite queries can be incredibly powerful (and extraordinarily complicated). If you are not already familiar with SQL syntax, it would probably be a good idea to check out a general tutorial, such as [http://www.1keydata.com/sql/sql.html this one].

For most Kodi development projects, you're going to be doing select statements. "Select" is a SQL command used to gather data (in the form of "rows") out of a SQL database. Your select statement will include:

* A list of all the data fields (columns in the database table) you want for each row.
* A list of all the tables you need to get information from
* A list of comparisons used to narrow down your results. This last component is optional, but it makes sure your results are relevant and is often used to link database entries across multiple tables.

Below are a few sample select statements, so you can see how it works.

This query grabs all of the information for every movie in the Video Library.
<pre><nowiki>select * from movie</nowiki></pre>
Note that "*" is used to indicate all fields. Also,there is no "where" clause in this statement, so it returns every row in the table.

This query narrows down the results to just those movies released in 2007.
<pre><nowiki>select * from movie where c07 = 2007</nowiki></pre>
Note that the column containing the movie's release year is labelled simply "c07." The tables further down this page help you find out which columns contain the information you're looking for.

This query example is more semantic. Lists your movies including, in this order, internal ID, internal file ID, rating, movie year, IMDB ID, movie name and movie plot.
<pre><nowiki>select idMovie,idFile,c05,c07,c09,c00,c03,c02 from movie;</nowiki></pre>

Now the following query is a bit more complex because it joins 3 movie-related tables (movie, files and path) to list a single useful view of your movies. In human language it lists movie ID, movie year, IMDB rating, IMDB ID, movie name and full path of the movie file, ordered by IMDB rating with highest rating appearing first:
<pre><nowiki> select idMovie,c07,c05,c09,c00,path.strPath||files.strFilename from movie, files,path where movie.idFile=files.idFile and files.idPath=path.idPath order by c05 desc;</nowiki></pre>

You could also use less than or greater than symbols to get newer or older movies.

This query gets just the path and filename of all of the video files from season two of Chuck.
<pre><nowiki></nowiki></pre>
If you're not familiar with SQL queries, this query probably looks pretty complicated. It serves as a good demonstration of why there are so many tables in the list below, and how to use them. Many of the elements of a TV show's path and filename and used repeatedly, so SQL allows us to save space and speed up our searches by storing each of those elements just once, in one place, and referencing them repeatedly by the same ID.

In this case, the root path that contains your video files is a long string that repeats at the beginning of many files. The name of a TV series, too, is repeated in every single episode of that series, so it makes the most sense to save the series name once (along with all information relevant to the series). We do that in the table tvshow, and every episode of the TV show can access all of that information using just the TV show's ID.

=== Accessing the Databases with Kodi Python ===
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using [[JSON RPC]]

=== Tags ===
Incorporated into the tables below are the related music metadata tags that are read from music files, and the NFO XML tags exported and imported by Kodi.
{{see also | Music_tagging | Import-Export_library | nfo}}

== The Music Library ==
This database contains all information concerning music files that you've added to the Music Library. It is used in the Music portion of Kodi.

The music database is stored in userdata/Database/MyMusicXX.db, where XX is the version number.

{{red|The current v17 database is MyMusic60.db}}

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about songs and albums in the Music Library, across all the linking tables.

==== albumartistview ====
This table combines album with each album artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from album table
|-
|idArtist || integer || ID from artist table
|-
|idrole || integer || = 0 (fake role ID field)
|-
|strRole || text || = "AlbumArtist" (fake role desc field)
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|iOrder || integer || Order artist appears in credits
|}

==== albumview ====
A view of the album table with some additional fields aggregated from the songs of that album.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from Album Table
|-
|strAlbum || varchar(256) || Album Name
|-
|strMusicBrainzAlbumID || text || MusicBrainz album ID
|-
|strArtists || text || Album artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table)
|-
|iYear || integer || Album release year
|-
|strMoods || text || Album moods
|-
|strStyles || text || Album styles
|-
|strThemes || text || Album themes
|-
|strReview || text || Album review
|-
|strLabel || text || Album recording label
|-
|strType || text || Album Type e.g. "Soundtrack / Live"
|-
|strImage || text || URLs for available remote album images
|-
|fRating || float || Album rating
|-
|iUserrating || integer || Album user rating (out of 10)
|-
|iVotes || integer || Votes (for album rating)
|-
|bCompilation || integer || Compilation flag
|-
|iTimesPlayed || integer ||Average of number of times songs on album are played
|-
|strReleaseType || text || Internal type - "album" or "single"
|-
|dateAdded || text || Music file timestamp of newest song on album
|-
|lastPlayed || text || Last date any song on album was played
|}

==== artistview ====
A view of the artist table with an additional field aggregated from the songs by that artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || ID from artist table
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|strBorn || text || Artist birthday (and place)
|-
|strFormed || text || Band formation information
|-
|strGenres || text || Artist genres (just text, no link to genre table)
|-
|strMoods || text || Artist moods
|-
|strStyles || text || Artist styles
|-
|strInstruments || text || Artist instruments
|-
|strBiography || text || Artist biography
|-
|strDied || text || Date artist died (and place)
|-
|strDisbanded || text || Band disbanded information
|-
|strYearsActive || text || Years artist is active
|-
|strImage || text || URLs of available artist images
|-
|strFanart || text || URLs of available artist fanart
|-
|dateAdded || text || Music file timestamp of newest song by artist
|}

==== songartistview ====
A view that joins song to artist and artist role.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from song table
|-
|idArtist || integer || ID from artist table
|-
|idrole || integer || ID from role table
|-
|strRole || text || Description of role
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID Hash
|-
|iOrder || integer || Order artist appears in song credits
|}

==== songview ====
A view that joins song to album and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from song table
|-
|strArtists || text || Song artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Song Genres (denormalised concatenation of values in genre table)
|-
|strTitle || varchar(512) || Song title
|-
|iTrack || integer || Song track number
|-
|iDuration || integer || Song duration in seconds
|-
|iYear || integer || Songs release year
|-
|strFileName || text || Name of music file
|-
|strMusicBrainzTrackID || text || Musicbrainz track ID
|-
|iTimesPlayed || integer || Play count
|-
|iStartOffset || integer || Start position (in seconds) when song from cuesheet
|-
|iEndOffset || integer || End position (in seconds) when song from cuesheet
|-
|lastplayed || varchar(20) || Date & time last played
|-
|rating || char || Song rating
|-
|userrating || integer || Song rated by user (out of 10)
|-
|votes || integer || Votes for song rating
|-
|comment || text || Song description or comment
|-
|idAlbum || integer || ID from album table
|-
|strAlbum || varchar(256) || Album title
|-
|strPath || varchar(512) || Full path for music file
|-
|bCompilation || integer || Compilation flag (song is on a compilation album)
|-
|strAlbumArtists || text || Album artist(s) description (not always a concatenation of names)
|-
|strAlbumReleaseType || text || Internal type - "album" or "single"
|-
|mood || text || Song mood
|-
|dateAdded || text || Music file timestamp
|}

=== Tables ===

==== album ====
An album. This equates to what Musicbrainz call a "release" and represents the unique release (i.e. issuing) of an item on a specific date with specific release information such as the country, label, etc. Hence album title and artist do not have to be unique as long as we have the release ID (Musicbrainz album ID), Kodi can handle different versions of the same album e.g. original release and then a later remaster (both same title and artist).

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idAlbum || integer || ID from Album Table ||||
|-
|strAlbum || varchar(256) || Album Name |||| ALBUM || <title></title>
|-
|strMusicBrainzAlbumID || text || MusicBrainz album ID |||| MUSICBRAINZ_ALBUMID || <musicBrainzAlbumID></musicBrainzAlbumID>
|-
|strArtists || text || Album artist(s) description (not always a concatenation of names) |||| ALBUMARTIST, <br />
ALBUMARTISTS, <br />
ARTIST and ARTISTS
|| <artistdesc></artistdesc>
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table) |||| GENRE || <genre></genre> ^^
|-
|iYear || integer || Album release year |||| YEAR or DATE || <year></year>
|-
|idThumb || integer || [Unused] ||||
|-
|bCompilation || integer || Compilation flag |||| COMPILATION || <compilation></compilation>
|-
|strMoods || text || Album moods |||| || <mood></mood> ^^
|-
|strStyles || text || Album styles |||| || <style></style> ^^
|-
|strThemes || text || Album themes |||| || <theme></theme> ^^
|-
|strReview || text || Album review |||| || <review></review>
|-
|strImage || text || URLs for available remote album images |||| || <thumb preview="path"></thumb>
|-
|strLabel || text || Album recording label |||| LABEL || <label></label>
|-
|strType || text || Album Type e.g. "Soundtrack / Live" |||| RELEASETYPE || <type></type>
|-
|fRating || float || Album rating |||| || <rating max="10"></rating>
|-
|iUserrating || integer || Album user rating (out of 10) |||| || <userrating max="10"></userrating>
|-
|lastScraped || text || Date/time data scraped from online sources or NFO files ||||
|-
|strReleaseType || text || Internal type - "album" or "single" |||| || <releasetype></releasetype>
|-
|iVotes || integer || Votes (for album rating) |||| || <votes></votes>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows related Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the XML tag are allowed
|}

==== album_artist ====
This table links artists and albums
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || Order of artist names for credits
|-
|strArtist || text || Artist name (denormalised)
|}

==== album_genre ====
This links albums with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || Order of genre for concatentation
|}

==== albuminfosong ====
Track listing information for the tracks on an album. This is returned when additional information for an album is scraped from online sources or NFO files. It has no relationship with the songs actually in the user's music collection, it is just more descriptive details about the album.

{|class="prettytable"
! Column Name || Data Type || Description |||| NFO (xml) Tag
|-
|idAlbumInfoSong || integer || Primary Key || ||
|-
|idAlbumInfo || integer || Foreign key to [[Databases#album|album table]] ||||
|-
|iTrack || integer || Track number ||||
<track>
<position></position>
</track>
|-
|strTitle || text || Track title ||||
<track>
<title></title>
</track>
|-
|iDuration || integer || Track duration in seconds ||||
<track>
<duration></duration>
</track>
|}

==== art ====
The current artwork for artists and albums
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || Foreign key to [[Databases#album|album]]or [[Databases#artist|artist table]]
|-
|media_type || text || "album" or "artist"
|-
|type || text || art type e.g. "thumb", "fanart" etc.
|-
|url || text || URL of image (can be remote, local or music file with art embedded)
|}

==== artist ====
An artist is generally a musician, group of musicians, or other music professional (like a producer or engineer). E.g. Bob Dylan, Pink Floyd, London Symphony Orchestra, Andrew Collins (producer).

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idArtist || integer || ID from artist table ||||
|-
|strArtist || varchar(256) || Artist name |||| ARTIST, ARTISTS, <br /> ALBUMARTIST and <br />
ALBUMARTISTS

|| <name></name>
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID |||| MUSICBRAINZ_ARTISTID || <musicBrainzArtistID></musicBrainzArtistID>
|-
|strBorn || text || Artist birthday (and place) |||| || <born></born>
|-
|strFormed || text || Band formation information |||| || <formed></formed>
|-
|strGenres || text || Artist genres (just text, no link to genre table) |||| || <genre></genre> ^^
|-
|strMoods || text || Artist moods |||| || <mood></mood> ^^
|-
|strStyles || text || Artist styles |||| || <style></style> ^^
|-
|strInstruments || text || Artist instruments |||| || <instruments></instruments> ^^
|-
|strBiography || text || Artist biography |||| || <biography></biography>
|-
|strDied || text || Date artist died (and place) |||| || <died></died>
|-
|strDisbanded || text || Band disbanded information |||| || <disbanded></disbanded>
|-
|strYearsActive || text || Years artist is active |||| || <yearsactive></yearsactive> ^^
|-
|strImage || text || URLs of available artist images |||| || <thumb preview=" "></thumb> ^^
|-
|strFanart || text || URLs of available artist fanart |||| || <fanart><thumb preview=""></thumb></fanart> ^^
|-
|lastScraped || varchar(20) || Date last scraped metadata
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|}

==== content ====
The scraper addon and settings used for scraping additional information for specific albums or artists.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|strPath || text || Virtual path encoding what album or artist e.g. "musicdb://artists/235"
|-
|strScraperPath || text || Scraper name e.g. "metadata.artists.universal"
|-
|strContent || text || "artists" or "albums"
|-
|strSettings || text || Scraper settings as XML
|}

==== cue ====
Cuesheet information that has been extracted from a FLAC file. Generally Cuesheets as separate files are not handled in this way, only those embedded in FLAC files.

{|class="prettytable"
! Column Name || Data Type || Description |||| MusicFileTag
|-
|idPath || integer || Foreign key to [[Databases#path(music)|music path]] of where file is located ||||
|-
|strFileName || text || Name of FLAC file the cuesheet is embedded in ||||
|-
|strCuesheet || text || Cuesheet |||| CUESHEET
|}

==== discography ====
The discography of an artist. This is returned when additional information for an artist is scraped from online sources or NFO files. It has no relationship with the albums actually in the user's music collection, it is just details about the artist.

{|class="prettytable"
! Column Name || Data Type || Description |||| NFO (xml) Tag
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]] ||||
|-
|strAlbum || text || Album title ||||
<album>
<title></title>
</album>
|-
|strYear || text || Year album released ||||
<album>
<year></year>
</album>
|}

==== genre(music) ====
A music genre. This is a lookup table that enumerates the song genre values read from the genre tags embedded in music files e.g. "Progressive Rock", "Baroque" etc. But could contain anything that has been given as a "genre", and is not strictly limited to music genres.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idGenre || integer || Primary Key |||| ||
|-
|strGenre || varchar(256) || Genre Name |||| GENRE || <genre></genre> ^^
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|}

==== path(music) ====
The path of a folder containing music that has been scanned into the music library. This holds hash values of name, size, and timestamp for each folder and sub folder that is used to determine if the conents have changed and thererfore the music files need rescanning as part of library update.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || varchar(512) || Media path
|-
|strHash || text || Hash value
|}

==== role ====
An artist role, a way that an artist has contributed to or been involved with a song. This could be by being in the song artist credits ("artist"), as a musician ("Guitar", "Orchestra" or "vocals" etc.), as composer, conductor, lyricist etc. or involved in some other way as music professional e.g. producer, engineer, mixer etc. This is a lookup table that enumerates the various roles that have been read from tags embedded in music files.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] **
|-
|idrole || integer || Primary Key ||||
|-
|strRole || text || Description of role ||||
ARTIST, ARRANGER, COMPOSER, CONDUCTOR, <br />
DJMIXER, ENGINEER, LYRICIST, MIXER, <br />
PRODUCER, REMIXER and PERFORMER <br />

|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|}

==== song ====
A song. It is the way that the individual track(s) from a music file are held in the music library. Generally a music file contains just one song, however it may contain more and have an associated cuesheet (separately or embedded) that identifies the individual tracks. A song may be from an album (the release of several tracks as one product so includes EPs etc. ), or a single. Singles from an artist (no album title given in the embedded tags) are internally linked with a fake album in the album table.

The music library can contain songs with the same title, artist credits, track number and album as long as they come from separate music files. Unexpectedly Musicbrainz Track ID is not unique on an album, recordings are sometimes repeated e.g. "[silence]" or on a disc set.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] **
|-
|idSong || integer || ID from song table ||||
|-
|idAlbum || integer || ID from album table ||||
|-
|idPath || integer || Foreign key to [[Databases#path|path table]] ||||
|-
|strArtists || text || Song artist(s) description (not always a concatenation of names) |||| ARTIST and ARTISTS
|-
|strGenres || text || Song Genres (denormalised concatenation of values in genre table) |||| GENRE
|-
|strTitle || varchar(512) || Song title |||| TITLE
|-
|iTrack || integer || Song disc (upper 4 bytes) and track number (lower 4 bytes)|||| TRACKNUMBER and <br /> DISCNUMBER
|-
|iDuration || integer || Song duration in seconds ||||
|-
|iYear || integer || Songs release year |||| YEAR or DATE
|-
|dwFileNameCRC || text || [unused] ||||
|-
|strFileName || text || Name of music file ||||
|-
|strMusicBrainzTrackID || text || Musicbrainz track ID |||| MUSICBRAINZ_TRACKID
|-
|iTimesPlayed || integer || Play count ||||
|-
|iStartOffset || integer || Start position (in seconds) when song from cuesheet ||||
|-
|iEndOffset || integer || End position (in seconds) when song from cuesheet ||||
|-
|idThumb || integer || [unused] ||||
|-
|lastplayed || varchar(20) || Date & time last played ||||
|-
|rating || char || Song rating ||||
|-
|userrating || integer || Song rated by user (out of 10) |||| RATING
|-
|comment || text || Song description or comment |||| COMMENT
|-
|mood || text || Song mood |||| MOOD
|-
|dateAdded || text || Music file timestamp ||||
|-
|votes || integer || Votes for song rating ||||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|}

==== song_artist ====
This table links songs to artists and the roles they contributed.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|idRole || integer || Foreign key to [[Databases#role|role table]]
|-
|iOrder || integer || Order in artist credits
|-
|strArtist || text || Name of artist (denormalised)
|}

==== song_genre ====
This table links the songs with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|iOrder || integer || Genre order when concatenating to single string
|}

==== version(music) ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of the music database
|-
|iCompressCount || integer || Number of times database has been compressed
|}

== The Video Library ==
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi. The following information is for version 75.

The video database is stored in userdata/Database/MyVideosXX.db, where XX is the version number.

{{red|The current database in use for v17 is MyVideos107.db}}

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

==== episodeview ====
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Used- unknown
|-
|c20 || text || Used- unknown
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || text || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|userrating || text || User Rating
|-
|idSeason || text || Foreign key to the [[Databases#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== movieview ====
A view that joins movie to file and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Image URL
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c22 || text || Path to playable file
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== musicvideoview ====
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text ||
|-
|c14 || text ||
|-
|c15 || text ||
|-
|c16 || text ||
|-
|c17 || text ||
|-
|c18 || text ||
|-
|c19 || text ||
|-
|c20 || text ||
|-
|c21 || text ||
|-
|c22 || text ||
|-
|c23 || text ||
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|}

==== tvshowview ====
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== tvshow counts ====
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|}

=== Tables ===
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases#episode|episode]], [[Databases#movie|movie]], [[Databases#settings|settings]], and [[Databases#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

==== actor ====
This table stores actor, artist, director, and writer information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Primary Key
|-
|name || integer || Name of the actor, artist, director, or writer
|-
|art_urls|| text || Image URL
|}

==== actor_link ====
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#tvshow|tv show table]], [[Databases#movie|movie table]],[[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, TV Show, Episode, Music Video
|-
|role || text || Role the actor played
|-
|cast_order || integer || Order actors will be displayed
|}==== art ====
This table stores URLs for video art metadata.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || The id of the media this piece of art is for
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart
|-
|url || text || Image URL
|}

==== bookmark ====
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idBookmark || integer || Primary Key
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|timeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || integer || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark
|-
|player || text || Player used to store bookmark
|-
|playerState || text || Player's internal state in XML
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode)
|}

==== country ====
This table lists countries.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Primary Key
|-
|name || text || Country Name
|}

==== country link ====
This table links countries to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases#movie|movie table]]
|-
|media_type || integer || Movie
|}

==== director_link ====
This table links directors to Movies, TV show episodes and Music Videos
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#movie|movie table]],[[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

==== episode ====
This table stores television episode information. Information concerning the series is stored in [[Databases#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Used- unknown
|-
|c20 || text || Used- unknown
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || text || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|userrating || text || User Rating
|-
|idSeason || text || Foreign key to the [[Databases#seasons|seasons table]]
|}

==== files ====
This table stores filenames and links the path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Primary Key
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|-
|strFilename || text || Full name of file including extension
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|}

==== genre ====
This table stores genre information. For convenience the contents are duplicated in [[Databases#movie|movie]] and [[Databases#tvshow|tvshow]], so a join isn't necessary.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Primary Key
|-
|name || text || Genre label
|}

==== genre_link ====
This table links genres to movies. (The contents are also stored in movies.c14, though.)
{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases#movie|movie table]], [[Databases#tvshow|tv show table]], [[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

==== movie ====
This table stores movie information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Image URL
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c22 || text || Path to playable file
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|}

==== movielinktvshow ====
This table links movies to TV shows.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== musicvideo ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Unknown
|-
|c15 || text || Unknown
|-
|c16 || text || Unknown
|-
|c17 || text || Unknown
|-
|c18 || text || Unknown
|-
|c19 || text || Unknown
|-
|c20 || text || Unknown
|-
|c21 || text || Unknown
|-
|c22 || text || Unknown
|-
|c23 || text || Unknown
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|}

==== path ====
This table stores path information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || XML file of scraper used for this path
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||

|-
|dateAdded || text ||

|-
|idParentPath || integer ||
|}

==== rating ====
This table stores the ratings for TV Shows, Episodes and Movies
{|class="prettytable"
! Column Name || Data Type || Description
|-
|rating_id || integer || Primary Key
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#tvshow|tv show table]], [[Databases#movie|movie table]],
|-
|media_type || text || Movies, TV Show, TV Episode
|-
|rating_type || text || default
|-
|rating || float || rating from scraper site
|-
|votes || integer || votes from scraper site
|}

==== seasons ====
This table stores the links between tv show and seasons.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow|| integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|season || integer || Season number
|-
|name || integer || Unknown
|-
|userrating || integer || User Rating
|}

==== sets ====
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSet || integer || Primary Key
|-
|strSet || text || The name of the set
|-
|strOverview || text || The description of the set
|}

==== settings ====
This table stores settings for individual files.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || integer || Brightness
|-
|Contrast || integer || Contrast
|-
|Gamma || integer || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|OutputToAllSpeakers || bool || OutputToAllSpeakers
|-
|ResumeTime || integer || ResumeTime
|-
|Crop || bool || Crop
|-
|CropLeft || integer || CropLeft
|-
|CropRight || integer || CropRight
|-
|CropTop || integer || CropTop
|-
|CropBottom || integer || CropBottom
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|}

==== stacktimes ====
This table stores playing times for files (used for playing multi-file videos).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|times|| text || Times
|}

==== streamdetails ====
This table contains information regarding codecs used, aspect ratios etc
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles
|-
|strVideoCodec|| text || Video codex (xvid etc)
|-
|fVideoAspect|| real || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
|-
|iVideoDuration|| integer ||
|-
|strStereoMode || text || Stereo Mode
|-
|strVideoLanguage|| text || Language of the Video
|}

==== studio ====
This table stores studio information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Primary Key
|-
|name || text || Studio Label
|}

==== studio link ====
This table links studios to movies, music videos and tv shows
{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases#movie|movie table]], [[Databases#tvshow|tv show table]], [[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

==== tag ====
This stores tags.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Primary Key
|-
|name || integer || Tag
|}

==== taglinks ====
This table links tags to various media.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

==== tvshow ====
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases#episode|episode]]. To link a TV show to its episodes, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date tv show premiered
|}

==== tvshowlinkpath ====
This table links a TV show to its path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|}

==== uniqueid ====
This table links a Movie, TV show and Episode to its the scraper site
{|class="prettytable"
! Column Name || Data Type || Description
|-
|uniqueid || integer || Primary Key
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|-
|value || text || ID at scraper site
|-
|type || text || Scraper site
|}

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== writer_link ====
This table links writers stored in the actors table to movies and episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== The View Modes Database ==
Kodi can track a user's View Mode for every path, so you could browse movies using DVD Thumbs and browse TV shows using Fanart. This database contains the last view and sorting method a user chose for each path while navigating Kodi.

The View Modes database is stored in userdata/Database/ViewModes.db.

{{red|The current database in use for v17 is ViewModes6.db}}

=== Tables ===
The View Modes database uses only two tables. Most of the useful information is in [[Databases#view|view]].

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== view ====
This table stores details on the saved view mode for all known paths.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idView || integer || Primary Key
|-
|window || integer || Window GUI ID
|-
|path || text || Path to trigger the view on
|-
|viewMode || integer || View Mode
|-
|sortMethod || integer || ID of sort method
|-
|sortOrder || integer || Sort order (ascending or descending)
|-
|sortAttributes || integer ||
|-
|skin || text || Skin settings apply to
|}

== See also ==
* [[Version table]]
* [[MySQL]]

{{Top}}

{{updated|17}}
[[Category:Index]]
[[Category:Manual]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Development]]

Databases

2017-09-07T14:13:14Z

DaveBlake: Reinstate table definintions for album, artist and song tables

{{mininav| [[Development]] {{l2| [[userdata folder]] }} }}
{{see also|Databases/Versions | nfo}}
{{TOC right}}

<section begin="intro" />Kodi uses [http://www.sqlite.org/ SQLite], an open source light-weight SQL database-engine, to store all its library related data ([[Music Library|Music]], [[Video Library|Video]], and Program databases). By default, the database files (*.db) are stored in [[The UserData Folder]], specifically in userdata/Database.

In addition to indexing media files when activated by user-selected Content settings, Kodi also puts a video in its database if you change any OSD setting while watching it. Resume points are stored in this database as well. These entries are added to the database whether the affected video is part of the Video Library or not.<section end="intro" />

== Using the Databases ==
Databasess are automatically maintained whenever you use Kodi. You can activate the most powerful database functionality by setting the Content property on all of your media sources, and using Kodi Library Mode. This view mode allows you to browse your media based on the details available in the databases, rather than using simple folder and filenames for details. You can read more about Library Mode for [[Music Library|Music]] and [[Video Library|Video]] files on their respective pages.

Since Kodi maintains the databases on its own, the only time a developer really needs to access the databases is for display information. The following sections discuss how you can access the information contained in Kodi's databases, and give some brief examples of how to use it.

=== Building SQL Queries ===
SQLite queries can be incredibly powerful (and extraordinarily complicated). If you are not already familiar with SQL syntax, it would probably be a good idea to check out a general tutorial, such as [http://www.1keydata.com/sql/sql.html this one].

For most Kodi development projects, you're going to be doing select statements. "Select" is a SQL command used to gather data (in the form of "rows") out of a SQL database. Your select statement will include:

* A list of all the data fields (columns in the database table) you want for each row.
* A list of all the tables you need to get information from
* A list of comparisons used to narrow down your results. This last component is optional, but it makes sure your results are relevant and is often used to link database entries across multiple tables.

Below are a few sample select statements, so you can see how it works.

This query grabs all of the information for every movie in the Video Library.
<pre><nowiki>select * from movie</nowiki></pre>
Note that "*" is used to indicate all fields. Also,there is no "where" clause in this statement, so it returns every row in the table.

This query narrows down the results to just those movies released in 2007.
<pre><nowiki>select * from movie where c07 = 2007</nowiki></pre>
Note that the column containing the movie's release year is labelled simply "c07." The tables further down this page help you find out which columns contain the information you're looking for.

This query example is more semantic. Lists your movies including, in this order, internal ID, internal file ID, rating, movie year, IMDB ID, movie name and movie plot.
<pre><nowiki>select idMovie,idFile,c05,c07,c09,c00,c03,c02 from movie;</nowiki></pre>

Now the following query is a bit more complex because it joins 3 movie-related tables (movie, files and path) to list a single useful view of your movies. In human language it lists movie ID, movie year, IMDB rating, IMDB ID, movie name and full path of the movie file, ordered by IMDB rating with highest rating appearing first:
<pre><nowiki> select idMovie,c07,c05,c09,c00,path.strPath||files.strFilename from movie, files,path where movie.idFile=files.idFile and files.idPath=path.idPath order by c05 desc;</nowiki></pre>

You could also use less than or greater than symbols to get newer or older movies.

This query gets just the path and filename of all of the video files from season two of Chuck.
<pre><nowiki></nowiki></pre>
If you're not familiar with SQL queries, this query probably looks pretty complicated. It serves as a good demonstration of why there are so many tables in the list below, and how to use them. Many of the elements of a TV show's path and filename and used repeatedly, so SQL allows us to save space and speed up our searches by storing each of those elements just once, in one place, and referencing them repeatedly by the same ID.

In this case, the root path that contains your video files is a long string that repeats at the beginning of many files. The name of a TV series, too, is repeated in every single episode of that series, so it makes the most sense to save the series name once (along with all information relevant to the series). We do that in the table tvshow, and every episode of the TV show can access all of that information using just the TV show's ID.

=== Accessing the Databases with Kodi Python ===
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using [[JSON RPC]]

=== Tags ===
Incorporated into the tables below are the corresponding Music File Tags read and the NFO tags exported and imported by Kodi.
{{see also|Import-Export_library | nfo}}

== The Music Library ==
This database contains all information concerning music files that you've added to the Music Library. It is used in the Music portion of Kodi. The following information is for version 32.

The music database is stored in userdata/Database/MyMusicXX.db, where XX is the version number.

{{red|The current v17 database is MyMusic60.db}}

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about songs and albums in the Music Library, across all the linking tables.

==== albumartistview ====
This table combines album with each album artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from album table
|-
|idArtist || integer || ID from artist table
|-
|idrole || integer || = 0 (fake role ID field)
|-
|strRole || text || = "AlbumArtist" (fake role desc field)
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|iOrder || integer || Order artist appears in credits
|}

==== albumview ====
A view of the album table with some additional fields aggregated from the songs of that album.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from Album Table
|-
|strAlbum || varchar(256) || Album Name
|-
|strMusicBrainzAlbumID || text || MusicBrainz album ID
|-
|strArtists || text || Album artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table)
|-
|iYear || integer || Album release year
|-
|strMoods || text || Album moods
|-
|strStyles || text || Album styles
|-
|strThemes || text || Album themes
|-
|strReview || text || Album review
|-
|strLabel || text || Album recording label
|-
|strType || text || Album Type e.g. "Soundtrack / Live"
|-
|strImage || text || URLs for available remote album images
|-
|fRating || float || Album rating
|-
|iUserrating || integer || Album user rating (out of 10)
|-
|iVotes || integer || Votes (for album rating)
|-
|bCompilation || integer || Compilation flag
|-
|iTimesPlayed || integer ||Average of number of times songs on album are played
|-
|strReleaseType || text || Internal type - "album" or "single"
|-
|dateAdded || text || Music file timestamp of newest song on album
|-
|lastPlayed || text || Last date any song on album was played
|}

==== artistview ====
A view of the artist table with an additional field aggregated from the songs by that artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || ID from artist table
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|strBorn || text || Artist birthday (and place)
|-
|strFormed || text || Band formation information
|-
|strGenres || text || Artist genres (just text, no link to genre table)
|-
|strMoods || text || Artist moods
|-
|strStyles || text || Artist styles
|-
|strInstruments || text || Artist instruments
|-
|strBiography || text || Artist biography
|-
|strDied || text || Date artist died (and place)
|-
|strDisbanded || text || Band disbanded information
|-
|strYearsActive || text || Years artist is active
|-
|strImage || text || URLs of available artist images
|-
|strFanart || text || URLs of available artist fanart
|-
|dateAdded || text || Music file timestamp of newest song by artist
|}

==== songartistview ====
A view that joins song to artist and artist role.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from song table
|-
|idArtist || integer || ID from artist table
|-
|idrole || integer || ID from role table
|-
|strRole || text || Description of role
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID Hash
|-
|iOrder || integer || Order artist appears in song credits
|}

==== songview ====
A view that joins song to album and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from song table
|-
|strArtists || text || Song artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Song Genres (denormalised concatenation of values in genre table)
|-
|strTitle || varchar(512) || Song title
|-
|iTrack || integer || Song track number
|-
|iDuration || integer || Song duration in seconds
|-
|iYear || integer || Songs release year
|-
|strFileName || text || Name of music file
|-
|strMusicBrainzTrackID || text || Musicbrainz track ID
|-
|iTimesPlayed || integer || Play count
|-
|iStartOffset || integer || Start position (in seconds) when song from cuesheet
|-
|iEndOffset || integer || End position (in seconds) when song from cuesheet
|-
|lastplayed || varchar(20) || Date & time last played
|-
|rating || char || Song rating
|-
|userrating || integer || Song rated by user (out of 10)
|-
|votes || integer || Votes for song rating
|-
|comment || text || Song description or comment
|-
|idAlbum || integer || ID from album table
|-
|strAlbum || varchar(256) || Album title
|-
|strPath || varchar(512) || Full path for music file
|-
|bCompilation || integer || Compilation flag (song is on a compilation album)
|-
|strAlbumArtists || text || Album artist(s) description (not always a concatenation of names)
|-
|strAlbumReleaseType || text || Internal type - "album" or "single"
|-
|mood || text || Song mood
|-
|dateAdded || text || Music file timestamp
|}

=== Tables ===

==== album ====
An album. This equates to what Musicbrainz call a "release" and represents the unique release (i.e. issuing) of an item on a specific date with specific release information such as the country, label, etc. Hence album title and artist do not have to be unique as long as we have the release ID (Musicbrainz album ID), Kodi can handle different versions of the same album e.g. original release and then a later remaster (both same title and artist).

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idAlbum || integer || ID from Album Table ||||
|-
|strAlbum || varchar(256) || Album Name |||| ALBUM || <title></title>
|-
|strMusicBrainzAlbumID || text || MusicBrainz album ID |||| MUSICBRAINZ_ALBUMID || <musicBrainzAlbumID></musicBrainzAlbumID>
|-
|strArtists || text || Album artist(s) description (not always a concatenation of names) |||| ALBUM ARTIST or <br />
ALBUMARTISTS or <br />
MUSICBRAINZ_ALBUMARTIST
|| <artistdesc></artistdesc>
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table) |||| GENRE || <genre></genre> ^^
|-
|iYear || integer || Album release year |||| YEAR or DATE || <year></year>
|-
|idThumb || integer || [Unused] ||||
|-
|bCompilation || integer || Compilation flag |||| COMPILATION || <compilation></compilation>
|-
|strMoods || text || Album moods |||| || <mood></mood> ^^
|-
|strStyles || text || Album styles |||| || <style></style> ^^
|-
|strThemes || text || Album themes |||| || <theme></theme> ^^
|-
|strReview || text || Album review |||| || <review></review>
|-
|strImage || text || URLs for available remote album images |||| || <thumb preview="path"></thumb>
|-
|strLabel || text || Album recording label |||| LABEL || <label></label>
|-
|strType || text || Album Type e.g. "Soundtrack / Live" |||| RELEASETYPE || <type></type>
|-
|fRating || float || Album rating |||| || <rating max="10"></rating>
|-
|iUserrating || integer || Album user rating (out of 10) |||| || <userrating max="10"></userrating>
|-
|lastScraped || text || Date/time data scraped from online sources or NFO files ||||
|-
|strReleaseType || text || Internal type - "album" or "single" |||| || <releasetype></releasetype>
|-
|iVotes || integer || Votes (for album rating) |||| || <votes></votes>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== album_artist ====
This table links artists and albums
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || Order of artist names for credits
|-
|strArtist || text || Artist name (denormalised)
|}

==== album_genre ====
This links albums with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || Order of genre for concatentation
|}

==== albuminfosong ====
Track listing information for the tracks on an album. This is returned when additional information for an album is scraped from online sources or NFO files. It has no relationship with the songs actually in the user's music collection, it is just details about the album.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idAlbumInfoSong || integer || Primary Key |||| ||
|-
|idAlbumInfo || integer || Foreign key to [[Databases#album|album table]] |||| ||
|-
|iTrack || integer || Track number |||| TRACKNUMBER ||
<track>
<position></position>
</track>
|-
|strTitle || text || Track title |||| TITLE ||
<track>
<title></title>
</track>
|-
|iDuration || integer || Track duration in seconds |||| ||
<track>
<duration></duration>
</track>
|}

==== art ====
The current artwork for artists and albums
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || Foreign key to [[Databases#album|album]]or [[Databases#artist|artist table]]
|-
|media_type || text || "album" or "artist"
|-
|type || text || art type e.g. "thumb", "fanart" etc.
|-
|url || text || URL of image (can be remote, local or music file with art embedded)
|}

==== artist ====
An artist is generally a musician, group of musicians, or other music professional (like a producer or engineer). E.g. Bob Dylan, Pink Floyd, London Symphony Orchestra, Andrew Collins (producer).

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idArtist || integer || ID from artist table ||||
|-
|strArtist || varchar(256) || Artist name |||| ALBUMARTISTS or ARTIST
(scans both)
|| <name></name>
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID |||| MUSICBRAINZ_ARTISTID || <musicBrainzArtistID></musicBrainzArtistID>
|-
|strBorn || text || Artist birthday (and place) |||| || <born></born>
|-
|strFormed || text || Band formation information |||| || <formed></formed>
|-
|strGenres || text || Artist genres (just text, no link to genre table) |||| || <genre></genre> ^^
|-
|strMoods || text || Artist moods |||| || <mood></mood> ^^
|-
|strStyles || text || Artist styles |||| || <style></style> ^^
|-
|strInstruments || text || Artist instruments |||| || <instruments></instruments> ^^
|-
|strBiography || text || Artist biography |||| || <biography></biography>
|-
|strDied || text || Date artist died (and place) |||| || <died></died>
|-
|strDisbanded || text || Band disbanded information |||| || <disbanded></disbanded>
|-
|strYearsActive || text || Years artist is active |||| || <yearsactive></yearsactive> ^^
|-
|strImage || text || URLs of available artist images |||| || <thumb preview=" "></thumb> ^^
|-
|strFanart || text || URLs of available artist fanart |||| || <fanart><thumb preview=""></thumb></fanart> ^^
|-
|lastScraped || varchar(20) || Date last scraped metadata
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== content ====
The scraper addon and settings used for scraping additional information for specific albums or artists.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|strPath || text || Virtual path encoding what album or artist e.g. "musicdb://artists/235"
|-
|strScraperPath || text || Scraper name e.g. "metadata.artists.universal"
|-
|strContent || text || "artists" or "albums"
|-
|strSettings || text || Scraper settings as XML
|}

==== cue ====
Cuesheet information that has been extracted from a FLAC file. Generally Cuesheets as separate files are not handled in this way, only those embedded in FLAC files.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idPath || integer || Foreign key to [[Databases#path(music)|music path]] of where file is located |||| ||
|-
|strFileName || text || Name of FLAC file the cuesheet is embedded in |||| ||
|-
|strCuesheet || text || Cuesheet |||| CUESHEET ||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== discography ====
The discography of an artist. This is returned when additional information for an artist is scraped from online sources or NFO files. It has no relationship with the albums actually in the user's music collection, it is just details about the artist.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]] |||| ||
|-
|strAlbum || text || Album title |||| ||
<album>
<title></title>
</album>
|-
|strYear || text || Year album released |||| ||
<album>
<year></year>
</album>
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== genre(music) ====
A music genre. This is a lookup table that enumerates the song genre values read from the genre tags embedded in music files e.g. "Progressive Rock", "Baroque" etc. But could contain anything that has been given as a "genre", and is not strictly limited to music genres.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idGenre || integer || Primary Key |||| ||
|-
|strGenre || varchar(256) || Genre Name |||| GENRE || <genre></genre> ^^
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== path(music) ====
The path of a folder containing music that has been scanned into the music library. This holds hash values of name, size, and timestamp for each folder and sub folder that is used to determine if the conents have changed and thererfore the music files need rescanning as part of library update.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idPath || integer || Primary Key |||| ||
|-
|strPath || varchar(512) || Media path |||| || <path></path>
|-
|strHash || text || Hash value |||| ||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== role ====
An artist role, a way that an artist has contributed to or been involved with a song. This could be by being in the song artist credits ("artist"), as a musician ("Guitar", "Orchestra" or "vocals" etc.), as composer, conductor, lyricist etc. or involved in some other way as music professional e.g. producer, engineer, mixer etc. This is a lookup table that enumerates the various roles that have been read from tags embedded in music files.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idrole || integer || Primary Key |||| ||
|-
|strRole || text || Description of role ||||
ARTIST; ARRANGER; COMPOSER; <br />
CONDUCTOR; DJMIXER; ENGINEER; <br />
LYRICIST; MIXER; ORCHESTRA; <br />
PERFORMER; PRODUCER; REMIXER<br />
||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== song ====
A song. It is the way that the individual track(s) from a music file are held in the music library. Generally a music file contains just one song, however it may contain more and have an associated cuesheet (separately or embedded) that identifies the individual tracks. A song may be from an album (the release of several tracks as one product so includes EPs etc. ), or a single. Singles from an artist (no album title given in the embedded tags) are internally linked with a fake album in the album table.

The music library can contain songs with the same title, artist credits, track number and album as long as they come from separate music files. Unexpectedly Musicbrainz Track ID is not unique on an album, recordings are sometimes repeated e.g. "[silence]" or on a disc set.

{|class="prettytable"
! Column Name || Data Type || Description |||| [[Music_tagging#Data_Kodi_Scrapes|MusicFileTag]] ** || NFO (xml) Tag
|-
|idSong || integer || ID from song table |||| ||
|-
|idAlbum || integer || ID from album table |||| ||
|-
|idPath || integer || Foreign key to [[Databases#path|path table]] |||| ||
|-
|strArtists || text || Song artist(s) description (not always a concatenation of names) |||| ARTIST || <artistdesc></artistdesc>
|-
|strGenres || text || Song Genres (denormalised concatenation of values in genre table) |||| GENRE || <genre></genre> ^^^^
|-
|strTitle || varchar(512) || Song title |||| TITLE || <title></title>
|-
|iTrack || integer || Song track number |||| TRACKNUMBER+DISCNUMBER || <position></position>
|-
|iDuration || integer || Song duration in seconds |||| || <duration></duration>
|-
|iYear || integer || Songs release year |||| YEAR or DATE ||
|-
|dwFileNameCRC || text || [unused] |||| ||
|-
|strFileName || text || Name of music file |||| ||
|-
|strMusicBrainzTrackID || text || Musicbrainz track ID |||| MUSICBRAINZ_TRACKID || <musicBrainzTrackID></musicBrainzTrackID>
|-
|iTimesPlayed || integer || Play count |||| ||
|-
|iStartOffset || integer || Start position (in seconds) when song from cuesheet |||| ||
|-
|iEndOffset || integer || End position (in seconds) when song from cuesheet |||| ||
|-
|idThumb || integer || [unused] |||| ||
|-
|lastplayed || varchar(20) || Date & time last played |||| ||
|-
|rating || char || Song rating |||| ||
|-
|userrating || integer || Song rated by user (out of 10) |||| ||
|-
|comment || text || Song description or comment |||| COMMENT ||
|-
|mood || text || Song mood |||| MOOD ||
|-
|dateAdded || text || Music file timestamp |||| ||
|-
|votes || integer || Votes for song rating |||| ||
|}

{|class="prettytable"
!'''Notes'''
|-
|** || MusicFileTag column shows Vorbis/Flac tags. Click on column heading for other tag types
|-
|^^ || Multiple entries of the tag are allowed
|-
|^^^^ || concatenation of multiple entries
|}

==== song_artist ====
This table links songs to artists and the roles they contributed.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|idRole || integer || Foreign key to [[Databases#role|role table]]
|-
|iOrder || integer || Order in artist credits
|-
|strArtist || text || Name of artist (denormalised)
|}

==== song_genre ====
This table links the songs with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|iOrder || integer || Genre order when concatenating to single string
|}

==== version(music) ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of the music database
|-
|iCompressCount || integer || Number of times database has been compressed
|}

== The Video Library ==
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi. The following information is for version 75.

The video database is stored in userdata/Database/MyVideosXX.db, where XX is the version number.

{{red|The current database in use for v17 is MyVideos107.db}}

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

==== episodeview ====
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Used- unknown
|-
|c20 || text || Used- unknown
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || text || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|userrating || text || User Rating
|-
|idSeason || text || Foreign key to the [[Databases#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== movieview ====
A view that joins movie to file and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Image URL
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c22 || text || Path to playable file
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== musicvideoview ====
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text ||
|-
|c14 || text ||
|-
|c15 || text ||
|-
|c16 || text ||
|-
|c17 || text ||
|-
|c18 || text ||
|-
|c19 || text ||
|-
|c20 || text ||
|-
|c21 || text ||
|-
|c22 || text ||
|-
|c23 || text ||
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|}

==== tvshowview ====
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== tvshow counts ====
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|}

=== Tables ===
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases#episode|episode]], [[Databases#movie|movie]], [[Databases#settings|settings]], and [[Databases#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

==== actor ====
This table stores actor, artist, director, and writer information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Primary Key
|-
|name || integer || Name of the actor, artist, director, or writer
|-
|art_urls|| text || Image URL
|}

==== actor_link ====
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#tvshow|tv show table]], [[Databases#movie|movie table]],[[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, TV Show, Episode, Music Video
|-
|role || text || Role the actor played
|-
|cast_order || integer || Order actors will be displayed
|}==== art ====
This table stores URLs for video art metadata.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || The id of the media this piece of art is for
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart
|-
|url || text || Image URL
|}

==== bookmark ====
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idBookmark || integer || Primary Key
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|timeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || integer || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark
|-
|player || text || Player used to store bookmark
|-
|playerState || text || Player's internal state in XML
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode)
|}

==== country ====
This table lists countries.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Primary Key
|-
|name || text || Country Name
|}

==== country link ====
This table links countries to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases#movie|movie table]]
|-
|media_type || integer || Movie
|}

==== director_link ====
This table links directors to Movies, TV show episodes and Music Videos
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#movie|movie table]],[[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

==== episode ====
This table stores television episode information. Information concerning the series is stored in [[Databases#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Used- unknown
|-
|c20 || text || Used- unknown
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || text || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|userrating || text || User Rating
|-
|idSeason || text || Foreign key to the [[Databases#seasons|seasons table]]
|}

==== files ====
This table stores filenames and links the path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Primary Key
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|-
|strFilename || text || Full name of file including extension
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|}

==== genre ====
This table stores genre information. For convenience the contents are duplicated in [[Databases#movie|movie]] and [[Databases#tvshow|tvshow]], so a join isn't necessary.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Primary Key
|-
|name || text || Genre label
|}

==== genre_link ====
This table links genres to movies. (The contents are also stored in movies.c14, though.)
{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases#movie|movie table]], [[Databases#tvshow|tv show table]], [[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

==== movie ====
This table stores movie information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Image URL
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c22 || text || Path to playable file
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|}

==== movielinktvshow ====
This table links movies to TV shows.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== musicvideo ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Unknown
|-
|c15 || text || Unknown
|-
|c16 || text || Unknown
|-
|c17 || text || Unknown
|-
|c18 || text || Unknown
|-
|c19 || text || Unknown
|-
|c20 || text || Unknown
|-
|c21 || text || Unknown
|-
|c22 || text || Unknown
|-
|c23 || text || Unknown
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|}

==== path ====
This table stores path information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || XML file of scraper used for this path
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||

|-
|dateAdded || text ||

|-
|idParentPath || integer ||
|}

==== rating ====
This table stores the ratings for TV Shows, Episodes and Movies
{|class="prettytable"
! Column Name || Data Type || Description
|-
|rating_id || integer || Primary Key
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#tvshow|tv show table]], [[Databases#movie|movie table]],
|-
|media_type || text || Movies, TV Show, TV Episode
|-
|rating_type || text || default
|-
|rating || float || rating from scraper site
|-
|votes || integer || votes from scraper site
|}

==== seasons ====
This table stores the links between tv show and seasons.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow|| integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|season || integer || Season number
|-
|name || integer || Unknown
|-
|userrating || integer || User Rating
|}

==== sets ====
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSet || integer || Primary Key
|-
|strSet || text || The name of the set
|-
|strOverview || text || The description of the set
|}

==== settings ====
This table stores settings for individual files.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || integer || Brightness
|-
|Contrast || integer || Contrast
|-
|Gamma || integer || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|OutputToAllSpeakers || bool || OutputToAllSpeakers
|-
|ResumeTime || integer || ResumeTime
|-
|Crop || bool || Crop
|-
|CropLeft || integer || CropLeft
|-
|CropRight || integer || CropRight
|-
|CropTop || integer || CropTop
|-
|CropBottom || integer || CropBottom
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|}

==== stacktimes ====
This table stores playing times for files (used for playing multi-file videos).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|times|| text || Times
|}

==== streamdetails ====
This table contains information regarding codecs used, aspect ratios etc
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles
|-
|strVideoCodec|| text || Video codex (xvid etc)
|-
|fVideoAspect|| real || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
|-
|iVideoDuration|| integer ||
|-
|strStereoMode || text || Stereo Mode
|-
|strVideoLanguage|| text || Language of the Video
|}

==== studio ====
This table stores studio information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Primary Key
|-
|name || text || Studio Label
|}

==== studio link ====
This table links studios to movies, music videos and tv shows
{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases#movie|movie table]], [[Databases#tvshow|tv show table]], [[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

==== tag ====
This stores tags.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Primary Key
|-
|name || integer || Tag
|}

==== taglinks ====
This table links tags to various media.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

==== tvshow ====
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases#episode|episode]]. To link a TV show to its episodes, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date tv show premiered
|}

==== tvshowlinkpath ====
This table links a TV show to its path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|}

==== uniqueid ====
This table links a Movie, TV show and Episode to its the scraper site
{|class="prettytable"
! Column Name || Data Type || Description
|-
|uniqueid || integer || Primary Key
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|-
|value || text || ID at scraper site
|-
|type || text || Scraper site
|}

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== writer_link ====
This table links writers stored in the actors table to movies and episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== The View Modes Database ==
Kodi can track a user's View Mode for every path, so you could browse movies using DVD Thumbs and browse TV shows using Fanart. This database contains the last view and sorting method a user chose for each path while navigating Kodi.

The View Modes database is stored in userdata/Database/ViewModes.db.

{{red|The current database in use for v17 is ViewModes6.db}}

=== Tables ===
The View Modes database uses only two tables. Most of the useful information is in [[Databases#view|view]].

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== view ====
This table stores details on the saved view mode for all known paths.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idView || integer || Primary Key
|-
|window || integer || Window GUI ID
|-
|path || text || Path to trigger the view on
|-
|viewMode || integer || View Mode
|-
|sortMethod || integer || ID of sort method
|-
|sortOrder || integer || Sort order (ascending or descending)
|-
|sortAttributes || integer ||
|-
|skin || text || Skin settings apply to
|}

== See also ==
* [[Version table]]
* [[MySQL]]

{{Top}}

{{updated|17}}
[[Category:Index]]
[[Category:Manual]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Development]]

User:Karellen/scratchpad01

2017-08-31T14:54:31Z

DaveBlake: /* Music Tags */

{{mininav|[[Video library]] {{l2|[[Music library]]}}|[[Video management|Management]] <br />  }}

<section begin="intro" />NFO files can be used to provide metadata to the library for video and a music files. They are helpful if the metadata fetched from a web site does not match the video or music you have, or if data for that particular file does not exist, such as for home movies. It can also be used to control the search behaviour of scrapers.<section end="intro" />

= What is nfo =
'''nfo''' is a contraction of Info or Information. It is a Filename Extension - ''mymovie.nfo'' and the contents of the file are written in [http://en.wikipedia.org/wiki/XML XML]. The file itself does nothing except hold information. It is basically a text document with special tags inserted around the information. These tags are recognised by Kodi which enables data importing.

Kodi uses nfo files as one way of importing metadata into the library. It may also be used as a method of exporting the library for various reasons, including backup. '''''See: [[Import-Export_library | Import & Export]]'''''

One of the most considered features of Kodi is the way media is displayed. Gone are the days when choosing a movie to watch or album to listen to involved scrolling through lines of text. Kodi uses [[Artwork]], and Extended Information to display your media. This information includes Actors, Directors, Plots, Taglines, Ratings, Run Times and more. All this data, known as metadata, is stored in the Kodi Library. The Library is a [http://www.sqlite.org/ SQLite database].

There are two primary methods to load metadata into your library:
#Use the online scraper
#Create a nfo file, from which Kodi is able to import the metadata

For information on how to use the online scraper within Kodi:<br />
:'''''See: [[Adding_music_to_the_library]]'''''
:'''''See: [[Adding_video_sources]]'''''
:'''''See: [[Set_content_and_scan]]'''''<br />

'''The remainder of this wiki topic will provide the required information to create and use nfo files.'''

= Types of nfo =
Kodi can use the nfo file in one of two ways depending on the contents of the nfo file. This page primarily deals with the Metadata nfo.

== Metadata nfo ==
This is the most common use of the nfo file. The Metadata nfo contains the metadata for the movie/tv show/music video/album/artist within the file. Kodi will read this file and scrape its contents into the library.

== Parsing nfo ==
A Parsing nfo does not contain any metadata that Kodi can use to scrape into the library. Instead it contains the URL to the movie/tv show/album/artist that you want scraped.
As an example, searching for ''The Mummy'' on [https://www.themoviedb.org/ TMDB] returns 65 titles. If you are attempting to add one of the more obscure versions to your library, chances are that Kodi will scrape the incorrect title, and trying to navigate to the 65th entry will be problematic. The parsing nfo offers an easy solution to this problem.
To create and use the parsing nfo, follow these steps:
#Locate the title at the appropriate scraper site
#Ensure you have named your files/folder the same as shown on the scraper site and in accordance with the [[Naming_video_files|Kodi naming conventions]]
#Open a text editor.
#Copy the entire address of the movie at the scraper site from the address bar and paste it into the text editor. No surrounding tags are required. ''see example after step 6''
#Save the file in accordance with the naming convention in section 4 below. '''Ensure the extension is *.nfo and not *.nfo.txt or *.nfo.doc'''
#Run an Update Library. Kodi will parse the URL and locate the title and scrape the correct metadata.
https://www.themoviedb.org/movie/15849-the-mummy''


= Creating nfo =
The following are the three methods that may be used to create nfo files for Kodi. The simplest method is using a Media Manager.

== Media Managers ==
This is, by far, the simplest method for creating nfo files for your media. The Media Manager can create nfo files in one of three ways:
#Scraping- This is the same process as performed by the Kodi scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file, unlike Kodi that imports the metadata directly into the library database.
#Manual- The Media Manager offers a simple interface that allows you to manually type in the data. This method does not require you to have knowledge of XML tags
#Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then simply modify it.

Once the program has been setup and pointed at your media, very little input is required by the user. Select a movie, tv show, album or artist and select scrape. Depending upon your settings, the media manager will scrape the media and create the nfo which is placed in the correct location with the media file. It can also download all artwork for the media.
There are a few media managers available. The following managers can be found in the Kodi forum:
*[https://forum.kodi.tv/showthread.php?tid=259449 Ember Media Managers]
*[https://forum.kodi.tv/showthread.php?tid=142723 Tiny Media Manager aka TMM]
*[https://forum.kodi.tv/showthread.php?tid=129134 Media Companion 3]
*[https://forum.kodi.tv/showthread.php?tid=136333 MediaElch]

Further information, screenshots and guides are available at the websites of the Media Managers.

== Kodi Created nfo ==
This option requires that your library has already been scraped with metadata. Using the built in import/export function of Kodi, you can export the library metadata into individual nfo files which are correctly created and saved. This is useful if you have an existing library and would like to backup the library or to import the library into another Kodi installation.
:'''''See: [[Import-Export_library | Import & Export]]'''''

== Manual Creation ==
The more difficult of the three methods. It requires basic knowledge of XML Tags. They can be created using a simple text editor such as Notepad in Windows, or the equivelant in other operating systems. There are dedicated code editors that can also be used. They will not provide the required Kodi tags, but they will avoid glitches when saving the nfo file, which is commonly experienced with text editors.
Two common code editors that can be used:
*[https://notepad-plus-plus.org/ Notepad++]
*[https://code.visualstudio.com/ Visual Studio Code]

Requirements of the nfo file are as follows:
#Each Tag must have an opening tag and a closing tag. eg ''<title>my movie title</title>''. '''''<title>''''' = opening tag, '''''my movie title''''' = metadata, '''''</title>''''' = closing tag
#The file must be in Unicode Transformation Format-8 (UTF-8). The file must be saved in this format. The first line of the file must contain the following ''<?xml version="1.0" encoding="UTF-8" standalone="yes"?>''
#The second line may contain a note detailing the creation time and date. It may also include the name of the media manager, if one was used to create it. This is optional. ''''
#The next line sets the nfo category - <movie>, <tvshow>, <episodedetails>, <artist>, <album> or <musicvideo>
#Between the opening and closing category tags are the tags for the media metadata.
#Available tags are listed in Section 8

Once created, the file is saved with the nfo extension and placed in the folder as directed in Section 4.

See example nfo files in Section 7

= nfo Placement =
Correct placement of the nfo file is essential. Failing to save the file in the correct location, as detailed below, will force Kodi to scrape the information from online sources or, if you have ''Local Info Only'' set as your scraper, then no entry will be made into the library.

The order of importing metadata is as follows:
#nfo file. If no nfo file exists then
#online scraper sites

When Kodi locates the nfo file it will load the *.nfo file and attempt to either,
#If the nfo file contains XML data (tags), Kodi will import the meta-data directly into the library from the .nfo file or
#Will parse the nfo file for a direct URL to the scraper info page.

== Movies ==
Movies require one nfo file as follows:

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Movie *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |BluRay Structure:
| width=300px |index.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\BDMV\index.nfo
|- valign="top"
| width=200px |DVD Structure:
| width=300px |VIDEO_TS.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\VIDEO_TS.nfo
|- valign="top"
| width=200px |Single movie in directory:
| width=300px |<MovieFileName>.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\<MovieFileName>.nfo
|- valign="top"
| width=200px |All movies in single directory:
| width=300px |<MovieFileName>.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\<MovieFileName>.nfo
|}
</div>

== TV Shows ==
TV Shows require the following nfo files
#One nfo file for the TV Show. See the first table below
#One nfo file for '''each''' Episode. See the second table below
For one TV Show with 10 episodes, you will require 11 nfo files.

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your TV Show *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved TV Show as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |All formats
| width=300px |tvshow.nfo
| width=600px |f:\MyTVShows\iZombie\tvshow.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming & Saving conventions for your TV Episode *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Episodes as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |BluRay Structure:
| width=300px |index.nfo
| width=600px |f:\MyTVShows\iZombie\iZombie S01E01\BDMV\index.nfo
|- valign="top"
| width=200px |DVD Structure:
| width=300px |VIDEO_TS.nfo
| width=600px |f:\MyTVShows\iZombie\iZombie S01E01\VIDEO_TS\VIDEO_TS.nfo
|- valign="top"
| width=200px |Single Episode file in directory:
| width=300px |<EpisodeFileName>.nfo
| width=600px |f:\MyTVShows\iZombie\iZombie S01E01\<EpisodeFileName>.nfo
|- valign="top"
| width=200px |All episodes in TV Show directory:
| width=300px |<MovieFileName>.nfo
| width=600px |f:\MyTVShows\iZombie\<EpisodeFileName>.nfo
|}
</div>

== Music ==
Music will fetch additional album and album artist information from nfo files.

For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional '''album artist''' information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

{{note|There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly.
However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.NFO file, and give the artist some other artist's information, or fail to fine the artist.nfo you created}}

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Artist as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |artist.nfo
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Album as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |album.nfo
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
|}
</div>

== Music Videos ==
Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Music Videos *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Music Videos as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |All formats
| width=300px |<MusicVideoFileName>.nfo
| width=600px |f:\MyMusicVideos\<MusicVideoFileName>.nfo
|}
</div>

= Scraping nfo files =
There is no special procedure to scrape nfo files. Performing the usual Library Update will scrape the nfo files into the library. Be aware that nfo files are not easily interchangeable between Movies, TV Shows, Artists and Albums. Although they all share common tags, each also has its own specific tags that won't be recognised in other parts of the library.

'''After the NFO files are scanned into the library, the NFO file is no longer used and only serves as a backup. If you make changes to the NFO file you will need to '''[[refresh]]''' that library entry for the changes to be loaded into Kodi.'''

Kodi also contains a Local-NFO-only mode for when you add videos to the library, but this mode is only required if you want to prevent online-lookups for videos that lack NFO files. See '''[[Set content and scan#Local NFO only options]]''' for more information on this Local-NFO-only mode.

= Advancedsettings.xml =

= Sample nfo Files =
Provided below are sample nfo files to assist with the manual creation process

== Movie nfo ==
Sample Movie nfo file

{{collapse top| Movie nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<movie>
<title>Ghost in the Shell</title>
<originaltitle>Ghost in the Shell</originaltitle>
<sorttitle></sorttitle>
<rating>5.9</rating>
<year>2017</year>
<top250></top250>
<votes>1936</votes>
<outline>In the near future, Major is the first of her kind: a human saved from a terrible crash, then cyber-enhanced to be a perfect soldier devoted to stopping the world's most dangerous criminals.</outline>
<plot>In the near future, Major is the first of her kind: a human saved from a terrible crash, then cyber-enhanced to be a perfect soldier devoted to stopping the world's most dangerous criminals.</plot>
<tagline>There's nothing sadder than a puppet without a ghost.</tagline>
<runtime>107</runtime>
<thumb>https://assets.fanart.tv/fanart/movies/315837/movieposter/ghost-in-the-shell-5951b7c0843b0.jpg</thumb>
<fanart>http://image.tmdb.org/t/p/original/dXJh6bXF3WI1gpNuM3tNbnIiW2z.jpg</fanart>
<mpaa>AU:M</mpaa>
<certification>AU:M</certification>
<id>tt1219827</id>
<ids>
<entry>
<key>tmdb</key>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">315837</value>
</entry>
<entry>
<key>imdb</key>
<value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">tt1219827</value>
</entry>
</ids>
<tmdbId>315837</tmdbId>
<country>Australia, New Zealand, United States, United Kingdom, India, China, Canada, Japan, Hong Kong</country>
<premiered>2017-03-29</premiered>
<fileinfo>
<streamdetails>
<video>
<codec>h264</codec>
<aspect>1.78</aspect>
<width>1920</width>
<height>1080</height>
<durationinseconds>6417</durationinseconds>
</video>
<audio>
<codec>TrueHD AC3</codec>
<language>eng</language>
<channels>8</channels>
</audio>
<subtitle>
<language>eng</language>
</subtitle>
<subtitle>
<language>eng</language>
</subtitle>
</streamdetails>
</fileinfo>
<watched>false</watched>
<playcount>0</playcount>
<genre>Action</genre>
<genre>Crime</genre>
<genre>Drama</genre>
<genre>Mystery</genre>
<genre>Science Fiction</genre>
<genre>Thriller</genre>
<studio>Paramount Pictures</studio>
<studio>DreamWorks SKG</studio>
<studio>Shanghai Film Group</studio>
<studio>Reliance Entertainment</studio>
<studio>Arad Productions</studio>
<studio>Grosvenor Park Productions</studio>
<studio>Steven Paul Production</studio>
<studio>Huahua Media</studio>
<studio>Seaside Entertainment</studio>
<studio>Amblin Partners</studio>
<studio>Weying Galaxy Entertainment</studio>
<credits>Ehren Kruger</credits>
<credits>Jamie Moss</credits>
<credits>Masamune Shirow</credits>
<credits>William Wheeler</credits>
<director>Rupert Sanders</director>
<tag>BluRay</tag>
<actor>
<name>Scarlett Johansson</name>
<role>Major Motoko Kusanagi</role>
<thumb>http://image.tmdb.org/t/p/w185/8EueDe6rPF0jQU4LSpsH2Rmrqac.jpg</thumb>
</actor>
<actor>
<name>Pilou Asb├ªk</name>
<role>Batou</role>
<thumb>http://image.tmdb.org/t/p/w185/wcQRF5ZOBY8NX7xrjXE2pOBmwyZ.jpg</thumb>
</actor>
<actor>
<name>Takeshi Kitano</name>
<role>Daisuke Aramaki</role>
<thumb>http://image.tmdb.org/t/p/w185/xkXZ7HC8uyhu5MtNnbdP8mhdiFN.jpg</thumb>
</actor>
<actor>
<name>Juliette Binoche</name>
<role>Dr. Ou├⌐let</role>
<thumb>http://image.tmdb.org/t/p/w185/rkW6eE75Tt1i3J1s2fsIDZBW0kd.jpg</thumb>
</actor>
<actor>
<name>Michael Pitt</name>
<role>Hideo Kuze</role>
<thumb>http://image.tmdb.org/t/p/w185/fWR4Z1xk1ZMUMMnMeRADVh1s3DW.jpg</thumb>
</actor>
<actor>
<name>Chin Han</name>
<role>Togusa</role>
<thumb>http://image.tmdb.org/t/p/w185/xvMCVDvrQ2WlAB2LmkG6HAzlYag.jpg</thumb>
</actor>
<actor>
<name>Lasarus Ratuere</name>
<role>Ishikawa</role>
<thumb>http://image.tmdb.org/t/p/w185/tATw6bSySFmqunfBXmyy0ppbsXi.jpg</thumb>
</actor>
<actor>
<name>Yutaka Izumihara</name>
<role>Saito</role>
<thumb>http://image.tmdb.org/t/p/w185/rGPYp0jWNplBEv1vWDbmpysaGte.jpg</thumb>
</actor>
<actor>
<name>Tawanda Manyimo</name>
<role>Borma</role>
<thumb>http://image.tmdb.org/t/p/w185/vUpTeHW9Yokx2R2sipMZdiTfiIk.jpg</thumb>
</actor>
<actor>
<name>Rila Fukushima</name>
<role>Red Robed Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/AsxUTMScQetJ1Iommki98w3rHPH.jpg</thumb>
</actor>
<actor>
<name>Michael Wincott</name>
<role>Dr. Osmund</role>
<thumb>http://image.tmdb.org/t/p/w185/pvKUzexxZT4sRTT1BczzrwX8ghz.jpg</thumb>
</actor>
<actor>
<name>Anamaria Marinca</name>
<role>Dr. Dahlin</role>
<thumb>http://image.tmdb.org/t/p/w185/ajLN2RMuYHgTEFAzs8x8vZH0Rlu.jpg</thumb>
</actor>
<actor>
<name>Daniel Henshall</name>
<role>Skinny Man</role>
<thumb>http://image.tmdb.org/t/p/w185/4LYeThK5O9EUy1OllvdsD5bTRbb.jpg</thumb>
</actor>
<actor>
<name>Kaori Momoi</name>
<role>Hairi</role>
<thumb>http://image.tmdb.org/t/p/w185/aHPQaKWk1foxvieDZubUJE8olaO.jpg</thumb>
</actor>
<actor>
<name>Peter Ferdinando</name>
<role>Cutter</role>
<thumb>http://image.tmdb.org/t/p/w185/eSxMkW04VuOkQqxG2HIPw0FMJKe.jpg</thumb>
</actor>
<actor>
<name>Christopher Obi</name>
<role>Ambassador Kiyoshi</role>
<thumb>http://image.tmdb.org/t/p/w185/9mkVa3qKba8S7UcyzUYZPkeRG37.jpg</thumb>
</actor>
<actor>
<name>Danusia Samal</name>
<role>Ladriya</role>
<thumb>http://image.tmdb.org/t/p/w185/8FqUG5hRe9MskGzXzx8ktS7b20y.jpg</thumb>
</actor>
<actor>
<name>Mana Hira Davis</name>
<role>Bearded Man</role>
<thumb>http://image.tmdb.org/t/p/w185/fBDzK8Vd7XBx97nsH9sXXGf4nMD.jpg</thumb>
</actor>
<actor>
<name>Adwoa Aboah</name>
<role>Lia</role>
<thumb>http://image.tmdb.org/t/p/w185/jD8FV3TcLNJe64udKygGLnHkP6K.jpg</thumb>
</actor>
<actor>
<name>Kai Fung Rieck</name>
<role>Diamond Face</role>
<thumb>http://image.tmdb.org/t/p/w185/mqS7nagL7Dp1QK1152eyfT1RjOI.jpg</thumb>
</actor>
<actor>
<name>Andrew Stehlin</name>
<role>No Pupils</role>
<thumb>http://image.tmdb.org/t/p/w185/kcDr96zRyuM3IiR5RWPV14D5dMK.jpg</thumb>
</actor>
<actor>
<name>Matthias Luafutu</name>
<role>Thick Built Yakuza</role>
<thumb>http://image.tmdb.org/t/p/w185/65KBlRWu561lTVPHlhgHskprLOh.jpg</thumb>
</actor>
<actor>
<name>John Luafutu</name>
<role>Barkeep</role>
<thumb>http://image.tmdb.org/t/p/w185/ryhkaAVyAxAfCUj6P12EkYO8Rk4.jpg</thumb>
</actor>
<actor>
<name>Kaori Yamamoto</name>
<role>Motoko</role>
<thumb>http://image.tmdb.org/t/p/w185/iJFsfqfmUy14kU2VNrxE3JGVBAY.jpg</thumb>
</actor>
<actor>
<name>Pete Teo</name>
<role>Tony</role>
<thumb>http://image.tmdb.org/t/p/w185/7bJutZz5qd2rYBHHC2gyMQWNQbu.jpg</thumb>
</actor>
<actor>
<name>Tanya Drewery</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/7Q4eMvFKcmYSUfLSlNMHtlSkoKh.jpg</thumb>
</actor>
<actor>
<name>Jacqueline Lee Geurts</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/9YcJF1avZliG3Mu01mUQxuiUuu4.jpg</thumb>
</actor>
<actor>
<name>Hannah Tasker-Poland</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/fpXCLG1HbNlPl6nEDnqQTvohMEm.jpg</thumb>
</actor>
<actor>
<name>Emma Coppersmith</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/aAHgg8eO7kaHw0Mmn1jatBxmRYv.jpg</thumb>
</actor>
<actor>
<name>Shinji Ikefuji</name>
<role>Kinsana</role>
<thumb>http://image.tmdb.org/t/p/w185/6m1scLGa91uDDYBftdEcEOuXrAm.jpg</thumb>
</actor>
<actor>
<name>Xavier Horan</name>
<role>Section Six Soldier</role>
<thumb>http://image.tmdb.org/t/p/w185/yNdHNB90SXulSRLqbYeZ5JXppqO.jpg</thumb>
</actor>
<actor>
<name>Allan Henry</name>
<role>Section Six Soldier</role>
<thumb>http://image.tmdb.org/t/p/w185/ma3ZFzGiF4ANlEym3ACFOG0n7qV.jpg</thumb>
</actor>
<actor>
<name>Joseph Naufahu</name>
<role>Police Commander Johns</role>
<thumb>http://image.tmdb.org/t/p/w185/9N4UmM1runLmdhzIhZ5Xfk4Qo21.jpg</thumb>
</actor>
<actor>
<name>Makoto Murata</name>
<role>Yakuza Gunman</role>
<thumb>http://image.tmdb.org/t/p/w185/f32b7dh8dg5s5LWXyiSYZacDQAG.jpg</thumb>
</actor>
<producer>
<name>Avi Arad</name>
<role>Producer</role>
<thumb>http://image.tmdb.org/t/p/w185/kIG4HF5LSywU0ZdDheDaEsxxohu.jpg</thumb>
</producer>
<producer>
<name>Leslee Feldman</name>
<role>Casting</role>
</producer>
<producer>
<name>Mitsuhisa Ishikawa</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Steven Paul</name>
<role>Producer</role>
</producer>
<producer>
<name>Jeffrey Silver</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Lucy Bevan</name>
<role>Casting</role>
</producer>
<producer>
<name>Mark Sourian</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Michael Costigan</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Mark Sussman</name>
<role>ADR Voice Casting</role>
</producer>
<producer>
<name>Ari Arad</name>
<role>Producer</role>
</producer>
<producer>
<name>Miranda Rivers</name>
<role>Casting</role>
</producer>
<producer>
<name>Maguy R. Cohen</name>
<role>Producer</role>
</producer>
<producer>
<name>Patty Majorczak-Connolly</name>
<role>ADR Voice Casting</role>
</producer>
<producer>
<name>C├⌐cile Bouquet</name>
<role>Researcher</role>
</producer>
<producer>
<name>Tetsuya Fujimura</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Nanw Rowlands</name>
<role>Casting Associate</role>
</producer>
<languages>Japanese, English</languages>
</movie>

{{collapse bottom}}

== TV Show nfo ==
Sample TV Show nfo

{{collapse top| TV Show nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<tvshow>
<title>iZombie</title>
<sorttitle></sorttitle>
<year>2015</year>
<rating>8.3</rating>
<votes>66</votes>
<plot>When over-achieving medical resident Liv Moore attends a party that turns into a zombie feeding frenzy, she ends up joining the ranks of the living dead.</plot>
<mpaa>E</mpaa>
<episodeguide>
<url cache="281470.xml">http://www.thetvdb.com/api/1D62F2F90030C444/series/281470/all/en.xml</url>
</episodeguide>
<id>281470</id>
<imdbid>tt3501584</imdbid>
<genre>Action</genre>
<genre>Comedy</genre>
<genre>Crime</genre>
<genre>Drama</genre>
<genre>Horror</genre>
<premiered>2015-03-17</premiered>
<status>Continuing</status>
<studio>The CW</studio>
<actor>
<name>Rose McIver</name>
<role>Olivia "Liv" Moore</role>
<thumb>http://thetvdb.com/banners/actors/346010.jpg</thumb>
</actor>
<actor>
<name>Rahul Kohli</name>
<role>Dr. Ravi Chakrabarti</role>
<thumb>http://thetvdb.com/banners/actors/346008.jpg</thumb>
</actor>
<actor>
<name>Robert Buckley</name>
<role>Major Lilywhite</role>
<thumb>http://thetvdb.com/banners/actors/329726.jpg</thumb>
</actor>
<actor>
<name>Aly Michalka</name>
<role>Peyton Charles</role>
<thumb>http://thetvdb.com/banners/actors/437907.jpg</thumb>
</actor>
<actor>
<name>Malcolm Goodwin</name>
<role>Clive Babineaux</role>
<thumb>http://thetvdb.com/banners/actors/346009.jpg</thumb>
</actor>
<actor>
<name>David Anders</name>
<role>Blaine</role>
<thumb>http://thetvdb.com/banners/actors/329728.jpg</thumb>
</actor>
<actor>
<name>Tongayi Chirisa</name>
<role>Justin Bell</role>
<thumb>http://thetvdb.com/banners/actors/437906.jpg</thumb>
</actor>
<actor>
<name>Andrea Savage</name>
<role>Vivian Stoll</role>
<thumb>http://thetvdb.com/banners/actors/437905.jpg</thumb>
</actor>
<actor>
<name>Jason Dohring</name>
<role>Chase Graves</role>
<thumb>http://thetvdb.com/banners/actors/437903.jpg</thumb>
</actor>
<actor>
<name>Nick Purcha</name>
<role>Evan Moore</role>
<thumb>http://thetvdb.com/banners/actors/436318.jpg</thumb>
</actor>
<actor>
<name>Leanne Lapp</name>
<role>Rita/Gilda</role>
<thumb>http://thetvdb.com/banners/actors/436317.jpg</thumb>
</actor>
<actor>
<name>Greg Finley</name>
<role>Drake Holloway</role>
<thumb>http://thetvdb.com/banners/actors/436315.jpg</thumb>
</actor>
<actor>
<name>Jessica Harmon</name>
<role>Dale Bozzio</role>
<thumb>http://thetvdb.com/banners/actors/436314.jpg</thumb>
</actor>
<actor>
<name>Bryce Hodgson</name>
<role>Don Everhart</role>
<thumb>http://thetvdb.com/banners/actors/430151.jpg</thumb>
</actor>
<actor>
<name>Bradley James</name>
<role>Lowell Tracey</role>
<thumb>http://thetvdb.com/banners/actors/417361.jpg</thumb>
</actor>
</tvshow>
{{collapse bottom}}

== TV Show Episode nfo ==
Sample TV Episode nfo

{{collapse top| TV Episode nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails>
<title>The Bone Orchard</title>
<showtitle>American Gods</showtitle>
<ratings>
<rating name="default" max="10" default="true">
<value>7.400000</value>
<votes>14</votes>
</rating>
</ratings>
<userrating>0</userrating>
<top250>0</top250>
<season>1</season>
<episode>1</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>When Shadow Moon is released from prison early after the death of his wife, he meets Mr. Wednesday and is recruited as his bodyguard. Shadow discovers that this may be more than he bargained for.</plot>
<tagline></tagline>
<runtime>62</runtime>
<mpaa>E</mpaa>
<playcount>1</playcount>
<lastplayed>2017-07-26</lastplayed>
<id>5088686</id>
<uniqueid type="unknown" default="true">5088686</uniqueid>
<genre>Action</genre>
<genre>Adventure</genre>
<genre>Fantasy</genre>
<genre>Mystery</genre>
<credits>Bryan Fuller</credits>
<credits>Michael Green</credits>
<director>David Slade</director>
<premiered>2017-04-30</premiered>
<year>2017</year>
<status></status>
<code></code>
<aired>2017-04-30</aired>
<studio>Starz!</studio>
<trailer></trailer>
<fileinfo>
<streamdetails>
<video>
<codec>h264</codec>
<aspect>1.777778</aspect>
<width>1920</width>
<height>1080</height>
<durationinseconds>3763</durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec>dtshd_ma</codec>
<language>eng</language>
<channels>6</channels>
</audio>
<subtitle>
<language>eng</language>
</subtitle>
</streamdetails>
</fileinfo>
<actor>
<name>Ian McShane</name>
<role>Wednesday</role>
<order>0</order>
<thumb>http://thetvdb.com/banners/actors/418593.jpg</thumb>
</actor>
<actor>
<name>Ricky Whittle</name>
<role>Shadow Moon</role>
<order>1</order>
<thumb>http://thetvdb.com/banners/actors/418586.jpg</thumb>
</actor>
<actor>
<name>Emily Browning</name>
<role>Laura Moon</role>
<order>2</order>
<thumb>http://thetvdb.com/banners/actors/418119.jpg</thumb>
</actor>
<actor>
<name>Pablo Schreiber</name>
<role>Mad Sweeney</role>
<order>3</order>
<thumb>http://thetvdb.com/banners/actors/418590.jpg</thumb>
</actor>
<actor>
<name>Yetide Badaki</name>
<role>Bilquis</role>
<order>4</order>
<thumb>http://thetvdb.com/banners/actors/418588.jpg</thumb>
</actor>
<actor>
<name>Bruce Langley</name>
<role>Technical Boy</role>
<order>5</order>
<thumb>http://thetvdb.com/banners/actors/418587.jpg</thumb>
</actor>
<actor>
<name>Orlando Jones</name>
<role>Nancy</role>
<order>6</order>
<thumb>http://thetvdb.com/banners/actors/418591.jpg</thumb>
</actor>
<actor>
<name>Chris Obi</name>
<role>Jacquel</role>
<order>7</order>
<thumb>http://thetvdb.com/banners/actors/429117.jpg</thumb>
</actor>
<actor>
<name>Demore Barnes</name>
<role>Ibis</role>
<order>8</order>
<thumb>http://thetvdb.com/banners/actors/429116.jpg</thumb>
</actor>
<actor>
<name>Omid Abtahi</name>
<role>Salim</role>
<order>9</order>
<thumb>http://thetvdb.com/banners/actors/428857.jpg</thumb>
</actor>
<actor>
<name>Cloris Leachman</name>
<role>Zorya Vechernyaya</role>
<order>10</order>
<thumb>http://thetvdb.com/banners/actors/421778.jpg</thumb>
</actor>
<actor>
<name>Gillian Anderson</name>
<role>Media</role>
<order>11</order>
<thumb>http://thetvdb.com/banners/actors/421117.jpg</thumb>
</actor>
<actor>
<name>Crispin Glover</name>
<role>World</role>
<order>12</order>
<thumb>http://thetvdb.com/banners/actors/418592.jpg</thumb>
</actor>
<actor>
<name>Peter Stormare</name>
<role>Czernobog</role>
<order>13</order>
<thumb>http://thetvdb.com/banners/actors/418589.jpg</thumb>
</actor>
<actor>
<name>Kristin Chenoweth</name>
<role>Easter</role>
<order>14</order>
<thumb>http://thetvdb.com/banners/actors/418124.jpg</thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2017-07-19 17:50:00</dateadded>
</episodedetails>
{{collapse bottom}}

== Music Artist nfo ==
Sample Music Artist nfo

{{collapse top| Music Artist nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Fleetwood Mac</name>
<musicBrainzArtistID>bd13909f-1c29-4c27-a874-d4aaf27c5b1a</musicBrainzArtistID>
<genre>Rock</genre>
<style>Rock/Pop</style>
<mood>Relaxed</mood>
<yearsactive>1960s - 2010s</yearsactive>
<born></born>
<formed>London, England (1967)</formed>
<biography>Fleetwood Mac are a British-American rock band formed in 1967 in London. The only original member present in the band is its eponymous drummer, Mick Fleetwood.</biography>
<died></died>
<disbanded></disbanded>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-53a0df3715867.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-53a0df3715867.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg</thumb>
<path>E:\Music- Test\Fleetwood Mac\</path>
<fanart>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a08371db4e2.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a08371db4e2.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a083a3607ed.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a083a3607ed.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-51c68f91253a9.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-51c68f91253a9.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-518f8f0a5a483.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-518f8f0a5a483.jpg</thumb>
</fanart>
<album>
<title>Future Games</title>
<year>1971</year>
</album>
<album>
<title>Live in London 1968</title>
<year>1989</year>
</album>
<album>
<title>Bare Trees</title>
<year>1972</year>
</album>
<album>
<title>Tusk</title>
<year>1979</year>
</album>
<album>
<title>In Concert 1982</title>
<year>2010</year>
</album>
<album>
<title>Rumours</title>
<year>1977</year>
</album>
<album>
<title>Say You Will</title>
<year>2003</year>
</album>
<album>
<title>Kiln House</title>
<year>1970</year>
</album>
<album>
<title>Tango in the Night</title>
<year>1987</year>
</album>
<album>
<title>Fleetwood Mac</title>
<year>1975</year>
</album>
<album>
<title>Penguin</title>
<year>1973</year>
</album>
<album>
<title>Mirage</title>
<year>1982</year>
</album>
<album>
<title>Mystery to Me</title>
<year>1973</year>
</album>
<album>
<title>Peter GreenΓÇÖs Fleetwood Mac</title>
<year>1968</year>
</album>
</artist>
{{collapse bottom}}

== Music Album nfo ==
Sample Music Album nfo

{{collapse top| Music Album nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>The Annie Lennox Collection</title>
<musicBrainzAlbumID>957cda28-5e1e-4507-9de7-1d5049415cea</musicBrainzAlbumID>
<artistdesc>Annie Lennox</artistdesc>
<genre>Pop</genre>
<style>TalbumFstrstyles</style>
<mood>TalbumFstrmoods</mood>
<theme>TalbumFstrthemes</theme>
<compilation>false</compilation>
<review>TalbumFstrReview</review>
<type>album/compilation</type>
<releasedate></releasedate>
<label>RCA/19 Recordings</label>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/the-annie-lennox-collection-50b9f63c63338.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/the-annie-lennox-collection-50b9f63c63338.jpg</thumb>
<path>E:\Music Test Test\Annie Lennox\The Annie Lennox Collection\</path>
<rating max="10">0.000000</rating>
<userrating max="10">5</userrating>
<votes>1500</votes>
<year>2003</year>
<albumArtistCredits>
<artist>Annie Lennox</artist>
<musicBrainzArtistID>3e30aebd-0557-4cfd-8fb9-3945afa5d72b</musicBrainzArtistID>
</albumArtistCredits>
<releasetype>album</releasetype>
</album>
{{collapse bottom}}

== Music Video nfo ==
Sample Music Video nfo

{{collapse top| Music Video nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<musicvideo>
<title>Dancing Queen</title>
<userrating>0</userrating>
<top250>0</top250>
<track>-1</track>
<album>Arrival</album>
<outline></outline>
<plot>"Dancing Queen" is a Europop song by the Swedish group ABBA, and the lead single from their fourth studio album, Arrival.</plot>
<tagline></tagline>
<runtime>0</runtime>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg</thumb>
<mpaa></mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<id></id>
<genre>Pop</genre>
<year>1976</year>
<status></status>
<code></code>
<aired></aired>
<trailer></trailer>
<artist>ABBA</artist>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2017-06-15 14:18:10</dateadded>
</musicvideo>
{{collapse bottom}}

= nfo Tags =
A list of all available tags that Kodi recognises follows in this section. As mentioned previously, there are many common tags, but there are also specific tags for each part of the library. Ensure you use the correct tags.

== Movie Tags ==

== TV Show Tags ==

== TV Show Episode Tags ==

== Music Tags ==

<div style="{{linear-gradient|left|#fffddd, #dddfff}}">
'''@Karellen''' is there any way we can avoid calling the NFO stuff "music tags"? Xml metadata perhaps, or xml tags. The essential "music tags" for the library, the tags Kodi uses etc. are those ''embedded'' in the music files themselves using various formats. Users need to be clear that "tagging music" does not mean making NFO files.
</div>

<div style="{{linear-gradient|left|#ffdddd, #ddddff}}">
'''@DaveBlake- This is what I am trying to achieve- show all database fields and the Source of the Data (scraper, file tags etc) and nfo tags.

At first I expected that all nfo tags would have a corresponding database field. I did not expect that some tags would have no database field. So not sure how to show that scenario in these tables yet. Any suggestions? Do you know how many there are?

I would like to keep the Music File Tag column, but that is inaccurate as it is only showing the Vorbis tags, and there are four other tagging styles that will need to be included which makes the table too complicated looking. I created the second table (exactly the same) except without the music file tag column. I will refer to the MusicFile Tags via a link. Your thoughts?

The tables will not be on this page. I will modify the Database Table wiki page, and simply place a link to it in this page.

More questions...

#How do you know when there is a hierarchy with tags and what will be the best way to document that? eg. You have...
<genre><br />
and then...
<album>
<title>Blah</title>
<year>2017</year>
</album>

#Some tags have qualifiers. How do I know when a qualifier can be used...
<userrating max="10">7</userrating>

#Some tags come from Music Files, some Tags come from online Scrapers. Makes sense when first building your library. But when you export your library, some of the Music File Tags are entered into the nfo file. Now we have the same Tag information in the music file and in the nfo. When rebuilding your library, which takes precedence? Does nfo files override the music tags?

Do you have any other suggestions on how to document this?'''

</div>

<div style="{{linear-gradient|left|#fffddd, #fddfff}}">
The NFO data should all go to/come from somewhere in the db, just not always a single db field. The source of data field content can be diverse, scanning is not just about reading data but processing it too. Also some fields are initially set from tags and then can be overwritten by nfo data, there is a merge process involved in scraping.

List what is in NFO and I will tell you where it comes from in db, ''if'' it is written back on scraping (some stuff is exported to NFO just for reference), and if it overwrites the tag data or is sole source of that data.

You note I keep using the word "tags" and I mean those embedded in music files.

Having a tag name in the table is useful. I tend to use the Vorbis (FLAC) tag names for tags because they are nice and descriptive (except RELEASETYPE which is confusing). Kodi could have its own names for these tags I guess, but may as well use Vorbis. The tag table gives the tag names in other formats no need to duplicate that here.

My solution use vorbis name against DB field, comment somewhere that is what has been done and general link to the table elsewhere that lists the tags in the various formats.

Ah Ok, not for NFO page but for DB page. Fine.

XML tag hierarchy: use examples. So make sure that the example album.nfo on the NFO page has multiple genres, album artists, styles etc., examples of every multiple.

In music the only xml tags with a qualitfiers is rating and user rating, they give the max score that the given rating value is out of. This is quite important as we switched from out of 5 to out of 10 as default for rating and caused lots of user anguish.

There is also this http://kodi.wiki/view/Music_tagging#Data_Kodi_Scrapes

Because my xml sucks I'm finding this method of communication frustrating. So if I have left question unanswered, can we do it on Slack?
</div>

<div style="{{linear-gradient|left|#fffddd, #fddfff}}">
Comment on table layout:
I find having the related tags useful, Vorbis name fine, so go with table version 1.

Source of data - well if there is a related tag (or tags) then that is always the initial source of that field, and if there is a related xml tag that is where that value is exported and might be imported/scraped from.
Rather than a "source of data" column I would have a "Import/overwrite" column: overwrites where having "Prefer online information" setting enabled causes the scraped NFO values to replace that from tags (if it has one. Import says NFO (or scraper) can provide. The rest if there is an NFO tag then that value is for human ref and not scraped/imported into db from NFO.

Genres, Year, Compilation and Label may have been derrived from tag data and these will take prescidence. These values can be overwritten by the scraped values if "Prefer Online Information" setting is enabled.

Then I have tried to edit table, but I hate editing wiki tables!!!!
</div>
{|class="prettytable"
! Database Field || Data Type || Description |||| Import/Overwrite || NFO Tag || Music File Tag
|-
|idAlbum || integer || Primary Key ||||
|-
|strAlbum || varchar(256) || Album title |||| Overwrite|| <title> || ALBUM
|-
|strMusicBrainzAlbumID || text || MusicBrainz Album ID (release ID) |||| || <musicBrainzAlbumID> || MUSICBRAINZ_ALBUMID
|-
|strArtists || text || album artist(s) description (not always a concatenation of names) |||| || <artistdesc> || Derived from ALBUMARTIST, ALBUMARTISTS
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table) |||| Overwrite|| <genre> ^^ || GENRE
|-
|iYear || integer || Album release year |||| Overwrite || <year> || YEAR
|-
|idThumb || integer || [Unused] |||| DB Internal
|-
|bCompilation || integer || Compilation flag |||| Overwrite || <compilation> ||COMPILATION
|-
|strMoods || text || Album moods |||| Import || <mood> ^^ ||
|-
|strStyles || text || Album styles |||| Import || <style> ^^ ||
|-
|strThemes || text || Album themes |||| Import || <theme> ^^ ||
|-
|strReview || text || Album review |||| Import || <review> ||
|-
|strImage || text || URLs for available remote album images ||Import|| ||<thumb>
|-
|strLabel || text || Album recording label |||| Overwrite || <label> || LABEL
|-
|strType || text || Album Type e.g. "Soundtrack / Live" |||| Overwrite || <type> || RELEASETYPE
|-
|fRating || float || Album rating |||| Import || <rating max="10"> ||
|-
|iUserrating || integer || Album user rating (out of 10) |||| Import || <userrating max="10"> ||
|-
|lastScraped || text || Date/time data scraped from online sources or NFO files ||||
|-
|strReleaseType || text || Internal type - "album" or "single" || <releasetype> ||
|-
|iVotes || integer || Album votes (for rating) |||| Import || <votes>
|}

^^ Multiple entries allowed<br />

----
----
----

'''To view a list of Music File Tags read by Kodi, ''See : [http://kodi.wiki/view/Music_tagging#Tags_Kodi_reads Tags Kodi Reads]'''''

{|class="prettytable"
! Database Field || Data Type || Description |||| Source of Data || NFO Tag
|-
|idAlbum || integer || Primary Key |||| DB Internal
|-
|strAlbum || varchar(256) || Album title |||| Music File Tag || <title>
|-
|strMusicBrainzAlbumID || text || MusicBrainz Album ID (release ID) |||| Music File Tag || <musicBrainzAlbumID>
|-
|strArtists || text || album artist(s) description (not always a concatenation of names) |||| Music File Tag || <artistdesc>
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table) |||| Music File Tag || <genre> ^^
|-
|iYear || integer || Album release year |||| Music File Tag || <year>
|-
|idThumb || integer || [Unused] |||| DB Internal
|-
|bCompilation || integer || Compilation flag |||| Scraper || <compilation>
|-
|strMoods || text || Album moods |||| Scraper || <mood> ^^
|-
|strStyles || text || Album styles |||| Scraper || <style> ^^
|-
|strThemes || text || Album themes |||| Scraper || <theme> ^^
|-
|strReview || text || Album review |||| Scraper || <review>
|-
|strImage || text || URLs for available remote album images |||| Scraper ^^^ ||
|-
|strLabel || text || Album recording label |||| Music File Tag || <label>
|-
|strType || text || Album Type e.g. "Soundtrack / Live" |||| Music File Tag || <type>
|-
|fRating || float || Album rating |||| Scraper || <rating max="10">
|-
|iUserrating || integer || Album user rating (out of 10) |||| User || <userrating max="10">
|-
|lastScraped || text || Date/time data scraped from online sources or NFO files |||| DB Internal
|-
|strReleaseType || text || Internal type - "album" or "single" |||| Music File Tag || XXXX BUT Shouldn't??
|-
|iVotes || integer || Album votes (for rating) |||| Scraper || <votes>
|}

^^ Multiple entries allowed<br />
^^^ Scraped online, but there is no NFO entry

== Music Video Tags ==

{{top}}

User talk:Karellen/scratchpad01

2017-08-30T12:28:55Z

DaveBlake: Created page with "4.3 Music Previously said "For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there" What gave..."

4.3 Music
Previously said "For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there"

What gave you that idea??

User:Karellen/scratchpad01

2017-08-30T12:27:32Z

DaveBlake: /* Music */

{{mininav|[[Video library]] {{l2|[[Music library]]}}|[[Video management|Management]] <br />  }}

<section begin="intro" />NFO files can be used to provide metadata to the library for video and a music files. They are helpful if the metadata fetched from a web site does not match the video or music you have, or if data for that particular file does not exist, such as for home movies. It can also be used to control the search behaviour of scrapers.<section end="intro" />

= What is nfo =
'''nfo''' is a contraction of Info or Information. It is a Filename Extension - ''mymovie.nfo'' and the contents of the file are written in [http://en.wikipedia.org/wiki/XML XML]. The file itself does nothing except hold information. It is basically a text document with special tags inserted around the information. These tags are recognised by Kodi which enables data importing.

Kodi uses nfo files as one way of importing metadata into the library. It may also be used as a method of exporting the library for various reasons, including backup. '''''See: [[Import-Export_library | Import & Export]]'''''

One of the most considered features of Kodi is the way media is displayed. Gone are the days when choosing a movie to watch or album to listen to involved scrolling through lines of text. Kodi uses [[Artwork]], and Extended Information to display your media. This information includes Actors, Directors, Plots, Taglines, Ratings, Run Times and more. All this data, known as metadata, is stored in the Kodi Library. The Library is a [http://www.sqlite.org/ SQLite database].

There are two primary methods to load metadata into your library:
#Use the online scraper
#Create a nfo file, from which Kodi is able to import the metadata

For information on how to use the online scraper within Kodi:<br />
:'''''See: [[Adding_music_to_the_library]]'''''
:'''''See: [[Adding_video_sources]]'''''
:'''''See: [[Set_content_and_scan]]'''''<br />

'''The remainder of this wiki topic will provide the required information to create and use nfo files.'''

= Types of nfo =
Kodi can use the nfo file in one of two ways depending on the contents of the nfo file. This page primarily deals with the Metadata nfo.

== Metadata nfo ==
This is the most common use of the nfo file. The Metadata nfo contains the metadata for the movie/tv show/album/artist within the file. Kodi will read this file and scrape its contents into the library.

== Parsing nfo ==
A Parsing nfo does not contain any metadata that Kodi can use to scrape into the library. Instead it contains the URL to the movie/tv show/album/artist that you want scraped.
As an example, searching for ''The Mummy'' on [[https://www.themoviedb.org/ |TMDB]] returns 65 titles. If you are attempting to add one of the more obscure versions to your library, chances are that Kodi will scrape the incorrect title, and trying to navigate to the 65th entry will be problematic. The parsing nfo offers an easy solution to this problem.
To create and use the parsing nfo, follow these steps:
#Locate the title at the appropriate scraper site
#Ensure you have named your files/folder the same as shown on the scraper site and in accordance with the [Naming_video_files | Kodi naming conventions]
#Open a text editor and copy the entire address from the address bar into the text editor. No surrounding tags are required. ''see example after step 5''
#Save the file in accordance with the naming convention in section 4 below. '''Ensure the extension is *.nfo and not *.nfo.txt or *.nfo.doc'''
#Run an Update Library. Kodi will parse the URL and locate the title and scrape the correct metadata.
https://www.themoviedb.org/movie/15849-the-mummy''


= Creating nfo =
The following are the three methods that may be used to create nfo files for Kodi. The simplest method is using a Media Manager.

== Media Managers ==
This is, by far, the simplest method for creating nfo files for your media. The Media Manager can create nfo files in one of three ways:
#Scraping- This is the same process as performed by the Kodi scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file, unlike Kodi that imports the metadata directly into the library database.
#Manual- The Media Manager offers a simple interface that allows you to manually type in the data. This method does not require you to have knowledge of XML tags
#Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then simply modify it.

Once the program has been setup and pointed at your media, very little input is required by the user. Select a movie, tv show, album or artist and select scrape. Depending upon your settings, the media manager will scrape the media and create the nfo which is placed in the correct location with the media file. It can also download all artwork for the media.
There are a few media managers available. The following managers can be found in the Kodi forum:
*[https://forum.kodi.tv/showthread.php?tid=259449 | Ember Media Managers]
*[https://forum.kodi.tv/showthread.php?tid=142723 | Tiny Media Manager aka TMM]
*[https://forum.kodi.tv/showthread.php?tid=129134 | Media Companion 3]
*[https://forum.kodi.tv/showthread.php?tid=136333 | MediaElch]

Further information, screenshots and guides are available at the websites of the Media Managers.

== Kodi Created nfo ==
This option requires that your library has already been scraped with metadata. Using the built in export function of Kodi, you can export the library metadata into individual nfo files correctly created and saved. This is useful if you have an existing library and would like to backup the library or to import the library into another Kodi installation.
:'''''See: [[Import-Export_library | Import & Export]]'''''

== Manual Creation ==
The more difficult of the three methods. It requires basic knowledge of XML Tags. They can be created using a simple text editor such as Notepad in Windows, or the equivelant in other operating systems. There are dedicated code editors that can also be used. They will not provide the required Kodi tags, but they will avoid glitches when saving the nfo file, which is commonly experienced with text editors.
Two common code editors that can be used:
*[https://notepad-plus-plus.org/ | Notepad++]
*[https://code.visualstudio.com/ | Visual Studio Code]

Requirements of the nfo file are as follows:
#Each Tag must have an opening tag and a closing tag. eg ''<title>my movie title</title>''. '''''<title>''''' = opening tag, '''''my movie title''''' = metadata, '''''</title>''''' = closing tag
#The file must be in Unicode Transformation Format-8 (UTF-8). The file must be saved in this format. The first line of the file must contain the following ''<?xml version="1.0" encoding="UTF-8" standalone="yes"?>''
#The second line may contain a note detailing the creation time and date. It may also include the name of the media manager, if one was used to create it. This is optional. ''''
#The next line sets the nfo category - <movie>, <tvshow>, <episodedetails>, <artist>, <album> or <musicvideo>
#Between the opening and closing category tags are the tags for the media metadata.
#Available tags are listed in Section 6

Once created, the file is saved with the nfo extension and placed in the folder as directed in Section 4.

See example nfo files in Section 6

= nfo Placement =
Correct placement of the nfo file is essential. Failing to save the file in the correct location, as detailed below, will force Kodi to scrape the information from online sources or, if you have ''Local Info Only'' set as your scraper, then no entry will be made into the library.

The order of importing metadata is as follows:
#nfo file. If no nfo file exists then
#online scraper sites

When Kodi locates the nfo file it will load the *.nfo file and attempt to either,
#If the nfo file contains XML data (tags), Kodi will import the meta-data directly into the library from the .nfo file or
#Will parse the nfo file for a direct URL to the scraper info page.

== Movies ==
Movies require one nfo file as follows:

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Movie *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |BluRay Structure:
| width=300px |index.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\BDMV\index.nfo
|- valign="top"
| width=200px |DVD Structure:
| width=300px |VIDEO_TS.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\VIDEO_TS.nfo
|- valign="top"
| width=200px |Single movie in directory:
| width=300px |<MovieFileName>.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\<MovieFileName>.nfo
|- valign="top"
| width=200px |All movies in single directory:
| width=300px |<MovieFileName>.nfo
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\<MovieFileName>.nfo
|}
</div>

== TV Shows ==
TV Shows require the following nfo files
#One nfo file for the TV Show. See the first table below
#One nfo file for '''each''' Episode. See the second table below
For one TV Show with 10 episodes, you will require 11 nfo files.

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your TV Show *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved TV Show as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |All formats
| width=300px |tvshow.nfo
| width=600px |f:\MyTVShows\iZombie\tvshow.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming & Saving conventions for your TV Episode *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Episodes as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |BluRay Structure:
| width=300px |index.nfo
| width=600px |f:\MyTVShows\iZombie\iZombie S01E01\BDMV\index.nfo
|- valign="top"
| width=200px |DVD Structure:
| width=300px |VIDEO_TS.nfo
| width=600px |f:\MyTVShows\iZombie\iZombie S01E01\VIDEO_TS\VIDEO_TS.nfo
|- valign="top"
| width=200px |Single Episode file in directory:
| width=300px |<EpisodeFileName>.nfo
| width=600px |f:\MyTVShows\iZombie\iZombie S01E01\<EpisodeFileName>.nfo
|- valign="top"
| width=200px |All episodes in TV Show directory:
| width=300px |<MovieFileName>.nfo
| width=600px |f:\MyTVShows\iZombie\<EpisodeFileName>.nfo
|}
</div>

== Music ==
Music will fetch additional album and album artist information from nfo files.

For additional '''album''' information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional '''album artist''' information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

{{note|There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly.
However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.NFO file, and give the artist some other artist's information, or fail to fine the artist.nfo you created}}

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Artist as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |artist.nfo
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
|}
</div>

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Album as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Artist\Album\Songs
| width=300px |album.nfo
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
|}
</div>

== Music Videos ==
Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.

<div style="{{linear-gradient|top|#a1f5e4, #f5f5a1}}">
'''''Naming & Saving conventions for your Music Videos *.nfo files:'''''
{|
|- valign="top"
| width=200px |'''''Saved Music Videos as'''''
| width=300px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |All formats
| width=300px |<MusicVideoFileName>.nfo
| width=600px |f:\MyMusicVideos\<MusicVideoFileName>.nfo
|}
</div>

= Scraping nfo files =
There is no special procedure to scrape nfo files. Performing the usual Library Update will scrape the nfo files into the library. Be aware that nfo files are not easily interchangeable between Movies, TV Shows, Artists and Albums. Although they all share common tags, each also has its own specific tags that won't be recognised in other parts of the library.

'''After the NFO files are scanned into the library, the NFO file is no longer used and only serves as a backup. If you make changes to the NFO file you will need to '''[[refresh]]''' that library entry for the changes to be loaded into Kodi.'''

Kodi also contains a Local-NFO-only mode for when you add videos to the library, but this mode is only required if you want to prevent online-lookups for videos that lack NFO files. See '''[[Set content and scan#Local NFO only options]]''' for more information on this Local-NFO-only mode.

= Sample nfo Files =
Provided below are sample nfo files to assist with the manual creation process

== Movie nfo ==
Sample Movie nfo file

{{collapse top| Movie nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<movie>
<title>Ghost in the Shell</title>
<originaltitle>Ghost in the Shell</originaltitle>
<sorttitle></sorttitle>
<rating>5.9</rating>
<year>2017</year>
<top250></top250>
<votes>1936</votes>
<outline>In the near future, Major is the first of her kind: a human saved from a terrible crash, then cyber-enhanced to be a perfect soldier devoted to stopping the world's most dangerous criminals.</outline>
<plot>In the near future, Major is the first of her kind: a human saved from a terrible crash, then cyber-enhanced to be a perfect soldier devoted to stopping the world's most dangerous criminals.</plot>
<tagline>There's nothing sadder than a puppet without a ghost.</tagline>
<runtime>107</runtime>
<thumb>https://assets.fanart.tv/fanart/movies/315837/movieposter/ghost-in-the-shell-5951b7c0843b0.jpg</thumb>
<fanart>http://image.tmdb.org/t/p/original/dXJh6bXF3WI1gpNuM3tNbnIiW2z.jpg</fanart>
<mpaa>AU:M</mpaa>
<certification>AU:M</certification>
<id>tt1219827</id>
<ids>
<entry>
<key>tmdb</key>
<value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">315837</value>
</entry>
<entry>
<key>imdb</key>
<value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">tt1219827</value>
</entry>
</ids>
<tmdbId>315837</tmdbId>
<country>Australia, New Zealand, United States, United Kingdom, India, China, Canada, Japan, Hong Kong</country>
<premiered>2017-03-29</premiered>
<fileinfo>
<streamdetails>
<video>
<codec>h264</codec>
<aspect>1.78</aspect>
<width>1920</width>
<height>1080</height>
<durationinseconds>6417</durationinseconds>
</video>
<audio>
<codec>TrueHD AC3</codec>
<language>eng</language>
<channels>8</channels>
</audio>
<subtitle>
<language>eng</language>
</subtitle>
<subtitle>
<language>eng</language>
</subtitle>
</streamdetails>
</fileinfo>
<watched>false</watched>
<playcount>0</playcount>
<genre>Action</genre>
<genre>Crime</genre>
<genre>Drama</genre>
<genre>Mystery</genre>
<genre>Science Fiction</genre>
<genre>Thriller</genre>
<studio>Paramount Pictures</studio>
<studio>DreamWorks SKG</studio>
<studio>Shanghai Film Group</studio>
<studio>Reliance Entertainment</studio>
<studio>Arad Productions</studio>
<studio>Grosvenor Park Productions</studio>
<studio>Steven Paul Production</studio>
<studio>Huahua Media</studio>
<studio>Seaside Entertainment</studio>
<studio>Amblin Partners</studio>
<studio>Weying Galaxy Entertainment</studio>
<credits>Ehren Kruger</credits>
<credits>Jamie Moss</credits>
<credits>Masamune Shirow</credits>
<credits>William Wheeler</credits>
<director>Rupert Sanders</director>
<tag>BluRay</tag>
<actor>
<name>Scarlett Johansson</name>
<role>Major Motoko Kusanagi</role>
<thumb>http://image.tmdb.org/t/p/w185/8EueDe6rPF0jQU4LSpsH2Rmrqac.jpg</thumb>
</actor>
<actor>
<name>Pilou Asb├ªk</name>
<role>Batou</role>
<thumb>http://image.tmdb.org/t/p/w185/wcQRF5ZOBY8NX7xrjXE2pOBmwyZ.jpg</thumb>
</actor>
<actor>
<name>Takeshi Kitano</name>
<role>Daisuke Aramaki</role>
<thumb>http://image.tmdb.org/t/p/w185/xkXZ7HC8uyhu5MtNnbdP8mhdiFN.jpg</thumb>
</actor>
<actor>
<name>Juliette Binoche</name>
<role>Dr. Ou├⌐let</role>
<thumb>http://image.tmdb.org/t/p/w185/rkW6eE75Tt1i3J1s2fsIDZBW0kd.jpg</thumb>
</actor>
<actor>
<name>Michael Pitt</name>
<role>Hideo Kuze</role>
<thumb>http://image.tmdb.org/t/p/w185/fWR4Z1xk1ZMUMMnMeRADVh1s3DW.jpg</thumb>
</actor>
<actor>
<name>Chin Han</name>
<role>Togusa</role>
<thumb>http://image.tmdb.org/t/p/w185/xvMCVDvrQ2WlAB2LmkG6HAzlYag.jpg</thumb>
</actor>
<actor>
<name>Lasarus Ratuere</name>
<role>Ishikawa</role>
<thumb>http://image.tmdb.org/t/p/w185/tATw6bSySFmqunfBXmyy0ppbsXi.jpg</thumb>
</actor>
<actor>
<name>Yutaka Izumihara</name>
<role>Saito</role>
<thumb>http://image.tmdb.org/t/p/w185/rGPYp0jWNplBEv1vWDbmpysaGte.jpg</thumb>
</actor>
<actor>
<name>Tawanda Manyimo</name>
<role>Borma</role>
<thumb>http://image.tmdb.org/t/p/w185/vUpTeHW9Yokx2R2sipMZdiTfiIk.jpg</thumb>
</actor>
<actor>
<name>Rila Fukushima</name>
<role>Red Robed Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/AsxUTMScQetJ1Iommki98w3rHPH.jpg</thumb>
</actor>
<actor>
<name>Michael Wincott</name>
<role>Dr. Osmund</role>
<thumb>http://image.tmdb.org/t/p/w185/pvKUzexxZT4sRTT1BczzrwX8ghz.jpg</thumb>
</actor>
<actor>
<name>Anamaria Marinca</name>
<role>Dr. Dahlin</role>
<thumb>http://image.tmdb.org/t/p/w185/ajLN2RMuYHgTEFAzs8x8vZH0Rlu.jpg</thumb>
</actor>
<actor>
<name>Daniel Henshall</name>
<role>Skinny Man</role>
<thumb>http://image.tmdb.org/t/p/w185/4LYeThK5O9EUy1OllvdsD5bTRbb.jpg</thumb>
</actor>
<actor>
<name>Kaori Momoi</name>
<role>Hairi</role>
<thumb>http://image.tmdb.org/t/p/w185/aHPQaKWk1foxvieDZubUJE8olaO.jpg</thumb>
</actor>
<actor>
<name>Peter Ferdinando</name>
<role>Cutter</role>
<thumb>http://image.tmdb.org/t/p/w185/eSxMkW04VuOkQqxG2HIPw0FMJKe.jpg</thumb>
</actor>
<actor>
<name>Christopher Obi</name>
<role>Ambassador Kiyoshi</role>
<thumb>http://image.tmdb.org/t/p/w185/9mkVa3qKba8S7UcyzUYZPkeRG37.jpg</thumb>
</actor>
<actor>
<name>Danusia Samal</name>
<role>Ladriya</role>
<thumb>http://image.tmdb.org/t/p/w185/8FqUG5hRe9MskGzXzx8ktS7b20y.jpg</thumb>
</actor>
<actor>
<name>Mana Hira Davis</name>
<role>Bearded Man</role>
<thumb>http://image.tmdb.org/t/p/w185/fBDzK8Vd7XBx97nsH9sXXGf4nMD.jpg</thumb>
</actor>
<actor>
<name>Adwoa Aboah</name>
<role>Lia</role>
<thumb>http://image.tmdb.org/t/p/w185/jD8FV3TcLNJe64udKygGLnHkP6K.jpg</thumb>
</actor>
<actor>
<name>Kai Fung Rieck</name>
<role>Diamond Face</role>
<thumb>http://image.tmdb.org/t/p/w185/mqS7nagL7Dp1QK1152eyfT1RjOI.jpg</thumb>
</actor>
<actor>
<name>Andrew Stehlin</name>
<role>No Pupils</role>
<thumb>http://image.tmdb.org/t/p/w185/kcDr96zRyuM3IiR5RWPV14D5dMK.jpg</thumb>
</actor>
<actor>
<name>Matthias Luafutu</name>
<role>Thick Built Yakuza</role>
<thumb>http://image.tmdb.org/t/p/w185/65KBlRWu561lTVPHlhgHskprLOh.jpg</thumb>
</actor>
<actor>
<name>John Luafutu</name>
<role>Barkeep</role>
<thumb>http://image.tmdb.org/t/p/w185/ryhkaAVyAxAfCUj6P12EkYO8Rk4.jpg</thumb>
</actor>
<actor>
<name>Kaori Yamamoto</name>
<role>Motoko</role>
<thumb>http://image.tmdb.org/t/p/w185/iJFsfqfmUy14kU2VNrxE3JGVBAY.jpg</thumb>
</actor>
<actor>
<name>Pete Teo</name>
<role>Tony</role>
<thumb>http://image.tmdb.org/t/p/w185/7bJutZz5qd2rYBHHC2gyMQWNQbu.jpg</thumb>
</actor>
<actor>
<name>Tanya Drewery</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/7Q4eMvFKcmYSUfLSlNMHtlSkoKh.jpg</thumb>
</actor>
<actor>
<name>Jacqueline Lee Geurts</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/9YcJF1avZliG3Mu01mUQxuiUuu4.jpg</thumb>
</actor>
<actor>
<name>Hannah Tasker-Poland</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/fpXCLG1HbNlPl6nEDnqQTvohMEm.jpg</thumb>
</actor>
<actor>
<name>Emma Coppersmith</name>
<role>Geisha</role>
<thumb>http://image.tmdb.org/t/p/w185/aAHgg8eO7kaHw0Mmn1jatBxmRYv.jpg</thumb>
</actor>
<actor>
<name>Shinji Ikefuji</name>
<role>Kinsana</role>
<thumb>http://image.tmdb.org/t/p/w185/6m1scLGa91uDDYBftdEcEOuXrAm.jpg</thumb>
</actor>
<actor>
<name>Xavier Horan</name>
<role>Section Six Soldier</role>
<thumb>http://image.tmdb.org/t/p/w185/yNdHNB90SXulSRLqbYeZ5JXppqO.jpg</thumb>
</actor>
<actor>
<name>Allan Henry</name>
<role>Section Six Soldier</role>
<thumb>http://image.tmdb.org/t/p/w185/ma3ZFzGiF4ANlEym3ACFOG0n7qV.jpg</thumb>
</actor>
<actor>
<name>Joseph Naufahu</name>
<role>Police Commander Johns</role>
<thumb>http://image.tmdb.org/t/p/w185/9N4UmM1runLmdhzIhZ5Xfk4Qo21.jpg</thumb>
</actor>
<actor>
<name>Makoto Murata</name>
<role>Yakuza Gunman</role>
<thumb>http://image.tmdb.org/t/p/w185/f32b7dh8dg5s5LWXyiSYZacDQAG.jpg</thumb>
</actor>
<producer>
<name>Avi Arad</name>
<role>Producer</role>
<thumb>http://image.tmdb.org/t/p/w185/kIG4HF5LSywU0ZdDheDaEsxxohu.jpg</thumb>
</producer>
<producer>
<name>Leslee Feldman</name>
<role>Casting</role>
</producer>
<producer>
<name>Mitsuhisa Ishikawa</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Steven Paul</name>
<role>Producer</role>
</producer>
<producer>
<name>Jeffrey Silver</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Lucy Bevan</name>
<role>Casting</role>
</producer>
<producer>
<name>Mark Sourian</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Michael Costigan</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Mark Sussman</name>
<role>ADR Voice Casting</role>
</producer>
<producer>
<name>Ari Arad</name>
<role>Producer</role>
</producer>
<producer>
<name>Miranda Rivers</name>
<role>Casting</role>
</producer>
<producer>
<name>Maguy R. Cohen</name>
<role>Producer</role>
</producer>
<producer>
<name>Patty Majorczak-Connolly</name>
<role>ADR Voice Casting</role>
</producer>
<producer>
<name>C├⌐cile Bouquet</name>
<role>Researcher</role>
</producer>
<producer>
<name>Tetsuya Fujimura</name>
<role>Executive Producer</role>
</producer>
<producer>
<name>Nanw Rowlands</name>
<role>Casting Associate</role>
</producer>
<languages>Japanese, English</languages>
</movie>

{{collapse bottom}}

== TV Show nfo ==
Sample TV Show nfo

{{collapse top| TV Show nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<tvshow>
<title>iZombie</title>
<sorttitle></sorttitle>
<year>2015</year>
<rating>8.3</rating>
<votes>66</votes>
<plot>When over-achieving medical resident Liv Moore attends a party that turns into a zombie feeding frenzy, she ends up joining the ranks of the living dead.</plot>
<mpaa>E</mpaa>
<episodeguide>
<url cache="281470.xml">http://www.thetvdb.com/api/1D62F2F90030C444/series/281470/all/en.xml</url>
</episodeguide>
<id>281470</id>
<imdbid>tt3501584</imdbid>
<genre>Action</genre>
<genre>Comedy</genre>
<genre>Crime</genre>
<genre>Drama</genre>
<genre>Horror</genre>
<premiered>2015-03-17</premiered>
<status>Continuing</status>
<studio>The CW</studio>
<actor>
<name>Rose McIver</name>
<role>Olivia "Liv" Moore</role>
<thumb>http://thetvdb.com/banners/actors/346010.jpg</thumb>
</actor>
<actor>
<name>Rahul Kohli</name>
<role>Dr. Ravi Chakrabarti</role>
<thumb>http://thetvdb.com/banners/actors/346008.jpg</thumb>
</actor>
<actor>
<name>Robert Buckley</name>
<role>Major Lilywhite</role>
<thumb>http://thetvdb.com/banners/actors/329726.jpg</thumb>
</actor>
<actor>
<name>Aly Michalka</name>
<role>Peyton Charles</role>
<thumb>http://thetvdb.com/banners/actors/437907.jpg</thumb>
</actor>
<actor>
<name>Malcolm Goodwin</name>
<role>Clive Babineaux</role>
<thumb>http://thetvdb.com/banners/actors/346009.jpg</thumb>
</actor>
<actor>
<name>David Anders</name>
<role>Blaine</role>
<thumb>http://thetvdb.com/banners/actors/329728.jpg</thumb>
</actor>
<actor>
<name>Tongayi Chirisa</name>
<role>Justin Bell</role>
<thumb>http://thetvdb.com/banners/actors/437906.jpg</thumb>
</actor>
<actor>
<name>Andrea Savage</name>
<role>Vivian Stoll</role>
<thumb>http://thetvdb.com/banners/actors/437905.jpg</thumb>
</actor>
<actor>
<name>Jason Dohring</name>
<role>Chase Graves</role>
<thumb>http://thetvdb.com/banners/actors/437903.jpg</thumb>
</actor>
<actor>
<name>Nick Purcha</name>
<role>Evan Moore</role>
<thumb>http://thetvdb.com/banners/actors/436318.jpg</thumb>
</actor>
<actor>
<name>Leanne Lapp</name>
<role>Rita/Gilda</role>
<thumb>http://thetvdb.com/banners/actors/436317.jpg</thumb>
</actor>
<actor>
<name>Greg Finley</name>
<role>Drake Holloway</role>
<thumb>http://thetvdb.com/banners/actors/436315.jpg</thumb>
</actor>
<actor>
<name>Jessica Harmon</name>
<role>Dale Bozzio</role>
<thumb>http://thetvdb.com/banners/actors/436314.jpg</thumb>
</actor>
<actor>
<name>Bryce Hodgson</name>
<role>Don Everhart</role>
<thumb>http://thetvdb.com/banners/actors/430151.jpg</thumb>
</actor>
<actor>
<name>Bradley James</name>
<role>Lowell Tracey</role>
<thumb>http://thetvdb.com/banners/actors/417361.jpg</thumb>
</actor>
</tvshow>
{{collapse bottom}}

== TV Show Episode nfo ==
Sample TV Episode nfo

{{collapse top| TV Episode nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails>
<title>The Bone Orchard</title>
<showtitle>American Gods</showtitle>
<ratings>
<rating name="default" max="10" default="true">
<value>7.400000</value>
<votes>14</votes>
</rating>
</ratings>
<userrating>0</userrating>
<top250>0</top250>
<season>1</season>
<episode>1</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>When Shadow Moon is released from prison early after the death of his wife, he meets Mr. Wednesday and is recruited as his bodyguard. Shadow discovers that this may be more than he bargained for.</plot>
<tagline></tagline>
<runtime>62</runtime>
<mpaa>E</mpaa>
<playcount>1</playcount>
<lastplayed>2017-07-26</lastplayed>
<id>5088686</id>
<uniqueid type="unknown" default="true">5088686</uniqueid>
<genre>Action</genre>
<genre>Adventure</genre>
<genre>Fantasy</genre>
<genre>Mystery</genre>
<credits>Bryan Fuller</credits>
<credits>Michael Green</credits>
<director>David Slade</director>
<premiered>2017-04-30</premiered>
<year>2017</year>
<status></status>
<code></code>
<aired>2017-04-30</aired>
<studio>Starz!</studio>
<trailer></trailer>
<fileinfo>
<streamdetails>
<video>
<codec>h264</codec>
<aspect>1.777778</aspect>
<width>1920</width>
<height>1080</height>
<durationinseconds>3763</durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec>dtshd_ma</codec>
<language>eng</language>
<channels>6</channels>
</audio>
<subtitle>
<language>eng</language>
</subtitle>
</streamdetails>
</fileinfo>
<actor>
<name>Ian McShane</name>
<role>Wednesday</role>
<order>0</order>
<thumb>http://thetvdb.com/banners/actors/418593.jpg</thumb>
</actor>
<actor>
<name>Ricky Whittle</name>
<role>Shadow Moon</role>
<order>1</order>
<thumb>http://thetvdb.com/banners/actors/418586.jpg</thumb>
</actor>
<actor>
<name>Emily Browning</name>
<role>Laura Moon</role>
<order>2</order>
<thumb>http://thetvdb.com/banners/actors/418119.jpg</thumb>
</actor>
<actor>
<name>Pablo Schreiber</name>
<role>Mad Sweeney</role>
<order>3</order>
<thumb>http://thetvdb.com/banners/actors/418590.jpg</thumb>
</actor>
<actor>
<name>Yetide Badaki</name>
<role>Bilquis</role>
<order>4</order>
<thumb>http://thetvdb.com/banners/actors/418588.jpg</thumb>
</actor>
<actor>
<name>Bruce Langley</name>
<role>Technical Boy</role>
<order>5</order>
<thumb>http://thetvdb.com/banners/actors/418587.jpg</thumb>
</actor>
<actor>
<name>Orlando Jones</name>
<role>Nancy</role>
<order>6</order>
<thumb>http://thetvdb.com/banners/actors/418591.jpg</thumb>
</actor>
<actor>
<name>Chris Obi</name>
<role>Jacquel</role>
<order>7</order>
<thumb>http://thetvdb.com/banners/actors/429117.jpg</thumb>
</actor>
<actor>
<name>Demore Barnes</name>
<role>Ibis</role>
<order>8</order>
<thumb>http://thetvdb.com/banners/actors/429116.jpg</thumb>
</actor>
<actor>
<name>Omid Abtahi</name>
<role>Salim</role>
<order>9</order>
<thumb>http://thetvdb.com/banners/actors/428857.jpg</thumb>
</actor>
<actor>
<name>Cloris Leachman</name>
<role>Zorya Vechernyaya</role>
<order>10</order>
<thumb>http://thetvdb.com/banners/actors/421778.jpg</thumb>
</actor>
<actor>
<name>Gillian Anderson</name>
<role>Media</role>
<order>11</order>
<thumb>http://thetvdb.com/banners/actors/421117.jpg</thumb>
</actor>
<actor>
<name>Crispin Glover</name>
<role>World</role>
<order>12</order>
<thumb>http://thetvdb.com/banners/actors/418592.jpg</thumb>
</actor>
<actor>
<name>Peter Stormare</name>
<role>Czernobog</role>
<order>13</order>
<thumb>http://thetvdb.com/banners/actors/418589.jpg</thumb>
</actor>
<actor>
<name>Kristin Chenoweth</name>
<role>Easter</role>
<order>14</order>
<thumb>http://thetvdb.com/banners/actors/418124.jpg</thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2017-07-19 17:50:00</dateadded>
</episodedetails>
{{collapse bottom}}

== Music Artist nfo ==
Sample Music Artist nfo

{{collapse top| Music Artist nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Fleetwood Mac</name>
<musicBrainzArtistID>bd13909f-1c29-4c27-a874-d4aaf27c5b1a</musicBrainzArtistID>
<genre>Rock</genre>
<style>Rock/Pop</style>
<mood>Relaxed</mood>
<yearsactive>1960s - 2010s</yearsactive>
<born></born>
<formed>London, England (1967)</formed>
<biography>Fleetwood Mac are a British-American rock band formed in 1967 in London. The only original member present in the band is its eponymous drummer, Mick Fleetwood.</biography>
<died></died>
<disbanded></disbanded>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-56146ecf89860.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-53a0df3715867.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-53a0df3715867.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistthumb/fleetwood-mac-4fd37e9a22e1f.jpg</thumb>
<thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/svtsux1447415485.jpg</thumb>
<path>E:\Music- Test\Fleetwood Mac\</path>
<fanart>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a08371db4e2.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a08371db4e2.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a083a3607ed.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-54a083a3607ed.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-4e7ec8bebeba1.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-51c68f91253a9.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-51c68f91253a9.jpg</thumb>
<thumb preview="http://assets.fanart.tv/preview/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-518f8f0a5a483.jpg">http://assets.fanart.tv/fanart/music/bd13909f-1c29-4c27-a874-d4aaf27c5b1a/artistbackground/fleetwood-mac-518f8f0a5a483.jpg</thumb>
</fanart>
<album>
<title>Future Games</title>
<year>1971</year>
</album>
<album>
<title>Live in London 1968</title>
<year>1989</year>
</album>
<album>
<title>Bare Trees</title>
<year>1972</year>
</album>
<album>
<title>Tusk</title>
<year>1979</year>
</album>
<album>
<title>In Concert 1982</title>
<year>2010</year>
</album>
<album>
<title>Rumours</title>
<year>1977</year>
</album>
<album>
<title>Say You Will</title>
<year>2003</year>
</album>
<album>
<title>Kiln House</title>
<year>1970</year>
</album>
<album>
<title>Tango in the Night</title>
<year>1987</year>
</album>
<album>
<title>Fleetwood Mac</title>
<year>1975</year>
</album>
<album>
<title>Penguin</title>
<year>1973</year>
</album>
<album>
<title>Mirage</title>
<year>1982</year>
</album>
<album>
<title>Mystery to Me</title>
<year>1973</year>
</album>
<album>
<title>Peter GreenΓÇÖs Fleetwood Mac</title>
<year>1968</year>
</album>
</artist>
{{collapse bottom}}

== Music Album nfo ==
Sample Music Album nfo

{{collapse top| Music Album nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>The Annie Lennox Collection</title>
<musicBrainzAlbumID>957cda28-5e1e-4507-9de7-1d5049415cea</musicBrainzAlbumID>
<artistdesc>Annie Lennox</artistdesc>
<genre>Pop</genre>
<style>TalbumFstrstyles</style>
<mood>TalbumFstrmoods</mood>
<theme>TalbumFstrthemes</theme>
<compilation>false</compilation>
<review>TalbumFstrReview</review>
<type>album/compilation</type>
<releasedate></releasedate>
<label>RCA/19 Recordings</label>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/the-annie-lennox-collection-50b9f63c63338.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/the-annie-lennox-collection-50b9f63c63338.jpg</thumb>
<path>E:\Music Test Test\Annie Lennox\The Annie Lennox Collection\</path>
<rating max="10">0.000000</rating>
<userrating max="10">5</userrating>
<votes>1500</votes>
<year>2003</year>
<albumArtistCredits>
<artist>Annie Lennox</artist>
<musicBrainzArtistID>3e30aebd-0557-4cfd-8fb9-3945afa5d72b</musicBrainzArtistID>
</albumArtistCredits>
<releasetype>album</releasetype>
</album>
{{collapse bottom}}

== Music Video nfo ==
Sample Music Video nfo

{{collapse top| Music Video nfo file (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<musicvideo>
<title>Dancing Queen</title>
<userrating>0</userrating>
<top250>0</top250>
<track>-1</track>
<album>Arrival</album>
<outline></outline>
<plot>"Dancing Queen" is a Europop song by the Swedish group ABBA, and the lead single from their fourth studio album, Arrival.</plot>
<tagline></tagline>
<runtime>0</runtime>
<thumb preview="http://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg</thumb>
<mpaa></mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<id></id>
<genre>Pop</genre>
<year>1976</year>
<status></status>
<code></code>
<aired></aired>
<trailer></trailer>
<artist>ABBA</artist>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2017-06-15 14:18:10</dateadded>
</musicvideo>
{{collapse bottom}}

= nfo Tags =
A list of all available tags that Kodi recognises follows in this section. As mentioned previously, there are many common tags, but there are also specific tags for each part of the library. Ensure you use the correct tags.

== Movie Tags ==

== TV Show Tags ==

== TV Show Episode Tags ==

== Music Tags ==

== Music Video Tags ==

{{top}}

Databases

2017-08-07T08:50:02Z

DaveBlake: Music database: improve some of the table and field descritions

{{mininav| [[Development]] {{l2| [[userdata folder]] }} }}
{{see also|Databases/Versions}}

<section begin="intro" />Kodi uses [http://www.sqlite.org/ SQLite], an open source light-weight SQL database-engine, to store all its library related data ([[Music Library|Music]], [[Video Library|Video]], and Program databases). By default, the database files (*.db) are stored in [[The UserData Folder]], specifically in userdata/Database.

In addition to indexing media files when activated by user-selected Content settings, Kodi also puts a video in its database if you change any OSD setting while watching it. Resume points are stored in this database as well. These entries are added to the database whether the affected video is part of the Video Library or not.<section end="intro" />

== Using the Databases ==
Databasess are automatically maintained whenever you use Kodi. You can activate the most powerful database functionality by setting the Content property on all of your media sources, and using Kodi Library Mode. This view mode allows you to browse your media based on the details available in the databases, rather than using simple folder and filenames for details. You can read more about Library Mode for [[Music Library|Music]] and [[Video Library|Video]] files on their respective pages.

Since Kodi maintains the databases on its own, the only time a developer really needs to access the databases is for display information. The following sections discuss how you can access the information contained in Kodi's databases, and give some brief examples of how to use it.

=== Building SQL Queries ===
SQLite queries can be incredibly powerful (and extraordinarily complicated). If you are not already familiar with SQL syntax, it would probably be a good idea to check out a general tutorial, such as [http://www.1keydata.com/sql/sql.html this one].

For most Kodi development projects, you're going to be doing select statements. "Select" is a SQL command used to gather data (in the form of "rows") out of a SQL database. Your select statement will include:

* A list of all the data fields (columns in the database table) you want for each row.
* A list of all the tables you need to get information from
* A list of comparisons used to narrow down your results. This last component is optional, but it makes sure your results are relevant and is often used to link database entries across multiple tables.

Below are a few sample select statements, so you can see how it works.

This query grabs all of the information for every movie in the Video Library.
<pre><nowiki>select * from movie</nowiki></pre>
Note that "*" is used to indicate all fields. Also,there is no "where" clause in this statement, so it returns every row in the table.

This query narrows down the results to just those movies released in 2007.
<pre><nowiki>select * from movie where c07 = 2007</nowiki></pre>
Note that the column containing the movie's release year is labelled simply "c07." The tables further down this page help you find out which columns contain the information you're looking for.

This query example is more semantic. Lists your movies including, in this order, internal ID, internal file ID, rating, movie year, IMDB ID, movie name and movie plot.
<pre><nowiki>select idMovie,idFile,c05,c07,c09,c00,c03,c02 from movie;</nowiki></pre>

Now the following query is a bit more complex because it joins 3 movie-related tables (movie, files and path) to list a single useful view of your movies. In human language it lists movie ID, movie year, IMDB rating, IMDB ID, movie name and full path of the movie file, ordered by IMDB rating with highest rating appearing first:
<pre><nowiki> select idMovie,c07,c05,c09,c00,path.strPath||files.strFilename from movie, files,path where movie.idFile=files.idFile and files.idPath=path.idPath order by c05 desc;</nowiki></pre>

You could also use less than or greater than symbols to get newer or older movies.

This query gets just the path and filename of all of the video files from season two of Chuck.
<pre><nowiki></nowiki></pre>
If you're not familiar with SQL queries, this query probably looks pretty complicated. It serves as a good demonstration of why there are so many tables in the list below, and how to use them. Many of the elements of a TV show's path and filename and used repeatedly, so SQL allows us to save space and speed up our searches by storing each of those elements just once, in one place, and referencing them repeatedly by the same ID.

In this case, the root path that contains your video files is a long string that repeats at the beginning of many files. The name of a TV series, too, is repeated in every single episode of that series, so it makes the most sense to save the series name once (along with all information relevant to the series). We do that in the table tvshow, and every episode of the TV show can access all of that information using just the TV show's ID.

=== Accessing the Databases with Kodi Python ===
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using [[JSON RPC]]

== The Music Library ==
This database contains all information concerning music files that you've added to the Music Library. It is used in the Music portion of Kodi. The following information is for version 32.

The music database is stored in userdata/Database/MyMusicXX.db, where XX is the version number.

{{red|The current v17 database is MyMusic60.db}}

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about songs and albums in the Music Library, across all the linking tables.

==== albumartistview ====
This table combines album with each album artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from album table
|-
|idArtist || integer || ID from artist table
|-
|idrole || integer || = 0 (fake role ID field)
|-
|strRole || text || = "AlbumArtist" (fake role desc field)
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|iOrder || integer || Order artist appears in credits
|}

==== albumview ====
A view of the album table with some additional fields aggregated from the songs of that album.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from Album Table
|-
|strAlbum || varchar(256) || Album Name
|-
|strMusicBrainzAlbumID || text || MusicBrainz album ID
|-
|strArtists || text || Album artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table)
|-
|iYear || integer || Album release year
|-
|strMoods || text || Album moods
|-
|strStyles || text || Album styles
|-
|strThemes || text || Album themes
|-
|strReview || text || Album review
|-
|strLabel || text || Album recording label
|-
|strType || text || Album Type e.g. "Soundtrack / Live"
|-
|strImage || text || URLs for available remote album images
|-
|fRating || float || Album rating
|-
|iUserrating || integer || Album user rating (out of 10)
|-
|iVotes || integer || Votes (for album rating)
|-
|bCompilation || integer || Compilation flag
|-
|iTimesPlayed || integer ||Average of number of times songs on album are played
|-
|strReleaseType || text || Internal type - "album" or "single"
|-
|dateAdded || text || Music file timestamp of newest song on album
|-
|lastPlayed || text || Last date any song on album was played
|}

==== artistview ====
A view of the artist table with an additional field aggregated from the songs by that artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || ID from artist table
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|strBorn || text || Artist birthday (and place)
|-
|strFormed || text || Band formation information
|-
|strGenres || text || Artist genres (just text, no link to genre table)
|-
|strMoods || text || Artist moods
|-
|strStyles || text || Artist styles
|-
|strInstruments || text || Artist instruments
|-
|strBiography || text || Artist biography
|-
|strDied || text || Date artist died (and place)
|-
|strDisbanded || text || Band disbanded information
|-
|strYearsActive || text || Years artist is active
|-
|strImage || text || URLs of available artist images
|-
|strFanart || text || URLs of available artist fanart
|-
|dateAdded || text || Music file timestamp of newest song by artist
|}

==== songartistview ====
A view that joins song to artist and artist role.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from song table
|-
|idArtist || integer || ID from artist table
|-
|idrole || integer || ID from role table
|-
|strRole || text || Description of role
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID Hash
|-
|iOrder || integer || Order artist appears in song credits
|}

==== songview ====
A view that joins song to album and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from song table
|-
|strArtists || text || Song artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Song Genres (denormalised concatenation of values in genre table)
|-
|strTitle || varchar(512) || Song title
|-
|iTrack || integer || Song track number
|-
|iDuration || integer || Song duration in seconds
|-
|iYear || integer || Songs release year
|-
|strFileName || text || Name of music file
|-
|strMusicBrainzTrackID || text || Musicbrainz track ID
|-
|iTimesPlayed || integer || Play count
|-
|iStartOffset || integer || Start position (in seconds) when song from cuesheet
|-
|iEndOffset || integer || End position (in seconds) when song from cuesheet
|-
|lastplayed || varchar(20) || Date & time last played
|-
|rating || char || Song rating
|-
|userrating || integer || Song rated by user (out of 10)
|-
|votes || integer || Votes for song rating
|-
|comment || text || Song description or comment
|-
|idAlbum || integer || ID from album table
|-
|strAlbum || varchar(256) || Album title
|-
|strPath || varchar(512) || Full path for music file
|-
|bCompilation || integer || Compilation flag (song is on a compilation album)
|-
|strAlbumArtists || text || Album artist(s) description (not always a concatenation of names)
|-
|strAlbumReleaseType || text || Internal type - "album" or "single"
|-
|mood || text || Song mood
|-
|dateAdded || text || Music file timestamp
|}

=== Tables ===

==== album ====
An album. This equates to what Musicbrainz call a "release" and represents the unique release (i.e. issuing) of an item on a specific date with specific release information such as the country, label, etc. Hence album title and artist do not have to be unique as long as we have the release ID (Musicbrainz album ID), Kodi can handle different versions of the same album e.g. original release and then a later remaster (both same title and artist).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || Primary Key
|-
|strAlbum || varchar(256) || Album title
|-
|strMusicBrainzAlbumID || text || MusicBrainz Album ID (release ID)
|-
|strArtists || text || album artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Album genres (denormalised concatenation of values in genre table)
|-
|iYear || integer || Album release year
|-
|idThumb || integer || [Unused]
|-
|bCompilation || integer || Compilation flag
|-
|strMoods || text || Album moods
|-
|strStyles || text || Album styles
|-
|strThemes || text || Album themes
|-
|strReview || text || Album review
|-
|strImage || text || URLs for available remote album images
|-
|strLabel || text || Album recording label
|-
|strType || text || Album Type e.g. "Soundtrack / Live"
|-
|fRating || float || Album rating
|-
|iUserrating || integer || Album user rating (out of 10)
|-
|lastScraped || text || Date/time data scraped from online sources or NFO files
|-
|strReleaseType || text || Internal type - "album" or "single"
|-
|iVotes || integer || Album votes (for rating)
|}

==== album_artist ====
This table links artists and albums
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || Order of artist names for credits
|-
|strArtist || text || Artist name (denormalised)
|}

==== album_genre ====
This links albums with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || Order of genre for concatentation
|}

==== albuminfosong ====
Track listing information for the tracks on an album. This is returned when additional information for an album is scraped from online sources or NFO files. It has no relationship with the songs actually in the user's music collection, it is just details about the album.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbumInfoSong || integer || Primary Key
|-
|idAlbumInfo || integer || Foreign key to [[Databases#album|album table]]
|-
|iTrack || integer || Track number
|-
|strTitle || text || Track title
|-
|iDuration || integer || Track duration in seconds
|}

==== art ====
The current artwork for artists and albums
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || Foreign key to [[Databases#album|album]]or [[Databases#artist|artist table]]
|-
|media_type || text || "album" or "artist"
|-
|type || text || art type e.g. "thumb", "fanart" etc.
|-
|url || text || URL of image (can be remote, local or music file with art embedded)
|}

==== artist ====
An artist is generally a musician, group of musicians, or other music professional (like a producer or engineer). E.g. Bob Dylan, Pink Floyd, London Symphony Orchestra, Andrew Collins (producer).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Primary Key
|-
|strArtist || varchar(256) || Artist name
|-
|strMusicBrainzArtistID || text || Musicbrainz artist ID
|-
|-|strBorn || text || Artist birthday (and place)
|-
|strFormed || text || Band formation information
|-
|strGenres || text || Artist genres (just text, no link to genre table)
|-
|strMoods || text || Artist moods
|-
|strStyles || text || Artist styles
|-
|strInstruments || text || Artist instruments
|-
|strBiography || text || Artist biography
|-
|strDied || text || Date artist died (and place)
|-
|strDisbanded || text || Band disbanded information
|-
|strYearsActive || text || Years artist is active
|-
|strImage || text || URLs of available artist images
|-
|strFanart || text || URLs of available artist fanart
|-
|lastScraped || varchar(20) || Date last scraped metadata
|}

==== content ====
The scraper addon and settings used for scraping additional information for specific albums or artists.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|strPath || text || Virtual path encoding what album or artist e.g. "musicdb://artists/235"
|-
|strScraperPath || text || Scraper name e.g. "metadata.artists.universal"
|-
|strContent || text || "artists" or "albums"
|-
|strSettings || text || Scraper settings as XML
|}

==== cue ====
Cuesheet information that has been extracted from a FLAC file. Generally Cuesheets as separate files are not handled in this way, only those embedded in FLAC files.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Foreign key to [[Databases#path(music)|music path]] of where file is located
|-
|strFileName || text || Name of FLAC file the cuesheet is embedded in
|-
|strCuesheet || text || Cuesheet
|}

==== discography ====
The discography of an artist. This is returned when additional information for an artist is scraped from online sources or NFO files. It has no relationship with the albums actually in the user's music collection, it is just details about the artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|strAlbum || text || Album title
|-
|strYear || text || Year album released
|}

==== genre(music) ====
A music genre. This is a lookup table that enumerates the song genre values read from the genre tags embedded in music files e.g. "Progressive Rock", "Baroque" etc. But could contain anything that has been given as a "genre", and is not strictly limited to music genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Primary Key
|-
|strGenre || varchar(256) || Genre Name
|}

==== path(music) ====
The path of a folder containing music that has been scanned into the music library. This holds hash values of name, size, and timestamp for each folder and sub folder that is used to determine if the conents have changed and thererfore the music files need rescanning as part of library update.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || varchar(512) || Media path
|-
|strHash || text || Hash value
|}

==== role ====
An artist role, a way that an artist has contributed to or been involved with a song. This could be by being in the song artist credits ("artist"), as a musician ("Guitar", "Orchestra" or "vocals" etc.), as composer, conductor, lyricist etc. or involved in some other way as music professional e.g. producer, engineer, mixer etc. This is a lookup table that enumerates the various roles that have been read from tags embedded in music files.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idrole || integer || Primary Key
|-
|strRole || text || Description of role
|}

==== song ====
A song. It is the way that the individual track(s) from a music file are held in the music library. Generally a music file contains just one song, however it may contain more and have an associated cuesheet (separately or embedded) that identifies the individual tracks. A song may be from an album (the release of several tracks as one product so includes EPs etc. ), or a single. Singles from an artist (no album title given in the embedded tags) are internally linked with a fake album in the album table.

The music library can contain songs with the same title, artist credits, track number and album as long as they come from separate music files. Unexpectedly Musicbrainz Track ID is not unique on an album, recordings are sometimes repeated e.g. "[silence]" or on a disc set.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || Primary Key
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|-
|strArtists || text || Song artist(s) description (not always a concatenation of names)
|-
|strGenres || text || Song Genres (denormalised concatenation of values in genre table)
|-
|strTitle || varchar(512) || Song title
|-
|iTrack || integer || Song track number
|-
|iDuration || integer || Song duration in seconds
|-
|iYear || integer || Song's release year
|-
|dwFileNameCRC || text || [unused]
|-
|strFileName || text || Name of music file
|-
|strMusicBrainzTrackID || text || Musicbrainz track ID
|-
|iTimesPlayed || integer || Play count
|-
|iStartOffset || integer || Start position (in seconds) when song from cuesheet
|-
|iEndOffset || integer || End position (in seconds) when song from cuesheet
|-
|idThumb || integer || [unused]
|-
|lastplayed || varchar(20) || Date & time last played
|-
|rating || float || Song rating
|-
|userrating || integer || Song rated by user (out of 10)
|-
|comment || text || Song comment
|-
|mood || text || Song mood
|-
|dateAdded || text || Music file timestamp
|-
|votes || integer || Popularity votes for song rating
|}

==== song_artist ====
This table links songs to artists and the roles they contributed.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|idRole || integer || Foreign key to [[Databases#role|role table]]
|-
|iOrder || integer || Order in artist credits
|-
|strArtist || text || Name of artist (denormalised)
|}

==== song_genre ====
This table links the songs with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|iOrder || integer || Genre order when concatenating to single string
|}

==== version(music) ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of the music database
|-
|iCompressCount || integer || Number of times database has been compressed
|}

== The Video Library ==
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi. The following information is for version 75.

The video database is stored in userdata/Database/MyVideosXX.db, where XX is the version number.

{{red|The current database in use for v17 is MyVideos107.db}}

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

==== episodeview ====
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Used- unknown
|-
|c20 || text || Used- unknown
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || text || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|userrating || text || User Rating
|-
|idSeason || text || Foreign key to the [[Databases#seasons|seasons table]]
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Name of program
|-
|genre || text || Genre
|-
|studio || text || Studio
|-
|premiered || text || Premiered Date
|-
|mpaa || text || MPAA Rating
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== movieview ====
A view that joins movie to file and path.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Image URL
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c22 || text || Path to playable file
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|-
|strSet || text || Movie Set
|-
|strSetOverview || text || Movie Set plot
|-
|strFilename || text || Full name of file including extension
|-
|strPath || text || Path to playable file
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Resume Point
|-
|totalTimeInSeconds || double || Length of video
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== musicvideoview ====
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text ||
|-
|c14 || text ||
|-
|c15 || text ||
|-
|c16 || text ||
|-
|c17 || text ||
|-
|c18 || text ||
|-
|c19 || text ||
|-
|c20 || text ||
|-
|c21 || text ||
|-
|c22 || text ||
|-
|c23 || text ||
|-
|userrating || integer || User Rating
|-
|premiered || text || Premier of Music Video
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|}

==== tvshowview ====
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || User Rating
|-
|duration || integer || Total duration
|-
|idParentPath || integer ||
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|rating || float || Rating
|-
|votes || integer || Votes for rating
|-
|rating_type || text || Type of rating
|-
|uniqueid_value || text ||
|-
|uniqueid_type || text ||
|}

==== tvshow counts ====
This table stores the TV Show watched count, total seasons, last played and date added data
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|-
|dateAdded || text || Date Added
|}

=== Tables ===
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases#episode|episode]], [[Databases#movie|movie]], [[Databases#settings|settings]], and [[Databases#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

==== actor ====
This table stores actor, artist, director, and writer information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Primary Key
|-
|name || integer || Name of the actor, artist, director, or writer
|-
|art_urls|| text || Image URL
|}

==== actor_link ====
This table links actors to Movies, TV Shows, Episodes, Music Videos and stores role information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#tvshow|tv show table]], [[Databases#movie|movie table]],[[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, TV Show, Episode, Music Video
|-
|role || text || Role the actor played
|-
|cast_order || integer || Order actors will be displayed
|}==== art ====
This table stores URLs for video art metadata.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || The id of the media this piece of art is for
|-
|media_type || text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor
|-
|type || text || The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart
|-
|url || text || Image URL
|}

==== bookmark ====
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idBookmark || integer || Primary Key
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|timeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || integer || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark
|-
|player || text || Player used to store bookmark
|-
|playerState || text || Player's internal state in XML
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode)
|}

==== country ====
This table lists countries.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Primary Key
|-
|name || text || Country Name
|}

==== country link ====
This table links countries to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|country_id || integer || Foreign key to [[Databases#country|country table]]
|-
|media_id || integer ||Foreign key to [[Databases#movie|movie table]]
|-
|media_type || integer || Movie
|}

==== director_link ====
This table links directors to Movies, TV show episodes and Music Videos
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#movie|movie table]],[[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, Episode
|}

==== episode ====
This table stores television episode information. Information concerning the series is stored in [[Databases#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Path to episode file
|-
|c19 || text || Used- unknown
|-
|c20 || text || Used- unknown
|-
|c21 || text || Not used
|-
|c22 || text || Not used
|-
|c23 || text || Not used
|-
|idShow || text || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|userrating || text || User Rating
|-
|idSeason || text || Foreign key to the [[Databases#seasons|seasons table]]
|}

==== files ====
This table stores filenames and links the path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Primary Key
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|-
|strFilename || text || Full name of file including extension
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|}

==== genre ====
This table stores genre information. For convenience the contents are duplicated in [[Databases#movie|movie]] and [[Databases#tvshow|tvshow]], so a join isn't necessary.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Primary Key
|-
|name || text || Genre label
|}

==== genre_link ====
This table links genres to movies. (The contents are also stored in movies.c14, though.)
{|class="prettytable"
! Column Name || Data Type || Description
|-
|genre_id || integer || Foreign key to [[Databases#genre|genre table]]
|-
|media_id || integer || Foreign key to [[Databases#movie|movie table]], [[Databases#tvshow|tv show table]], [[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

==== movie ====
This table stores movie information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Image URL
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c22 || text || Path to playable file
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|}

==== movielinktvshow ====
This table links movies to TV shows.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== musicvideo ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text || Path to playable file
|-
|c14 || text || Unknown
|-
|c15 || text || Unknown
|-
|c16 || text || Unknown
|-
|c17 || text || Unknown
|-
|c18 || text || Unknown
|-
|c19 || text || Unknown
|-
|c20 || text || Unknown
|-
|c21 || text || Unknown
|-
|c22 || text || Unknown
|-
|c23 || text || Unknown
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date movie premiered
|}

==== path ====
This table stores path information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || XML file of scraper used for this path
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|-
|noUpdate || bool || Exclude path from library update
|-
|exclude || bool ||

|-
|dateAdded || text ||

|-
|idParentPath || integer ||
|}

==== rating ====
This table stores the ratings for TV Shows, Episodes and Movies
{|class="prettytable"
! Column Name || Data Type || Description
|-
|rating_id || integer || Primary Key
|-
|media_id || integer || Foreign key to [[Databases#episode|episode table]], [[Databases#tvshow|tv show table]], [[Databases#movie|movie table]],
|-
|media_type || text || Movies, TV Show, TV Episode
|-
|rating_type || text || default
|-
|rating || float || rating from scraper site
|-
|votes || integer || votes from scraper site
|}

==== seasons ====
This table stores the links between tv show and seasons.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow|| integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|season || integer || Season number
|-
|name || integer || Unknown
|-
|userrating || integer || User Rating
|}

==== sets ====
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSet || integer || Primary Key
|-
|strSet || text || The name of the set
|-
|strOverview || text || The description of the set
|}

==== settings ====
This table stores settings for individual files.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|Deinterlace || bool || Deinterlace
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|VerticalShift || float||
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || integer || Brightness
|-
|Contrast || integer || Contrast
|-
|Gamma || integer || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|OutputToAllSpeakers || bool || OutputToAllSpeakers
|-
|ResumeTime || integer || ResumeTime
|-
|Crop || bool || Crop
|-
|CropLeft || integer || CropLeft
|-
|CropRight || integer || CropRight
|-
|CropTop || integer || CropTop
|-
|CropBottom || integer || CropBottom
|-
|Sharpness || float || Sharpness
|-
|NoiseReduction || float || Noise Reduction
|-
|NonLinStretch || bool || Non Linear Stretch
|-
|PostProcess || bool || Post Processing
|-
|ScalingMethod || integer || Scaling
|-
|DeinterlaceMode || integer || Deinterlace mode
|-
|StereoMode || integer || Stereo Mode
|-
|StereoInvert || bool || Stereo Inversion
|-
|VideoStream || integer || VideoStream
|}

==== stacktimes ====
This table stores playing times for files (used for playing multi-file videos).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|times|| text || Times
|}

==== streamdetails ====
This table contains information regarding codecs used, aspect ratios etc
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles
|-
|strVideoCodec|| text || Video codex (xvid etc)
|-
|fVideoAspect|| real || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
|-
|iVideoDuration|| integer ||
|-
|strStereoMode || text || Stereo Mode
|-
|strVideoLanguage|| text || Language of the Video
|}

==== studio ====
This table stores studio information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Primary Key
|-
|name || text || Studio Label
|}

==== studio link ====
This table links studios to movies, music videos and tv shows
{|class="prettytable"
! Column Name || Data Type || Description
|-
|studio_id || integer || Foreign key to [[Databases#studio|studio table]]
|-
|media_id || integer || Foreign key to [[Databases#movie|movie table]], [[Databases#tvshow|tv show table]], [[Databases#musicvideo|music video table]]
|-
|media_type || text || Movie, Music Video, TV Show
|}

==== tag ====
This stores tags.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Primary Key
|-
|name || integer || Tag
|}

==== taglinks ====
This table links tags to various media.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|tag_id || integer || Foreign key to [[Databases#tag|tag table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

==== tvshow ====
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases#episode|episode]]. To link a TV show to its episodes, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|userrating || integer || Rating applied by user
|-
|premiered || text || Date tv show premiered
|}

==== tvshowlinkpath ====
This table links a TV show to its path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|}

==== uniqueid ====
This table links a Movie, TV show and Episode to its the scraper site
{|class="prettytable"
! Column Name || Data Type || Description
|-
|uniqueid || integer || Primary Key
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|-
|value || text || ID at scraper site
|-
|type || text || Scraper site
|}

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== writer_link ====
This table links writers stored in the actors table to movies and episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|actor_id || integer || Foreign key to [[Databases#actors|actors table]]
|-
|media_id || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

== The View Modes Database ==
Kodi can track a user's View Mode for every path, so you could browse movies using DVD Thumbs and browse TV shows using Fanart. This database contains the last view and sorting method a user chose for each path while navigating Kodi.

The View Modes database is stored in userdata/Database/ViewModes.db.

{{red|The current database in use for v17 is ViewModes6.db}}

=== Tables ===
The View Modes database uses only two tables. Most of the useful information is in [[Databases#view|view]].

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== view ====
This table stores details on the saved view mode for all known paths.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idView || integer || Primary Key
|-
|window || integer || Window GUI ID
|-
|path || text || Path to trigger the view on
|-
|viewMode || integer || View Mode
|-
|sortMethod || integer || ID of sort method
|-
|sortOrder || integer || Sort order (ascending or descending)
|-
|sortAttributes || integer ||
|-
|skin || text || Skin settings apply to
|}

== See also ==
* [[Version table]]
* [[MySQL]]

{{Top}}

{{updated|17}}
[[Category:Index]]
[[Category:Manual]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Development]]

Music tagging

2017-07-27T07:11:30Z

DaveBlake: /* Explanation of Music importing options */

{{mininav| [[Music library]] }}

<section begin="intro" />

Starting in v16 "Jarvis", Kodi will ask the user who adds any file music source, if it should be loaded into the library.

We recommend you say yes to this prompt as the Kodi Music library has many extra features that help with music navigation, metadata and artwork retrieval.

Once the music is loaded in Kodi's library, you can start to organize and browse music in all kinds of awesome ways. We have chart views, artist, genre, and many other views. Starting from v15 "Helix" you can also create your own custom music nodes just like smart playlists. For example you can now create an A-Z artist view, or all music from the 2000's. See [[Music nodes]] for a guide.

<section end="intro" />
== Explanation of Music Library Scanning Options ==

Let's go to System >> Settings >> Media >> Music >> Library
and look at the options available:

[[File:Music-Library-settings.jpg|800px]]

'''Show song and album updates'''

(This option was previously called 'Include Artists who appear only on compilation albums')
Turning this option on will the artists lists will show many more artists than you would normally like to see, it will include all artists found on every track of the album rather than just the main album artist(s). An example could be an album by a band, with 1 track that has a collaboration with a rapper on 1 song. With it on the rapper would be listed, off only the band is shown. Unfortunately this option is poorly named, and has nothing to do with compilations. When you tag your music you can either set the album artist(s) or if all the songs in an album have the same artist that that is taken as the album artist. If all the songs in an album have different artists then the album artist is taken as "various artists". Basically you will normally want to turn this option off if you want a nice clean Artists view.

'''Fetch additional information during updates'''

This option will grab extra metadata and artwork for artists and albums from online sites (or local NFO files). Since we are a media centre and this kind of stuff is great, we recommend you turn this option on. It will download lots of things with scrapers such as artist biographies, moods, artist thumbnails, album artwork etc. However if you have a large music collection it can take some time, and you have to be confident that your files are well tagged first.

'''Prefer online information'''

This option will overide some of the artist and album data, that was initially derived from the tags in your song files, with information it finds online. The song files themselves are not changed in any way, just the data in the library. Providing that the scraper can uniquely identify the artist or album, this could be used to compensate for minimal tagging, but if you have tagged your music well it is better to let them take precedence, hence we recommend you switch it off normally. This makes it easy to tag your music files and know exactly how they will show up in Kodi. It also makes it easy to change data by simply editing the id3 tag.

'''Scraper selection'''

This option lets you choose a scraper to grab metadata such as artist biographies, and artwork such as pictures or artists. Kodi uses 2 scrapers here, one for the artist, and another for the albums. The difference being the album scraper is able to grab cover-art and album descriptions, genres and reviews. We recommend you stick with the universal scraper here, which will use the MusicBrainz API to search and a number of different sites such as Fanart.tv, TheAudioDB.com and Allmusic to grab the additional data. Since some of these sites are open, it is possible to add information to these sites and scrape the new data from them instantly.

== Tagging with MusicBrainz Picard ==

OK.. lets get one thing straight before we start. Kodi uses the Musicbrainz Artist and Album ID's to do all its metadata lookups. If you have these tags present in your music files then Kodi does not need to do a name search on your music which could introduce errors. This means that the chances of accurate artwork and metadata retrieval will be hugely increased. It also helps to avoid problems such as confusion over artists with the same name. Both Mp3tag and Picard tagging software that can add these tags. MusicBrainz Picard is thats what we are going to use in this example. Thankfully, once its installed it takes about 4 clicks to tag something perfectly as the tagger app is based on online lookups.

'''NOTE''': That's not to say the old method of tagging files(with software likehttp://www.mp3tag.de/en/ or MediaMonkey http://www.mediamonkey.com/) with accurate Artist and Album naming doesn't work. We just have a better way these days. Ultimately this method still uses the MusicBrainz ID to lookup metadata and artwork, you are just relying on the musicbrainz NameSearch API.

So with that said, lets look at how to tag an album in Picard to be loaded into Kodi.

Install (https://picard.musicbrainz.org/) then open Picard . Lets try to Auto Tag an Album:

1) Click the Add folder icon in the top left of the toolbar and select the folder the album is in.

2) Click the "Cluster" button (this brings all the files together so picard knows its a single album).

3) Now click "Lookup". You should now see the album on the right hand side box. (Picard has basically preformed an online search for your music on the MB site and selected what it thinks is the album)

4) Assuming its found the correct album, thats basically it. All you need to do is click save and Picard will save a whole wealth of new tags in your music.

Lets now look at those tags:

[[File:Picard1.jpg]]

Now lets click on a file that has 2 artists collaborating. In this case its track number 3

'''03-50_cent-patiently_waiting_ft._eminem.flac'''

[[File:Picard2.jpg]]

So this song has 2 artists "50 Cent" and "Eminem".

As you can see it has them listed in the ARTISTS tag.

This is very important as Kodi will now have 2 artists on the album and treat it as a compilation release.

[[File:Picard3.jpg]]

And if we look further down the list, we can see the release has lots of MBID's now that Kodi can use for online lookups.

That's basically it, picard makes music tagging incredibly easy and quick.

NOTE: Picard works by using drag and drop a lot. If it misidentifies a track or release, try dragging it onto a track to match it up. You can also right click on the album >> other verions. To select the correct release.

== Loading Music into Kodi Music Library==

Lets now add this folder as a source in Kodi and scan in it into the library.

Go to:

Kodi >> Music >> Files >> Add Music >> Select the album folder (or your music folder if you have many albums) >> Scan to library when prompted.

Assuming you have the options to search online for metadata enabled, Kodi will now scan the tags to populate the libarary, and then lookup and additional bits of artwork and metadata for artists and albums.

[[File:Kodimusicimport1.jpg]]

You can now browse the library by artist, album or via many different views.

[[File:Kodimusicimport2.jpg]]

All artwork, artist biographies and details are now loaded into kodi's library.

You can see the biography and additional details by selecting an artist in the Artists view, and hitting the info button ("i" on the keyboard).

[[File:Kodimusicimport3.jpg]]

You can even change your scraper settings to download the biography in many different languages.

== Tags Kodi reads ==

The music library is created by scanning metadata that is embedded in the music files, not by looking at the file names or the folders they are located in. Kodi reads the following tags. The Kodi version shows that the tag was added from that version onwards, and the actual ag name is given in the various tag formats supported.

<section begin="TagTable" />
{| class="wikitable"
! style="text-align:left;"| Kodi Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|}
<section end="TagTable" />

== Data Kodi Scrapes ==
Having created the music library entries, Kodi can then scrape additional artist and album data from either online sources or from local NFO files. This can be automated as part of update library by enabling "Fetch additional information on update" setting. However, it can be best to scan music files and check the resulting library first, before scraping additional information.

The Universal Album Scraper and The Universal Artist Scraper settings allow the user to choose which online sources are used for different pices of information.

TADB - The Audio Database
AM - Allmusic
MB - Musicbrainz

The additional information scraped is:

'''Artist'''
* Life span (Born, Died) - TADB/AM/MB
* Formed, Disbanded
* YearsActive - AM
* Genres - TADB/AM
* Moods - TADB/AM
* Styles - TADB/AM
* Instruments
* Biography - TADB
* Discography - TADB/AM/MB
* Thumb - fanart.tv/TADB/AM/HT
* Fanart - fanart.tv/TADB/HT

'''Album'''
* Genres
* Year
* Compilation
* Moods - TADB/AM
* Styles - TADB/AM
* Themes - TADB/AM
* Review (description) - TADB
* Thumb (cover) - fanart.tv/TADB/AM
* Label
* Rating - TADB/AM/MB
* Votes

Notice that Genres, Year, Compilation and Label may have been derrived from tag data and these will take prescidence. These values can be overwritten by the scarped values if "Prefer Online Information" setting is enabled. But note that if an album is mis-idenitified by the scraper then with "Prefer Online Information" the album artists will also be replaced with those the scraper found.

== NFO files ==
{{main|NFO files}}
Like with most metadata in XBMC, MusicBrainz tags can be added using [[NFO files]]. Both album.nfo and artist.nfo files can contain the MusicBrainz tag or simply contain a URL to the correct page on the MusicBrainz website, similar to how Movies can contain an IMDb URL NFO file.

== See also ==
=== Similar page names ===
{{#lst:MusicBrainz|similar pages}}

{{updated|16}}

[[Category:Music library]]
[[Category:Manual]]

Music artwork

2017-07-09T16:08:56Z

DaveBlake: Explaing embedded tags and the problems with compilations

{{Artwork_Contents}}
{{mininav|[[Artwork]]}}

<section begin="intro" />Music artwork are images directly related to an Artist or an Album, that are either scraped into the Music library from extenal sources or, in the case of Album art, scanned from the appropriate tags embedded in the music files. The images are, preferably, of high quality, that are displayed when viewing the Album or Artist entry in the library. They may also be used as visualisations while playing music. The Music section in Kodi is able to display up to six types of artwork. This page will describe the different types of artwork available in the Music category of Kodi.<section end="intro" />

{{red|'''It is important to note the following:'''}}
*Artwork is skin dependent. This means that some skins display a small number of artwork types, while other skins will display most of the available artwork types.
*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.
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork. Estuary can display the Extended artwork via additional add-ons.
*While high resolution images do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware.
; {{see also|Music_library}}

= Requirements =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read the following to ensure your music and artwork are correctly scraped and displayed.'''}}

It is important to understand the fundamental difference between video library operation and the music library operation:
*The video library is based on using the filenames to get online data. If the video files are incorrectly named, then there are no scraper results, thus no library entry.
*The music library is based on scanning tags embedded in the music files, not the filenames. Basic tagging is essential, the artists and albums in the library are derrived from these tags.
*Although you may have your music saved in an Artist\Album\Song folder hierarchy, Kodi does not use this structure to create albums or artists.
*'''Populating the music library is a two step process.'''
**The first step reads the tags embedded in the music files, is refered to as scanning. If there is any embedded artwork, this will also be read and cached.
**The second optional step fetches additional artist and album information and artwork, refered to as scraping. This information and artwork can be downloaded from online sources or fetched from local files.
*'''Scraping of additional artist and album information does not happen on library update (including when first adding a source) unless "Fetch additional info on update" is enabled.''' Currently this defaults to '''disabled''', for several reasons:
**It allows you to perform the initial tag scan quickly. In v17 and below, when ''Fetch additional info on update'' is ''enabled'', the two steps happen immediately each album and artist is added. This slows down populating the library. It is a background task, but still gives the impression that it is taking a considerable time to populate the library. In reality it is slowed down by the online scraping, and not the local tag scanning. This will be changed in v18 where Kodi will perform the initial tag scan then, once complete, will commence the online scrape.
**The strategy of immediately scraping each album and artist as it is added can also have unwanted consequences. A common example involves compilation albums. Say for example you have both ''Fetch additional info on update'' and ''Show song and album artists'' is ''enabled'', and a folder called "Compilations" containing all your Various Artist compliation albums. As the processing takes place in alphabetical order, this folder gets processed ''before'' the albums of artists in folders beginning with a letter later in the alphabet. The additional information for the song artists from these compilation albums gets added to the library and scraped before the other albums by that artist had been scanned, and so any artist.nfo file is never found and applied.
**Bad tagging makes a messy library and then the online scrape compounds errors and makes the library difficult to unscramble. It is far better for the user to perform the initial scan, find and fix the bad tags, then perform the on-line scrape knowing there will be no further errors.
**Scraping online also often leaves many gaps on first pass, then the user has to manually ''query for all'' anyway, often several times, to fill these gaps. This was because lack of correct throttling, and general server overload has meant that online scraping often failed (seen in the log as ''503 server errors''). This is expected to be fixed for v17.4 if released or v18.

{{#lst:Adding_music_to_the_library|intro}} {{see also|Adding_music_to_the_library}}

{{#lst:Music_tagging|intro}}{{see also|Music_tagging}}

== Caching ==
All music artwork is cached. If artwork is scraped from local files, once it is cached, Kodi will not access the local files again.

Also be aware of image adjustments made by Kodi during the caching process. See [[Artwork#Cache|Cache]]

<div style="{{linear-gradient|left|#ffaba5, #ffaba5 50%, #ffaba5}}">
Music artwork is cached as part of a multi-tier process. The code which assigns images to files runs and assigns images in the following order:
#Cached Album image
#*This is all the embedded album art read by the tag reader and cached using the album name and album artist.
#Cached filename.jpg
#*This includes an embedded image cached with the fully qualified name.
#Remote filename.jpg
#*This is a filename.jpg on a remote share/folder which is then cached.
#Cached folder.jpg
#*This is a folder.jpg which is cached based off the folder path.
#Remote folder.jpg
#*This is a folder.jpg on a remote share/folder which is then cached.
#Remote foldername.jpg
#*This is a foldername.jpg on a remote share/folder which is then cached.
</div>

= Basic Music Artwork =
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.

{{red|'''Note the following:'''}}
*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.
*To ensure auto-scraping of '''local''' artwork, the music files must be arranged in a certain folder heirarchy. There must be a unique Artist folder which then contains Album folders for '''all''' albums by that artist. These album folders contain the individual songs for that album.
*This folder structure is only important if you want to use local artwork or NFO files for providing additional data, it does not contribute to the basic library contents. The library is populated with Artists and Albums by reading tags embedded in the music files, '''not''' the folder names or hierarchy.
*Kodi does not use folder names to identify artists or albums, so you can name them however you like. It determines the location of the artist and album folders by analysing the file location of songs, and the artist and album of the song from music tags.
*The algorthim used to determine the location of the artist and album folders has weaknesses. It can not handle collaborations (albums by more than one album artist e.g. orchestra and conductor), non-unique artist names, disc sets or singles. If local art is not being found then often it is because of the location of some of the song files connected to that artist or album.
*It is useful to have separate/multiple music sources that separates standard artists and albums, that can easily be organised in a artist\album\song folder heirarchy, from those such as classical music, soundtracks, and compilations which can not.

== Fanart- Artist ==
[[File:Artwork-MusicFanart01.jpg|400px|right]]
Fanart, also known as Wallpapers, Backdrops or Backgrounds, are images that have, in most cases, been created by fans.
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. The fanart displays the artist or band.
;{{see also|FanArt}}

The image to the right is a typical example of music 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.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|16:9}}
| width=200px | {{nowrap|1920x1080}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |fanart.jpg/png
| width=600px |f:\Music\Madonna\fanart.jpg/png
|}
</div>

== Artist Image ==
[[File:Artwork-MusicArtist01.jpg|400px|right]]
The Artist Image is also known as Artist Thumb or just Thumb within Kodi, and is saved as ''folder.jpg'' within the artist folder. They are high quality images of the artist or band members. The image to the right is displaying the Artist Image using the Infowall view in Estuary.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|1000x1000}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |folder.jpg/png
| width=600px |f:\Music\Madonna\folder.jpg/png
|}
</div>

== Manually Adding Artist Artwork ==
From within Kodi, you have the ability to manually change the artwork at any time.

Select the Artist whose artwork you would like to add or change. Call up the Artist Information page. As seen in the images below, there are two options titled ''Get Thumb'' and ''Get Fanart''. Selecting either of these will present you the options as seen in the second and third images. Once selected, you will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location as shown in the following images.
<gallery widths=450px heights=250px>
File:Artwork-MusicAdd01.jpg|Choose either Get thumb or Get fanart on the Artist Information Page
File:Artwork-MusicAdd02.jpg|The browse screen for Get Thumb (Artist Image). Select from Current, Local or Remote (online) sources
File:Artwork-MusicAdd03.jpg|The browse screen for Get Fanart. Select from Current, Local or Remote (online) sources
</gallery>

== Album Image ==
[[File:Artwork-MusicAlbum01.jpg|400px|right]]
The album image is also known as the Album Thumb, Album Cover or as Thumb within Kodi. They are high quality images of the Album cover and each album folder would have its own album Folder image. They are saved as ''folder.jpg'' inside the album folder. The image to the right is displaying the album images using the Infowall view in Estuary.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|1000x1000}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |folder.jpg/png
| width=600px |f:\Music\Madonna\Like A Prayer\folder.jpg/png
|}
</div>

== Manually Adding Album Artwork ==
From within Kodi, you have the ability to manually change the artwork at any time.

Select the Album whose artwork you would like to add or change. Call up the Album Information page. As seen in the images below, select ''Get Thumb'' which will present you the options as seen in the second image. You will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location as shown in the following images.
<gallery widths=450px heights=250px>
File:Artwork-MusicAdd04.jpg|Choose Get thumb on the Album Information Page
File:Artwork-MusicAdd05.jpg|The browse screen for Get Thumb (Album Image). Select from Current, Local or Remote (online) sources
</gallery>

== Source Folder Artwork ==
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, can be landscape, portrait or square images that are used to replace the standard folder icons when browsing your music sources in the files section. You will not see this artwork in the Music menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Music>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.

You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows

<pre><nowiki>
<source>
<name>music</name>
<path>xbms://192.168.1.100:1400/Music/</path>
<thumbnail>F:\Apps\XBMC\thumbs\shares\thumb.png</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg}}
| width=200px | {{nowrap|16:9}}
| width=200px | {{nowrap|640x360}}
|- valign="top"
| width=150px | {{nowrap|*.jpg}}
| width=200px | {{nowrap|1:1.5}}
| width=200px | {{nowrap|400x600}}
|- valign="top"
| width=150px | {{nowrap|*.jpg}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|500x500}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Source'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\Music\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\Musc\Music.jpg
|}
</div>

= Extended Music Artwork =
To display the Extended Music Artwork, an add-on will need to be installed to extend the image handling capabilities of Kodi and the skins. Once this is installed, it will insert extra artwork fields which become available to use in the Skins.
One example is the cdART Manager add-on which can be installed from the official Kodi repository.
; {{see also|Add-on:CdART_Manager}}

{{red|'''Note the following:'''}}
*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.
*To ensure auto-scraping of local artwork, there must be an Artist directory which then contains the Album directories. These album directories contain the individual songs for that album.
*Compilation Albums are problematic for local artwork and metadata. See chapter 5 below for further information.
*All Extended Artwork, except Extra Fanart, is cached by Kodi. Once cached the local original files will no longer be accessed.
*If using the cdART Manager add-on, it is important to note the following
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. When viewing the Album and Artist information page for the first time, the cdART Manager will automatically scrape local artwork. If no local artwork is available, it will scrape online sources.
**Using the Kodi scraper will not download extended artwork. The cdART Manager add-on is required to be run after the Kodi scrape process. i.e. you are performing two or three scrapes depending upon settings.

== Banner ==
[[File:Artwork-MusicBanner01.jpg|400px|right]]

Also known as Wide Banner Icons and Artist Banner. The image to the right shows the Banner view at the top right position. They are images that contain the artist or band. The banner image normally displays the artist or band logo which is of a size that is clearly legible. The view is from the Aeon MQ7- Krypton Mod skin
; {{see also|Wide_banner_icons}}

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|1:0.185}}
| width=200px | {{nowrap|1000x185}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |banner.jpg/png
| width=600px |f:\Music\Madonna\Like A Prayer\banner.jpg/png
|}
</div>

== Logo ==
[[File:Artwork-MusicBanner01.jpg|400px|right]]

Also known as Clear Logo. This is the logo or name of the artist or band on a transparent background. The logo uses the distinctive font associated with the musicians and is uncluttered by other images. The transparent background allows it to be overlayed on other images or video with minimal impact. The image to the right shows the logo at the far right of the image, roughly in the centre and looks like a signature. The view is from the Aeon MQ7- Krypton Mod skin

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.png}}
| width=200px | {{nowrap|1:0.388}}
| width=200px | {{nowrap|800x310}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |logo.png
| width=600px |f:\Music\Madonna\Like A Prayer\logo.png
|}
</div>

== CD Art ==
[[File:Artwork-MusicBanner01.jpg|400px|right]]
CD Art, also known as Disc Art, is the image that is visible on the physical CD. It uses a transparent background.

The image to the right displays the CD Art in two locations- bottom left and bottom right corners of the image.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.png}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|1000x1000}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |cdart.png
| width=600px |f:\Music\Madonna\Like A Prayer\cdart.png
|- valign="top"
| width=300px |or
| width=250px |disc.png
| width=600px |f:\Music\Madonna\Like A Prayer\disc.png
|}
</div>

== Extra fanart ==
Extra fanart is reliant on a supporting skin and have exactly the same properties as the standard Fanart.

It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow.
; {{see also|Extra_Fanart}}

= Embedded Artwork =
<section begin="EmbeddedArtwork" />As of v17, Kodi supports embedded album art in mp3 files with ID3v2 tags, WMA/WMV files with ASF tags, FLAC files with Vorbis comments/Xiph tags, and mp4 files with itunes tags. It does not currently support embedded album art in APEv2 tags or Ogg files.<section end="EmbeddedArtwork" />
<div style="{{linear-gradient|left|#ffaba5, #ffaba5 50%, #ffaba5}}">
Maybe give the actual tag names in a table?<br/>
Perhaps explain the priority of embedded artwork over/under external local art files
</div>

= Best Practice for Local Artwork =
How to organise your music to work around the current limitations Kodi has in identifying where local art (and NFO files) may be located, and what can go wrong.

For a great deal of music, where albums have one album artist, using a unique artist\album\song folder hierarchy is the obvious way to organise your music, and Kodi will have no problems finding correctly named image files located in that structure. It can often happen without an user intervention too, as much tagging software such as Musicbrainz Picard will create a local album art files as part of the tagging process.

==No Suitable Artist Folder==
However it is not always possible to create a unique artist folder, with ''all'' the albums by that artist, and only that artist, in folders beneath it.

*Collaborations

The obvious example is when an album has more than one album artist, this is very common with Classical music where the composer, orchestra and conductor are tagged as album artists, but also happens in popular music e.g. "Riding With The King" is a collaboration between BB King and Eric clapton, or "The Juliet Letters" by Elvis Costello and The Brodsky Quartet. There is no work around for providing local art for artists invloved in collaborations like this. However the artist scraper will still be able to fetch online artwork for these artists.

*Song Artists without Albums

Some artists may appear only on songs from Various Artists compilation albums, or as featured artist on songs on an album by another artist, but do not have any albums in your collection. These artists also do not have a unique folder containing all the songs they perform on, and so again there is no place to store local art.

'''The cdART Manager addon''' does support a way to provide local art for song artists that do not have albums of their own. It involves creating empty (no music files) Artist folders for those artists, and is sensive to the folder name matching the artist name exactly. However, cdART Manager will create such an empty folder for every song artist in your collection, that can be a lot of folders!

*Other Artists: Composers, Producers, Mixers, Musicians etc.

From v17 Kodi processes the tags that descibe the other people involved and musicians etc. in a song. These may be artists with songs and albums in their own right, but often will include people that are do not appear in your music collection in any other role. Again no unique folder containing all the songs they perform on, and no place to store local art.

==Compilations==
Compliation albums also have a reputation for causing difficulties with scraping local artist art. This is mostly because of the unwanted consequences of immediately scraping each album and artist as each is added. (This is solved in v18).

One way to minimise this problem is to leave ''Fetch additional info on update'' ''disabled'', and initiate scraping of album and artist information and artwork using "Query Information for All" from the context menu ''after'' scanning a new source has completed.

Another is to group all compilation albums under a separate folder, named so that, alphabetically, it is the last folder in the list to be processed. So for example if your normal album artists have folders Musicpath\artistname\ then use Musicpath\zzzCompilations\

It can also be useful to put the compliations folder on a completely separate path to where the normal album artist folders are located, and add it as a separate music source. So for example if your normal album artists have folders
Musicpath1\artistname\ then use Musicpath2\zzzCompilations\

{{Top}}

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Video library]]
[[Category:First Time User]]
[[Category:Music library|*]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Music artwork

2017-07-09T07:02:57Z

DaveBlake: Some scanning/scraping amendments

{{Artwork_Contents}}
{{mininav|[[Artwork]]}}

<section begin="intro" />Music artwork are images directly related to an Artist or an Album, that are either scraped into the Music library from extenal sources or, in the case of Album art, scanned from the appropriate tags embedded in the music files. The images are, preferably, of high quality, that are displayed when viewing the Album or Artist entry in the library. They may also be used as visualisations while playing music. The Music section in Kodi is able to display up to six types of artwork. This page will describe the different types of artwork available in the Music category of Kodi.<section end="intro" />

{{red|'''It is important to note the following:'''}}
*Artwork is skin dependent. This means that some skins display a small number of artwork types, while other skins will display most of the available artwork types.
*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.
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork. Estuary can display the Extended artwork via additional add-ons.
*While high resolution images do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware.
; {{see also|Music_library}}

= Requirements =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read the following to ensure your music and artwork are correctly scraped and displayed.'''}}

It is important to understand the fundamental difference between video library operation and the music library operation:
*The video library is based on using the filenames to get online data. If the video files are incorrectly named, then there are no scraper results, thus no library entry.
*The music library is based on scanning tags embedded in the music files, not the filenames. Basic tagging is essential, the artists and albums in the library are derrived from these tags.
*Although you may have your music saved in an Artist\Album\Song folder hierarchy, Kodi does not use this structure to create albums or artists.
*'''Populating the music library is a two step process.'''
**The first step reads the tags embedded in the music files, is refered to as scanning. If there is any embedded artwork, this will also be read and cached.
**The second optional step fetches additional artist and album information and artwork, refered to as scraping. This information and artwork can be downloaded from online sources or fetched from local files.
*'''Scraping of additional artist and album information does not happen on library update (including when first adding a source) unless "Fetch additional info on update" is enabled.''' Currently this defaults to '''disabled''', for several reasons:
**It allows you to perform the initial tag scan quickly. In v17 and below, when ''Fetch additional info on update'' is ''enabled'', the two steps happen immediately each album and artist is added. This slows down populating the library. It is a background task, but still gives the impression that it is taking a considerable time to populate the library. This may cause users to believe that Kodi has stopped working and leads to many users stopping the scrape prematurely which causes further problems with library corruption. In reality it is slowed down by the online scraping, and not the local tag scanning. This will be changed in v18 where Kodi will perform the initial tag scan then, once complete, will commence the online scrape.
**Bad tagging makes a messy library and then the online scrape compounds errors and makes the library difficult to unscramble. It is far better for the user to perform the initial scan, find and fix the bad tags, then perform the on-line scrape knowing there will be no further errors.
**Scraping online also often leaves many gaps on first pass, then the user has to manually ''query for all'' anyway, often several times, to fill these gaps. This was because lack of correct throttling, and general server overload has meant that online scraping often failed (seen in the log as ''503 server errors''). This is expected to be fixed for v17.4 if released or v18.

{{#lst:Adding_music_to_the_library|intro}} {{see also|Adding_music_to_the_library}}

{{#lst:Music_tagging|intro}}{{see also|Music_tagging}}

== Caching ==
All music artwork is cached. If artwork is scraped from local files, once it is cached, Kodi will not access the local files again.

Also be aware of image adjustments made by Kodi during the caching process. See [[Artwork#Cache|Cache]]

<div style="{{linear-gradient|left|#ffaba5, #ffaba5 50%, #ffaba5}}">
Music artwork is cached as part of a multi-tier process. The code which assigns images to files runs and assigns images in the following order:
#Cached Album image
#*This is all the embedded album art read by the tag reader and cached using the album name and album artist.
#Cached filename.jpg
#*This includes an embedded image cached with the fully qualified name.
#Remote filename.jpg
#*This is a filename.jpg on a remote share/folder which is then cached.
#Cached folder.jpg
#*This is a folder.jpg which is cached based off the folder path.
#Remote folder.jpg
#*This is a folder.jpg on a remote share/folder which is then cached.
#Remote foldername.jpg
#*This is a foldername.jpg on a remote share/folder which is then cached.
</div>

= Basic Music Artwork =
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.

{{red|'''Note the following:'''}}
*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.
*To ensure auto-scraping of '''local''' artwork, the music files must be arranged in a certain folder heirarchy. There must be a unique Artist folder which then contains Album folders for '''all''' albums by that artist. These album folders contain the individual songs for that album.
*This folder structure is only important if you want to use local artwork or NFO files for providing additional data, it does not contribute to the basic library contents. The library is populated with Artists and Albums by reading tags embedded in the music files, '''not''' the folder names or hierarchy.
*Kodi does not use folder names to identify artists or albums, so you can name them however you like. It determines the location of the artist and album folders by analysing the file location of songs, and the artist and album of the song from music tags.
*The algorthim used to determine the location of the artist and album folders has weaknesses. It can not handle collaborations (albums by more than one album artist e.g. orchestra and conductor), non-unique artist names, disc sets or singles. If local art is not being found then often it is because of the location of some of the song files connected to that artist or album.
*It is useful to have separate/multiple music sources that separates standard artists and albums, that can easily be organised in a artist\album\song folder heirarchy, from those such as classical music, soundtracks, and compilations which can not.

== Fanart- Artist ==
[[File:Artwork-MusicFanart01.jpg|400px|right]]
Fanart, also known as Wallpapers, Backdrops or Backgrounds, are images that have, in most cases, been created by fans.
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. The fanart displays the artist or band.
;{{see also|FanArt}}

The image to the right is a typical example of music 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.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|16:9}}
| width=200px | {{nowrap|1920x1080}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |fanart.jpg/png
| width=600px |f:\Music\Madonna\fanart.jpg/png
|}
</div>

== Artist Image ==
[[File:Artwork-MusicArtist01.jpg|400px|right]]
The Artist Image is also known as Artist Thumb or just Thumb within Kodi, and is saved as ''folder.jpg'' within the artist folder. They are high quality images of the artist or band members. The image to the right is displaying the Artist Image using the Infowall view in Estuary.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|1000x1000}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |folder.jpg/png
| width=600px |f:\Music\Madonna\folder.jpg/png
|}
</div>

== Manually Adding Artist Artwork ==
From within Kodi, you have the ability to manually change the artwork at any time.

Select the Artist whose artwork you would like to add or change. Call up the Artist Information page. As seen in the images below, there are two options titled ''Get Thumb'' and ''Get Fanart''. Selecting either of these will present you the options as seen in the second and third images. Once selected, you will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location as shown in the following images.
<gallery widths=450px heights=250px>
File:Artwork-MusicAdd01.jpg|Choose either Get thumb or Get fanart on the Artist Information Page
File:Artwork-MusicAdd02.jpg|The browse screen for Get Thumb (Artist Image). Select from Current, Local or Remote (online) sources
File:Artwork-MusicAdd03.jpg|The browse screen for Get Fanart. Select from Current, Local or Remote (online) sources
</gallery>

== Album Image ==
[[File:Artwork-MusicAlbum01.jpg|400px|right]]
The album image is also known as the Album Thumb, Album Cover or as Thumb within Kodi. They are high quality images of the Album cover and each album folder would have its own album Folder image. They are saved as ''folder.jpg'' inside the album folder. The image to the right is displaying the album images using the Infowall view in Estuary.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|1000x1000}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |folder.jpg/png
| width=600px |f:\Music\Madonna\Like A Prayer\folder.jpg/png
|}
</div>

== Manually Adding Album Artwork ==
From within Kodi, you have the ability to manually change the artwork at any time.

Select the Album whose artwork you would like to add or change. Call up the Album Information page. As seen in the images below, select ''Get Thumb'' which will present you the options as seen in the second image. You will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location as shown in the following images.
<gallery widths=450px heights=250px>
File:Artwork-MusicAdd04.jpg|Choose Get thumb on the Album Information Page
File:Artwork-MusicAdd05.jpg|The browse screen for Get Thumb (Album Image). Select from Current, Local or Remote (online) sources
</gallery>

== Source Folder Artwork ==
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, can be landscape, portrait or square images that are used to replace the standard folder icons when browsing your music sources in the files section. You will not see this artwork in the Music menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Music>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.

You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows

<pre><nowiki>
<source>
<name>music</name>
<path>xbms://192.168.1.100:1400/Music/</path>
<thumbnail>F:\Apps\XBMC\thumbs\shares\thumb.png</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg}}
| width=200px | {{nowrap|16:9}}
| width=200px | {{nowrap|640x360}}
|- valign="top"
| width=150px | {{nowrap|*.jpg}}
| width=200px | {{nowrap|1:1.5}}
| width=200px | {{nowrap|400x600}}
|- valign="top"
| width=150px | {{nowrap|*.jpg}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|500x500}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Source'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\Music\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\Musc\Music.jpg
|}
</div>

= Extended Music Artwork =
To display the Extended Music Artwork, an add-on will need to be installed to extend the image handling capabilities of Kodi and the skins. Once this is installed, it will insert extra artwork fields which become available to use in the Skins.
One example is the cdART Manager add-on which can be installed from the official Kodi repository.
; {{see also|Add-on:CdART_Manager}}

{{red|'''Note the following:'''}}
*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.
*To ensure auto-scraping of local artwork, there must be an Artist directory which then contains the Album directories. These album directories contain the individual songs for that album.
*Compilation Albums are problematic for local artwork and metadata. See chapter 5 below for further information.
*All Extended Artwork, except Extra Fanart, is cached by Kodi. Once cached the local original files will no longer be accessed.
*If using the cdART Manager add-on, it is important to note the following
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. When viewing the Album and Artist information page for the first time, the cdART Manager will automatically scrape local artwork. If no local artwork is available, it will scrape online sources.
**Using the Kodi scraper will not download extended artwork. The cdART Manager add-on is required to be run after the Kodi scrape process. i.e. you are performing two or three scrapes depending upon settings.

== Banner ==
[[File:Artwork-MusicBanner01.jpg|400px|right]]

Also known as Wide Banner Icons and Artist Banner. The image to the right shows the Banner view at the top right position. They are images that contain the artist or band. The banner image normally displays the artist or band logo which is of a size that is clearly legible. The view is from the Aeon MQ7- Krypton Mod skin
; {{see also|Wide_banner_icons}}

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.jpg or png}}
| width=200px | {{nowrap|1:0.185}}
| width=200px | {{nowrap|1000x185}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |banner.jpg/png
| width=600px |f:\Music\Madonna\Like A Prayer\banner.jpg/png
|}
</div>

== Logo ==
[[File:Artwork-MusicBanner01.jpg|400px|right]]

Also known as Clear Logo. This is the logo or name of the artist or band on a transparent background. The logo uses the distinctive font associated with the musicians and is uncluttered by other images. The transparent background allows it to be overlayed on other images or video with minimal impact. The image to the right shows the logo at the far right of the image, roughly in the centre and looks like a signature. The view is from the Aeon MQ7- Krypton Mod skin

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.png}}
| width=200px | {{nowrap|1:0.388}}
| width=200px | {{nowrap|800x310}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |logo.png
| width=600px |f:\Music\Madonna\Like A Prayer\logo.png
|}
</div>

== CD Art ==
[[File:Artwork-MusicBanner01.jpg|400px|right]]
CD Art, also known as Disc Art, is the image that is visible on the physical CD. It uses a transparent background.

The image to the right displays the CD Art in two locations- bottom left and bottom right corners of the image.

<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
'''Required file properties:'''<br />
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
{|
|- valign="top"
| '''''File Type'''''
| '''''Aspect Ratio'''''
| '''''Resolution- <small>recommended</small>'''''
|- valign="top"
| width=150px | {{nowrap|*.png}}
| width=200px | {{nowrap|1:1}}
| width=200px | {{nowrap|1000x1000}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Music saved as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |cdart.png
| width=600px |f:\Music\Madonna\Like A Prayer\cdart.png
|- valign="top"
| width=300px |or
| width=250px |disc.png
| width=600px |f:\Music\Madonna\Like A Prayer\disc.png
|}
</div>

== Extra fanart ==
Extra fanart is reliant on a supporting skin and have exactly the same properties as the standard Fanart.

It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow.
; {{see also|Extra_Fanart}}

= Embedded Artwork =
<div style="{{linear-gradient|left|#ffaba5, #ffaba5 50%, #ffaba5}}">
<section begin="EmbeddedArtwork" />As of v17, Kodi supports embedded album art in files with ID3 tags, WMA tags, FLAC and MP4 tags only. It does not support embedded album art in APE or Ogg tags currently.<section end="EmbeddedArtwork" />
</div>

= Compilation Albums =
Compilation albums, various artists, classical music and other collaborative type albums are problematic for Kodi in the following cases:
#When using local artwork and nfo files
#When using the Import/Export function ''See [[Import-Export_library]]''

If you are '''not''' using either one of those functions, then Kodi has no problem scraping online metadata and artwork of correctly named and tagged music files.

There currently is no workaround or fix for this issue, but steps can be taken so that these compilation albums do not affect the remainder of the library of normal single artist albums.
#Group all compilation type albums in one or more directories- eg Compilations, Soundtracks, Classical etc
#Add these compilation directories as separate sources in Kodi and ensure it is named so that, alphabetically, it is the last directory in the list. (f:\zzMusic\zzCompilations\)
#Create Artist directories for artists that appear only on compilation albums, and place their artwork in those empty artist directories. This will allow Kodi to scrape the artwork, and then match it to the compilation artists when it eventually reaches the last directories. '''This method only works with cdART Manager addon'''.

{{Top}}

{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Video library]]
[[Category:First Time User]]
[[Category:Music library|*]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

User talk:Karellen/scratchpad

2017-07-01T08:19:51Z

DaveBlake: Basic Artwork

Is here a good place to comment? Giving it a go anyway.

Worth noting that basic album art (cover) can also be scanned from the appropriate tags embedded in the music files. That is where most of my art comes from. Then album and artist art can be scraped from online sources or NFO files with the location of the art, or manually set to locally held files.

== Basic music Artwork ==

Having a folder for every artist on the compilation is a CDart addon thing, not out the box Kodi. Kodi will not do anything with such folders.

Worth explaining that the name of folders does not matter to Kodi at all, just the files located beneth then and how the music files are tagged

The artist folder is the folder that contains somewhere below it all the songs by that artist. Kodi finds it by searching for the lowest common denominator path (no idea how to say that in user language) not by looking at the name.

Likewise the album folder is the one containing all the songs on that album.

Worth discussing impact of having just one album by an artist, and disc sets. probably some more explanation in my comments on import

User talk:Karellen/scratchpad

2017-07-01T08:10:37Z

DaveBlake: /* Compilation albums */ new section

User talk:Karellen/scratchpad

2017-07-01T08:06:36Z

DaveBlake: Don't forget embedded art

Import-export library

2017-06-20T10:36:25Z

DaveBlake: Highlight the limitations of Export/Import for music library

{{mininav|[[General topics]]|[[Video library|Videos]]{{l2|[[Music/Audio]]}}|[[Video library/Management|Management]]<br /> }}
{{see also|NFO files|HOW-TO:Backup the library}}
<section begin="intro" />Kodi offers the ability to import and export data manually into/from the [[Library|Media Library]], as well as importing media info automatically from [[NFO files|.nfo files]].<section end="intro" />

Kodi has the option to both Export and Import its Video database. These options may be used for a number of reasons including the following more popular ones:
*Perform database backup and recovery (This is not the only method for backup and recovery)
*Reorganization of data or eliminate database fragmentation (export, clean/remove database, re-import)
*Move data between Kodi databases on different platforms (eg Widows to Linux)

It also has an Export and Import option for some parts of the Music database, however the main data in the music library comes from metadata embedded in the music files, and the export facility does not backup this data at all. Likewise import will not populate an empty db. What is imported and exported is any additional album artist and album information that has been previously scraped from NFO files or online sources. It's uses are limited, but it does enable the user to capture data that they have scraped online, including any manual choices they made, it a form that can be transfered.

When exporting, database metadata is dumped to a nfo file which can then be used to import into the same or another Kodi database. The method used to import is dependent upon the export options used.

Various options are available to control what objects are exported or imported.

== Video Library Export / Import ==
The option is accessed via the Settings menu as detailed in the first image.

This option will Export and Import the following Categories:
*Movies
*TV Shows
*Music Videos

Upon selection of the Export Library setting, you will be required to choose the Export method as depicted in the second image below. Continue reading for an explanation of the options.

<gallery widths="700" heights="400">
File:LibExp01.jpg|Location of setting
File:LibExp02.png|Select which Export option you require.
</gallery>

=== Export to Separate Files ===

This option will export the metadata stored in the database and save it into a nfo file. It will be saved to the same directory where that particular Movie/TV Show/Music Video is located. This is a good example where Movies and TV Show episodes would benefit from being in their own directory.

After selecting '''Separate''', you will then be asked if you would like to '''Export thumbnails and fanart?'''. This will export the Fanart, Posters, Banners, Episode Thumbs and Music Video Posters.
*Choosing '''Yes''' will save a copy of the cached artwork into the Movie, TV Show, TV Show Episode and Music Video directory alongside the video file and the nfo file.
*Choosing '''No''' will not export the artwork

The next option is '''Export Actors Thumbs'''.
*Choosing '''Yes''' will export a copy of the Actors artwork in a directory named ''.actors''
*Choosing '''No''' will not export a copy of the Actors artwork

The final option is '''Overwrite Old Files'''.
*Choosing '''Yes''' will overwrite the existing nfo files and artwork. This is useful if you have modified your metadata such as changed the artwork, created or modified movie sets, etc. Any movies/tv shows/music videos that were not present since the last Export will have the nfo and artwork exported to their directory.
*Choosing '''No''' will add nfo files and artwork to those movies/tv shows/music videos that do not already have them. eg they are new and added after the last export. If you made changes to a movie/tv show/music video that already has an nfo created, these changes will '''not''' be exported.
*If this is the first time this option has been run and/or you have no nfo files and artwork saved in your movie/tv show/music video directories, both choices will have the same result.

The Export will commence immediately once the final option is selected. An onscreen progress bar will indicate progress.

<gallery widths="500" heights="300">
File:LibExp03.png|Do you want to export Thumbnails and Fanart?
File:LibExp05.jpg|Do you want to export Actors Thumbs?
File:LibExp04.png|Do you want to Overwrite Old Files?
</gallery>

=== Export to Single File ===
[[File:LibExp06.jpg|400px|right]]

This option will export all metadata and all artwork to a single directory, to a location nominated by the user, as follows:
*The only option available is the save location which you will be prompted and required to enter
*Kodi will create a directory in your selected location named ''xbmc_videodb_yyyy-mm-dd''
*Library metadata will be saved into a single ''videodb.xml'' file within that directory
*Artwork will be saved within multiple sub-directories according to type
*Subsequent exports '''will not''' overwrite existing Single File exports
*Subsequent exports are '''full''' exports. They are '''not''' incremental exports.

{{note|Some users may find the single file export problematic in Frodo and higher, due to an issue with artwork. The export process changes the artwork location URL to the folder location of the export, which causes an issue if you need to refresh the image. To fix, you will need to manually source the image in the Information page of the Movie/TV show }}

=== Import ===

If you exported your library using the '''Export to Separate Files''' option, then you must use the normal scraping process to re-import the data. {{small see also|Library_update}}

If you exported your library using the '''Export to Single File''' option, you will need to use this method to import the data as follows
*Select '''Import''' to commence the import process
*Locate the the directory for your previously saved single file export
*If you have multiple single file exports, ensure you have selected the correct one.
*Select '''Ok'''. A progress bar will be displayed to indicate progress
*Once complete, your library should be functional again

Be aware that if you have removed movies or tv shows or music videos since the export, the metadata for those movies, tv shows and music videos will be re-imported into the library. You will need to run a '''Clean Library''' to remove them. This option is located just above the '''Export''' entry.

== Music Library Export / Import ==

The option is accessed via the Settings menu as detailed in the first image. It is on the same page as the Video Export option. You may have to scroll down to locate it.
Upon selection of the Export Library setting, you will be required to choose the Export method as depicted in the second image below. The process is similar to the Video Export and Import instructions above, but there are some slight variances. Continue reading for an explanation of the options.

<gallery widths="700" heights="400">
File:LibExp01.jpg|Location of setting
File:LibExp02.png|Select which Export option you require.
</gallery>

=== Export to Separate Files ===

This option will export any previously scraped album artist and album information and save it into a nfo file in the locations as follows:
*Artist nfo file and artwork will be saved in the Artist directory
*Album nfo file and artwork will be saved in the Album directory
*If the music source has not been scraped, no nfo file will be written
*Only Album and Album Artist data is exported. Song artists, those that do not have albums and only appear featured on tracks or on "Various Artists" compilation albums, are not included
*Song data such as rating, play count, and last time played are not included either.

{{note|There are weaknesses in the way that Kodi determines the location of the artist directory. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly.
However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. It also gets confused when you have only one album by an artist, and takes the album directory as the artist directory. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result for export is that the artist.NFO file goes somewhere unexpected, and that location may not be unique, so the NFO will contain the artist information from the last album artist exported}}

After selecting '''Separate''', you will then be asked if you would like to '''Export thumbnails and fanart?'''. This will export the Artist and album artwork.
*Choosing '''Yes''' will export a copy of the cached artwork into the appropriate Artist and Album directory.
*Choosing '''No''' will not export the artwork

The final option is '''Overwrite Old Files'''.
*Choosing '''Yes''' will overwrite the existing nfo files and artwork. This is useful if you have scraped album or album artist information online that you want to replace any locally held data, or changed the artwork. Any Albums/Artists that were not present since the last Export will have the nfo and artwork exported to their directory.
*Choosing '''No''' will add nfo files and artwork to those Albums/Artists that do not already have them. eg they are new and added after the last export. If you have modified data of an Artist or Album that was previously exported, this change will not be exported.
*If this is the first time this option has been run and/or you have no nfo files and artwork saved in your Artist/Album directories, both choices will have the same result.

The Export will commence immediately once the final option is selected. An onscreen progress bar will indicate progress.

<gallery widths="700" heights="400">
File:LibExp03.png|Do you want to export Thumbnails and Fanart?
File:LibExp04.png|Do you want to Overwrite Old Files?
</gallery>

=== Export to Single File ===
[[File:LibExp06.jpg|400px|right]]

This option will export previously scraped album artists and album information to a single file, to a location nominated by the user, as follows:
*Kodi will create a file in your selected location named ''musicdb.xml''
*The only option available is the save location which you will be prompted and required to enter

Be aware of the following caveats:
*Export will write an empty .xml file if none of the album artists or albums have been scraped.
*Artwork will not be saved
*Subsequent exports '''will''' overwrite the existing Single File exports

{{note|Using the '''Single File''' export option for music can be problematic when it comes to compilation albums or various artist albums}}

=== Import ===

If you exported your library using the '''Export to Separate Files''' option, then you must use the normal scraping process to re-import the data. {{small see also|Music_library_update}}.

If you exported your library using the '''Export to Single File''' option, you will need to use this method to import the data as follows
*Select '''Import''' to commence the import process
*Locate the the directory for your previously saved single file export
*Select the ''musicdb.xml'' file
*The '''Import''' process will commence immediately
*Once complete, your library should be functional again

Be aware:
*if you have removed Albums or Artists since the export, the metadata for those Albums and Album Artists will be re-imported into the library. You will need to run a '''Clean Library''' to remove them. This option is located just above the '''Export''' entry.

== Music Videos ==
The Music Videos Export/Import is controlled and run by the [[Import-export_library#Video_Library_Export_.2F_Import|Video Library Export/Import]]. Running the Export/Import for Movies and TV Shows, will also run the Export/Import for Music Videos at the same time as they share the same library.

{{note|When using the Single File export in v17, there is a glitch where the artwork for music videos is not saved in the ''musicvideos'' directory, rather it is saved in the ''movies'' directory along with the Movies artwork}}

{{note|This issue has been fixed for v18 onwards}}

== Pictures ==
You cannot Import or Export pictures.

== Importing library information from "My Movies" media management software ==

[http://www.mymovies.dk/ My Movies (www.mymovies.name)] is an online database for profiling DVD-Video movies. [http://www.mymovies.dk/ My Movies] saves an XML file and a poster cover image which with this patch will get scanned by Kodi in the same way as Kodi's own XML formatted NFO files are scanned/scraped.

Kodi has the ability to get the import movie library information from "[http://www.mymovies.dk/ My Movies]" via the mymovies.xml files that it generates, these mymovies.xml are checked after the movie.nfo file.

== Other Options ==
By adding suitable code to ''advancedsettings.xml'', you are able to further modify which data is exported. {{small see also|Advanced_settings}}

<videolibrary>
<exportautothumbs>false</exportautothumbs> -- export auto-generated thumbs. Defaults to false --
<importwatchedstate>false</importwatchedstate> -- import previously exported playdate and playcount from .nfo files. Defaults to false --
<importresumepoint>false</importresumepoint> -- import previously exported resume point from .nfo files. Defaults to false --
</videolibrary>

{{updated|17}}

[[Category:Manual]]
[[Category:Index]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]

Import-export library

2017-06-19T12:53:11Z

DaveBlake: Highlight the limitations of Export/Import for music library

{{mininav|[[General topics]]|[[Video library|Videos]]{{l2|[[Music/Audio]]}}|[[Video library/Management|Management]]<br /> }}
{{see also|NFO files|HOW-TO:Backup the library}}
<section begin="intro" />Kodi offers the ability to import and export data manually into/from the [[Library|Media Library]], as well as importing media info automatically from [[NFO files|.nfo files]].<section end="intro" />

Kodi has the option to both Export and Import its Video database. These options may be used for a number of reasons including the following more popular ones:
*Perform database backup and recovery (This is not the only method for backup and recovery)
*Reorganization of data or eliminate database fragmentation (export, clean/remove database, re-import)
*Move data between Kodi databases on different platforms (eg Widows to Linux)

It also has an Export and Import option for some parts of the Music database, however the main data in the music library comes from metadata embedded in the music files, and the export facility does not backup this data at all. Likewise import will not populate an empty db. What is imported and exported is any additional artist and album information that has been previously scraped from NFO files or online sources. Hence it enables the user to capture data that they have scraped online, including any manual choices they made, it a form that can be transfered.

When exporting, database metadata is dumped to a nfo file which can then be used to import into the same or another Kodi database. The method used to import is dependent upon the export options used.

Various options are available to control what objects are exported or imported.

== Video Library Export / Import ==
The option is accessed via the Settings menu as detailed in the first image.

This option will Export and Import the following Categories:
*Movies
*TV Shows
*Music Videos

Upon selection of the Export Library setting, you will be required to choose the Export method as depicted in the second image below. Continue reading for an explanation of the options.

<gallery widths="700" heights="400">
File:LibExp01.jpg|Location of setting
File:LibExp02.png|Select which Export option you require.
</gallery>

=== Export to Separate Files ===

This option will export the metadata stored in the database and save it into a nfo file. It will be saved to the same directory where that particular Movie/TV Show/Music Video is located. This is a good example where Movies and TV Show episodes would benefit from being in their own directory.

After selecting '''Separate''', you will then be asked if you would like to '''Export thumbnails and fanart?'''. This will export the Fanart, Posters, Banners, Episode Thumbs and Music Video Posters.
*Choosing '''Yes''' will save a copy of the cached artwork into the Movie, TV Show, TV Show Episode and Music Video directory alongside the video file and the nfo file.
*Choosing '''No''' will not export the artwork

The next option is '''Export Actors Thumbs'''.
*Choosing '''Yes''' will export a copy of the Actors artwork in a directory named ''.actors''
*Choosing '''No''' will not export a copy of the Actors artwork

The final option is '''Overwrite Old Files'''.
*Choosing '''Yes''' will overwrite the existing nfo files and artwork. This is useful if you have modified your metadata such as changed the artwork, created or modified movie sets, etc. Any movies/tv shows/music videos that were not present since the last Export will have the nfo and artwork exported to their directory.
*Choosing '''No''' will add nfo files and artwork to those movies/tv shows/music videos that do not already have them. eg they are new and added after the last export. If you made changes to a movie/tv show/music video that already has an nfo created, these changes will '''not''' be exported.
*If this is the first time this option has been run and/or you have no nfo files and artwork saved in your movie/tv show/music video directories, both choices will have the same result.

The Export will commence immediately once the final option is selected. An onscreen progress bar will indicate progress.

<gallery widths="500" heights="300">
File:LibExp03.png|Do you want to export Thumbnails and Fanart?
File:LibExp05.jpg|Do you want to export Actors Thumbs?
File:LibExp04.png|Do you want to Overwrite Old Files?
</gallery>

=== Export to Single File ===
[[File:LibExp06.jpg|400px|right]]

This option will export all metadata and all artwork to a single directory, to a location nominated by the user, as follows:
*The only option available is the save location which you will be prompted and required to enter
*Kodi will create a directory in your selected location named ''xbmc_videodb_yyyy-mm-dd''
*Library metadata will be saved into a single ''videodb.xml'' file within that directory
*Artwork will be saved within multiple sub-directories according to type
*Subsequent exports '''will not''' overwrite existing Single File exports
*Subsequent exports are '''full''' exports. They are '''not''' incremental exports.

{{note|Some users may find the single file export problematic in Frodo and higher, due to an issue with artwork. The export process changes the artwork location URL to the folder location of the export, which causes an issue if you need to refresh the image. To fix, you will need to manually source the image in the Information page of the Movie/TV show }}

=== Import ===

If you exported your library using the '''Export to Separate Files''' option, then you must use the normal scraping process to re-import the data. {{small see also|Library_update}}

If you exported your library using the '''Export to Single File''' option, you will need to use this method to import the data as follows
*Select '''Import''' to commence the import process
*Locate the the directory for your previously saved single file export
*If you have multiple single file exports, ensure you have selected the correct one.
*Select '''Ok'''. A progress bar will be displayed to indicate progress
*Once complete, your library should be functional again

Be aware that if you have removed movies or tv shows or music videos since the export, the metadata for those movies, tv shows and music videos will be re-imported into the library. You will need to run a '''Clean Library''' to remove them. This option is located just above the '''Export''' entry.

== Music Library Export / Import ==

The option is accessed via the Settings menu as detailed in the first image. It is on the same page as the Video Export option. You may have to scroll down to locate it.
Upon selection of the Export Library setting, you will be required to choose the Export method as depicted in the second image below. The process is similar to the Video Export and Import instructions above, but there are some slight variances. Continue reading for an explanation of the options.

<gallery widths="700" heights="400">
File:LibExp01.jpg|Location of setting
File:LibExp02.png|Select which Export option you require.
</gallery>

=== Export to Separate Files ===

This option will export any previously scraped album artist and album information and save it into a nfo file in the locations as follows:
*Artist nfo file and artwork will be saved in the Artist directory
*Album nfo file and artwork will be saved in the Album directory
*If the music source has not been scraped, no nfo file will be written
*Only Album and Album Artist data is exported. Song artists, those that do not have albums and only appear featured on tracks, or on "Various Artists" compilation albums are not included. Song data such as rating, play count, and last time played are not included either.

After selecting '''Separate''', you will then be asked if you would like to '''Export thumbnails and fanart?'''. This will export the Artist and album artwork.
*Choosing '''Yes''' will export a copy of the cached artwork into the appropriate Artist and Album directory.
*Choosing '''No''' will not export the artwork

The final option is '''Overwrite Old Files'''.
*Choosing '''Yes''' will overwrite the existing nfo files and artwork. This is useful if you have scraped album or album artist information online that you want to replace any locally held data, or changed the artwork. Any Albums/Artists that were not present since the last Export will have the nfo and artwork exported to their directory.
*Choosing '''No''' will add nfo files and artwork to those Albums/Artists that do not already have them. eg they are new and added after the last export. If you have modified data of an Artist or Album that was previously exported, this change will not be exported.
*If this is the first time this option has been run and/or you have no nfo files and artwork saved in your Artist/Album directories, both choices will have the same result.

The Export will commence immediately once the final option is selected. An onscreen progress bar will indicate progress.

<gallery widths="700" heights="400">
File:LibExp03.png|Do you want to export Thumbnails and Fanart?
File:LibExp04.png|Do you want to Overwrite Old Files?
</gallery>

=== Export to Single File ===
[[File:LibExp06.jpg|400px|right]]

This option will export previously scraped album artists and album information to a single file, to a location nominated by the user, as follows:
*Kodi will create a file in your selected location named ''musicdb.xml''
*The only option available is the save location which you will be prompted and required to enter

Be aware of the following caveats:
*Export will write an empty .xml file if none of the album artists or albums have been scraped.
*Artwork will not be saved
*Subsequent exports '''will''' overwrite the existing Single File exports

{{note|Using the '''Single File''' export option for music can be problematic when it comes to compilation albums or various artist albums}}

=== Import ===

If you exported your library using the '''Export to Separate Files''' option, then you must use the normal scraping process to re-import the data. {{small see also|Library_update}} This needs correcting.

If you exported your library using the '''Export to Single File''' option, you will need to use this method to import the data as follows
*Select '''Import''' to commence the import process
*Locate the the directory for your previously saved single file export
*Select the ''musicdb.xml'' file
*The '''Import''' process will commence immediately
*Once complete, your library should be functional again

Be aware:
*if you have removed Albums or Artists since the export, the metadata for those Albums and Artists will be re-imported into the library. You will need to run a '''Clean Library''' to remove them. This option is located just above the '''Export''' entry.

== Music Videos ==
The Music Videos Export/Import is controlled and run by the [[Import-export_library#Video_Library_Export_.2F_Import|Video Library Export/Import]]. Running the Export/Import for Movies and TV Shows, will also run the Export/Import for Music Videos at the same time as they share the same library.

{{note|When using the Single File export in v17, there is a glitch where the artwork for music videos is not saved in the ''musicvideos'' directory, rather it is saved in the ''movies'' directory along with the Movies artwork}}

{{note|This issue has been fixed for v18 onwards}}

== Pictures ==
You cannot Import or Export pictures.

== Importing library information from "My Movies" media management software ==

[http://www.mymovies.dk/ My Movies (www.mymovies.name)] is an online database for profiling DVD-Video movies. [http://www.mymovies.dk/ My Movies] saves an XML file and a poster cover image which with this patch will get scanned by Kodi in the same way as Kodi's own XML formatted NFO files are scanned/scraped.

Kodi has the ability to get the import movie library information from "[http://www.mymovies.dk/ My Movies]" via the mymovies.xml files that it generates, these mymovies.xml are checked after the movie.nfo file.

== Other Options ==
By adding suitable code to ''advancedsettings.xml'', you are able to further modify which data is exported. {{small see also|Advanced_settings}}

<videolibrary>
<exportautothumbs>false</exportautothumbs> -- export auto-generated thumbs. Defaults to false --
<importwatchedstate>false</importwatchedstate> -- import previously exported playdate and playcount from .nfo files. Defaults to false --
<importresumepoint>false</importresumepoint> -- import previously exported resume point from .nfo files. Defaults to false --
</videolibrary>

{{updated|17}}

[[Category:Manual]]
[[Category:Index]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]

Advancedsettings.xml

2017-03-19T15:35:44Z

DaveBlake: /* musiclibrary */

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

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

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

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

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

== Layout ==

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

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

where "setting" gives the name of the setting, and "value" gives it's value.

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

= List of available settings =

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}
{{see also|debug log}}
<section begin="loglevel" />
{{xml setting
| tag name = loglevel
| tag attribute = hide
| tag attribute values =
{{option values
| value1= true | value1 description= Hides "enable debugging" guisetting.
| value2= false | value2 description= "enable debugging" guisetting will switch between min(loglevel, 0) and max(loglevel, 2) for off and on respectively. '''(Default)'''
}}
| tag attribute default values = true
| option values =
{{option values
| value1= -1 | value1 description= No logging, suppresses all log output
| value2= 0 | value2 description= Normal logging, only logging errors '''(Default)'''
| value3= 1 | value3 description= Debug logging ''(without showing text on screen)''
| value4= 2 | value4 description= Debug logging with freemem, fps and cpu usage shown on screen
| value5= 3 | value5 description= Debug logging with freemem, fps and cpu usage and full smb logging
}}
| default values = 0
| description =
The logging level that Kodi will use to log errors and information. The "hide" attribute is optional.
| example =
Example:
<syntaxhighlight lang="xml" enclose="div">
<loglevel hide="false">1</loglevel>
</syntaxhighlight>

<br />

{{Note| If debugging is switched on in the GUI, loglevel will be set to 2 (''log to both file and on-screen information''); this will over-ride any <code>advancedsettings.xml</code> setting.}}<br />

{{Note| If debugging is switched on in the GUI when Kodi is shut down, then it will be automatically be re-enabled at level 2 when it is re-started. This is true even if 'hide' is subsequently set to 'true' - in other words, if you enable it in the GUI and then hide the GUI toggle, it will stay on level 2 irrespective of what you subsequently set in <code>advancedsettings.xml</code>.}}<br />
}}
<section end="loglevel" />

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

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

=== other - enableairtunesdebuglog ===
{{see|#enableairtunesdebuglog}}

== Audio/video playback settings ==

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

=== video ===
{{anchor|.3Cvideo.3E}}
{{see also|HOW-TO:Modify automatic watch and resume points|HOW-TO:Modify time seeking}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 

<smallstepbackseconds>7</smallstepbackseconds>  
<usetimeseeking>true</usetimeseeking> 
<timeseekforward>30</timeseekforward>  
<timeseekbackward>-30</timeseekbackward>  
<timeseekforwardbig>600</timeseekforwardbig> 
<timeseekbackwardbig>-600</timeseekbackwardbig> 
<percentseekforward>2</percentseekforward> 
<percentseekbackward>-2</percentseekbackward> 
<percentseekforwardbig>10</percentseekforwardbig> 
<percentseekbackwardbig>-10</percentseekbackwardbig> 

<blackbarcolour>1</blackbarcolour> 

<fullscreenonmoviestart>true</fullscreenonmoviestart> 

<defaultplayer>dvdplayer</defaultplayer> 

<excludefromscan> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>

<playcountminimumpercent>90</playcountminimumpercent> 
<ignoresecondsatstart>180</ignoresecondsatstart> 
<ignorepercentatend>8</ignorepercentatend> 

<forcevaapienabled>true</forcevaapienabled> 

<vdpauscaling>true</vdpauscaling> 

<enablehighqualityhwscalers>true</enablehighqualityhwscalers> 

<dxvaallowhqscaling>false</dxvaallowhqscaling> 

<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing> 

<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing> 
<autoscalemaxfps>30</autoscalemaxfps> 


<adjustrefreshrate>



<override>
<fps>23.976</fps> 
<refresh>60.0</refresh> 
</override>

<override>
<fpsmin>29.96</fpsmin> 
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin> 
<refreshmax>61.0</refreshmax>
</override>


<fallback>
<refresh>50.0</refresh> 
</fallback>


<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>


</adjustrefreshrate>

<checkdxvacompatibility>value</checkdxvacompatibility> 

<useocclusionquery>-1</useocclusionquery> 
<fpsdetect>1</fpsdetect> 

<latency> 

<delay>0</delay> 




<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>


<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>

</latency>

<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d> 
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>

<stagefright> 
<useavccodec>-1</useavccodec>
<usehevccodec>-1</usehevccodec> 
<usevc1codec>-1</usevc1codec>
<usevpxcodec>-1</usevpxcodec>
<usemp4codec>-1</usemp4codec>
<usempeg2codec>-1</usempeg2codec>
<useswrenderer>false</useswrenderer>
</stagefright>

<disableswmultithreading>false</disableswmultithreading> 

<assfixedworks>false</assfixedworks> 

</video>
</syntaxhighlight>

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<dvdplayerignoredtsinwav>false</dvdplayerignoredtsinwav>

<limiterhold>0.025</limiterhold>

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

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

=== measurerefreshrate ===
{{anchor|.3Cmeasurerefreshrate.3E}}
When using "Sync playback to display" on Windows, the detected refreshrate might be wrong.
When enabling measurerefreshrate, the refreshrate is measured instead, which makes it more accurate.

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

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

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

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<minvideocachelevel>5</minvideocachelevel> 
<minaudiocachelevel>10</minaudiocachelevel> 
<cacheindvdplayer>true</cacheindvdplayer> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

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

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

Default: Off



== Video library settings ==

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

Default extensions for VIDEOS:
<pre>
.m4v .3gp .nsv .ts .ty .strm .rm .rmvb .m3u .ifo .mov .qt .divx .xvid .bivx .vob .nrg .img
.iso .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .dvr-ms .mpg .mpeg .mp4 .mkv .avc .vp3
.svq3 .nuv .viv .dv .fli .flv .rar .001 .wpl .zip
</pre>
Examples:
<syntaxhighlight lang="xml" enclose="div">
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</syntaxhighlight>
<section end="videoextensions" />

=== discstubextensions ===
{{anchor|.3Cdiscstubextensions.3E}}
{{main|Media stubs}}
A list of additional file-extensions that will (<tt><add></tt>) or will not (<tt><remove></tt>) be treated as disc stubs.

Default extensions for DISC STUBS:
<pre>
.disc
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<discstubextensions>
<add>.dvd|.blu</add>
<remove>.cd|.vhs</remove>
</discstubextensions>
</syntaxhighlight>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<syntaxhighlight lang="xml" enclose="div">
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<backgroundupdate>false</backgroundupdate> 

<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<hideemptyseries>false</hideemptyseries> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<mymovies> 
<categoriestogenres>false</categoriestogenres> 
</mymovies>
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

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

=== myth ===
{{anchor|.3Cmyth.3E}}
Not seeing all the recordings you expected in the Movies folder? If so, it's very likely that the electronic program guide (EPG) used by MythTV doesn't accurately distinguish between TV Shows and Movies all the time. The following setting allows the length of the recording to also be used to determine if a recording is a Movie.

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

<movielength>0</movielength>
</myth>
</syntaxhighlight>

== Library artwork ==

=== imageres ===
{{anchor|.3Cimageres.3E}}
This tag is new for v12 (Frodo), replacing <thumbsize>.

<section begin="imageres description" />Specify the maximal resolution that art should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

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

=== fanartres ===
{{anchor|.3Cfanartres.3E}}
This tag is new for v12 (Frodo), replacing <fanartheight>.

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

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

=== fanart ===
{{anchor|.3Cfanart.3E}}
As of v12 (Frodo), this tag is only used for music and not video.

A list of additional files to try when searching for fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)

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

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

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

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing/caching i.e. posters, fanart, etc.
<br />
<syntaxhighlight lang="xml" enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

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

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Music windows.

Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .mpa .wav .wma .ogg .mp3 .mp2 .m3u .mod .amf .669 .dmf .dsm .far .gdm
.imf .it .m15 .med .okt .s3m .stm .sfx .ult .uni .xm .sid .ac3 .dts .cue .aif .aiff .wpl .ape .mac .mpc
.mp+ .mpp .shn .zip .rar .wv .nsf .spc .gym .adplug .adx .dsp .adp .ymf .ast .afc .hps .xsp
</pre>

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

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

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

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

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

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

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

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

=== musiclibrary ===
{{anchor|.3Cmusiclibrary.3E}}
Options specific to the Music Library

<syntaxhighlight lang="xml" enclose="div">
<musiclibrary>
<hideallitems>true</hideallitems>  
<allitemsonbottom>true</allitemsonbottom> 
<backgroundupdate>true</backgroundupdate> 
<promptfulltagscan>false</promptfulltagscan> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumssortbyartistthenyear>true</albumssortbyartistthenyear> 
<albumformat>%B - %Y</albumformat> 
<albumformatright>%A</albumformatright> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 
</musiclibrary>
</syntaxhighlight>
<br />
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. Even a rescan won't change the added ones, you have to remove the music source(s) and add them again, or delete the music database to achieve this. This process should be made easier in v18 using <promptfulltagscan> (that is not available in v17)}}

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

=== network ===
{{anchor|.3Cnetwork.3E}}
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
</network>
</syntaxhighlight>

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

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

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

<audiochannelselection>false</audiochannelselection>

<submenuselection>false</submenuselection>

<defaultrootmenu>0</defaultrootmenu>

<defaultsubmenu>4</defaultsubmenu>

<pictureicon>true</pictureicon>

<epgrequesttime>10</epgrequesttime>

<zapwaittime>0</zapwaittime>
</tuxbox>
</syntaxhighlight>

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

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

== File system settings ==

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

Default: False

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}
Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

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

== Input control settings ==

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

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

=== remoterepeat ===
{{anchor|.3Cremoterepeat.3E}}
This used to adjust the amount of time in milliseconds between repeated keystrokes. Used to prevent key-bounce, in other words prevents Kodi (lirc?) seeing one key press as multiple key presses with certain remotes.

<syntaxhighlight lang="xml" enclose="div">
<remoterepeat>800</remoterepeat>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
The controller deadzone is the region of movement around the center which is not recognized by the device. Because joysticks can have noise (report motion when still) and bias (report an offset when centered), spurious events can be reported even though the controller isn't being touched. If you notice these kinds of events, you most likely need to increase your controller's deadzone (both axes recommended). The values range from 0.0 (no deadzone, Kodi will see all input your controller is capable of registering) to 1.0 (it will ignore all input inside of the device's physical limits).

<syntaxhighlight lang="xml" enclose="div">
<controllerdeadzone>0.2</controllerdeadzone>
</syntaxhighlight>

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

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

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

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

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

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

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

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

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

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

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

=== allowd3d9ex ===
{{anchor|.3Callowd3d9ex.3E}}
Applies only to Windows Vista and up. Values: true/false. Allows Kodi to use Direct3D 9Ex, which is a bit more stable and robust than Direct3D 9.

Default:
<syntaxhighlight lang="xml" enclose="div">
<allowd3d9ex>true</allowd3d9ex>
</syntaxhighlight>

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

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

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

=== forced3d9ex ===
{{anchor|.3Cforced3d9ex.3E}}
Windows only: Kodi attempts to detect drivers released for a version earlier than Vista, to avoid using advanced features which are often not emulated correctly. The detection may be incorrect and this setting allows forcing the using of D3D9Ex.

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

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" /> {{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3, combined with nofliptimeout=0, is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This, combined with nofliptimeout is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setup's where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang="xml" enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang="xml" enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang="xml" enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang="xml" enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang="xml" enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

Alternate code.
<syntaxhighlight lang="xml" enclose="div">
<videoscreen>
<fakefullscreen>false</fakefullscreen>
</videoscreen>
</syntaxhighlight>

== Removed tags ==
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[action ID]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 <cachemembuffersize> is renamed to <memorysize> and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<lingertime>''' - Removed in v17
* '''<nofliptimeout>''' - Removed in v17

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang="xml" enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

{{Updated|17}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]

Advancedsettings.xml

2017-03-19T15:26:04Z

DaveBlake: /* musiclibrary */

{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}

<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[userdata folder]]'''.

This file is used for advanced settings and options that do not have GUI controls inside of {{kodi}}. Some settings are experimental or very rarely set, so they can only be used via the advancedsettings.xml file. The file is simply a plain text file and can be edited by various text editors, so long as the name is "advancedsettings.xml". These advanced settings can be used to tweak various things such as episode naming patterns, special network ports, special behaviors, and more.<section end="intro" />

The following page will describe the structure of the advancedsettings.xml file and the various individual settings.

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

The layout of <code>advancedsettings.xml</code> is as follows:

<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives it's value.

A list of the available "setting" strings and their values is given below.

= List of available settings =

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}
{{see also|debug log}}
<section begin="loglevel" />
{{xml setting
| tag name = loglevel
| tag attribute = hide
| tag attribute values =
{{option values
| value1= true | value1 description= Hides "enable debugging" guisetting.
| value2= false | value2 description= "enable debugging" guisetting will switch between min(loglevel, 0) and max(loglevel, 2) for off and on respectively. '''(Default)'''
}}
| tag attribute default values = true
| option values =
{{option values
| value1= -1 | value1 description= No logging, suppresses all log output
| value2= 0 | value2 description= Normal logging, only logging errors '''(Default)'''
| value3= 1 | value3 description= Debug logging ''(without showing text on screen)''
| value4= 2 | value4 description= Debug logging with freemem, fps and cpu usage shown on screen
| value5= 3 | value5 description= Debug logging with freemem, fps and cpu usage and full smb logging
}}
| default values = 0
| description =
The logging level that Kodi will use to log errors and information. The "hide" attribute is optional.
| example =
Example:
<syntaxhighlight lang="xml" enclose="div">
<loglevel hide="false">1</loglevel>
</syntaxhighlight>

<br />

{{Note| If debugging is switched on in the GUI, loglevel will be set to 2 (''log to both file and on-screen information''); this will over-ride any <code>advancedsettings.xml</code> setting.}}<br />

{{Note| If debugging is switched on in the GUI when Kodi is shut down, then it will be automatically be re-enabled at level 2 when it is re-started. This is true even if 'hide' is subsequently set to 'true' - in other words, if you enable it in the GUI and then hide the GUI toggle, it will stay on level 2 irrespective of what you subsequently set in <code>advancedsettings.xml</code>.}}<br />
}}
<section end="loglevel" />

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON RPC]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

=== other - enableairtunesdebuglog ===
{{see|#enableairtunesdebuglog}}

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames (default on ATV)
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang="xml" enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}
{{see also|HOW-TO:Modify automatic watch and resume points|HOW-TO:Modify time seeking}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 

<smallstepbackseconds>7</smallstepbackseconds>  
<usetimeseeking>true</usetimeseeking> 
<timeseekforward>30</timeseekforward>  
<timeseekbackward>-30</timeseekbackward>  
<timeseekforwardbig>600</timeseekforwardbig> 
<timeseekbackwardbig>-600</timeseekbackwardbig> 
<percentseekforward>2</percentseekforward> 
<percentseekbackward>-2</percentseekbackward> 
<percentseekforwardbig>10</percentseekforwardbig> 
<percentseekbackwardbig>-10</percentseekbackwardbig> 

<blackbarcolour>1</blackbarcolour> 

<fullscreenonmoviestart>true</fullscreenonmoviestart> 

<defaultplayer>dvdplayer</defaultplayer> 

<excludefromscan> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>

<playcountminimumpercent>90</playcountminimumpercent> 
<ignoresecondsatstart>180</ignoresecondsatstart> 
<ignorepercentatend>8</ignorepercentatend> 

<forcevaapienabled>true</forcevaapienabled> 

<vdpauscaling>true</vdpauscaling> 

<enablehighqualityhwscalers>true</enablehighqualityhwscalers> 

<dxvaallowhqscaling>false</dxvaallowhqscaling> 

<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing> 

<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing> 
<autoscalemaxfps>30</autoscalemaxfps> 


<adjustrefreshrate>



<override>
<fps>23.976</fps> 
<refresh>60.0</refresh> 
</override>

<override>
<fpsmin>29.96</fpsmin> 
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin> 
<refreshmax>61.0</refreshmax>
</override>


<fallback>
<refresh>50.0</refresh> 
</fallback>


<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>


</adjustrefreshrate>

<checkdxvacompatibility>value</checkdxvacompatibility> 

<useocclusionquery>-1</useocclusionquery> 
<fpsdetect>1</fpsdetect> 

<latency> 

<delay>0</delay> 




<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>


<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>

</latency>

<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d> 
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>

<stagefright> 
<useavccodec>-1</useavccodec>
<usehevccodec>-1</usehevccodec> 
<usevc1codec>-1</usevc1codec>
<usevpxcodec>-1</usevpxcodec>
<usemp4codec>-1</usemp4codec>
<usempeg2codec>-1</usempeg2codec>
<useswrenderer>false</useswrenderer>
</stagefright>

<disableswmultithreading>false</disableswmultithreading> 

<assfixedworks>false</assfixedworks> 

</video>
</syntaxhighlight>

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang="xml" enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<dvdplayerignoredtsinwav>false</dvdplayerignoredtsinwav>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

=== measurerefreshrate ===
{{anchor|.3Cmeasurerefreshrate.3E}}
When using "Sync playback to display" on Windows, the detected refreshrate might be wrong.
When enabling measurerefreshrate, the refreshrate is measured instead, which makes it more accurate.

<syntaxhighlight lang="xml" enclose="div">
<measurerefreshrate>true</measurerefreshrate>
</syntaxhighlight>

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|EDL}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang="xml" enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<minvideocachelevel>5</minvideocachelevel> 
<minaudiocachelevel>10</minaudiocachelevel> 
<cacheindvdplayer>true</cacheindvdplayer> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<epg>
<lingertime>1440</lingertime> 
<updatecheckinterval>300</updatecheckinterval> 
<cleanupinterval>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>30</retryinterruptedupdateinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off



== Video library settings ==

=== videoextensions ===
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.m4v .3gp .nsv .ts .ty .strm .rm .rmvb .m3u .ifo .mov .qt .divx .xvid .bivx .vob .nrg .img
.iso .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .dvr-ms .mpg .mpeg .mp4 .mkv .avc .vp3
.svq3 .nuv .viv .dv .fli .flv .rar .001 .wpl .zip
</pre>
Examples:
<syntaxhighlight lang="xml" enclose="div">
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</syntaxhighlight>
<section end="videoextensions" />

=== discstubextensions ===
{{anchor|.3Cdiscstubextensions.3E}}
{{main|Media stubs}}
A list of additional file-extensions that will (<tt><add></tt>) or will not (<tt><remove></tt>) be treated as disc stubs.

Default extensions for DISC STUBS:
<pre>
.disc
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<discstubextensions>
<add>.dvd|.blu</add>
<remove>.cd|.vhs</remove>
</discstubextensions>
</syntaxhighlight>

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

<syntaxhighlight lang="xml" enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

=== sorttokens ===
{{anchor|.3Csorttokens.3E}}
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang="xml" enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|File stacking}}
This is used by the [[file stacking]] algorithm to combine multi-part files and contains a list of "''[[Regular Expression (RegEx) Tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|File stacking}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang="xml" enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a ''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''

Default expression:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleandatetime>(.+[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-1][0-9])([ _\,\.\[\]\-][^0-9]|$)</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

Default expressions:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](ac3|dts|custom|dc|divx|divx5|dsr|dsrip|dutch|dvd|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|cd[1-9]|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)([^\\\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[TV Shows (Video Library)|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [http://forum.kodi.tv/showthread.php?t=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang="xml" enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''.

Default:
<syntaxhighlight lang="xml" enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[Regular Expression (RegEx) Tutorial|RegEx]]''" or "''[[Regular Expression (RegEx) Tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

<syntaxhighlight lang="xml" enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

<syntaxhighlight lang="xml" enclose="div">
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<backgroundupdate>false</backgroundupdate> 

<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<hideemptyseries>false</hideemptyseries> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<mymovies> 
<categoriestogenres>false</categoriestogenres> 
</mymovies>
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang="xml" enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

=== myth ===
{{anchor|.3Cmyth.3E}}
Not seeing all the recordings you expected in the Movies folder? If so, it's very likely that the electronic program guide (EPG) used by MythTV doesn't accurately distinguish between TV Shows and Movies all the time. The following setting allows the length of the recording to also be used to determine if a recording is a Movie.

<syntaxhighlight lang="xml" enclose="div">
<myth>

<movielength>0</movielength>
</myth>
</syntaxhighlight>

== Library artwork ==

=== imageres ===
{{anchor|.3Cimageres.3E}}
This tag is new for v12 (Frodo), replacing <thumbsize>.

<section begin="imageres description" />Specify the maximal resolution that art should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

<syntaxhighlight lang="xml" enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}
This tag is new for v12 (Frodo), replacing <fanartheight>.

<section begin="fanartres description" />Specify the resolution that cached fanart should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.<section end="fanartres description" />

<syntaxhighlight lang="xml" enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== fanart ===
{{anchor|.3Cfanart.3E}}
As of v12 (Frodo), this tag is only used for music and not video.

A list of additional files to try when searching for fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing/caching i.e. posters, fanart, etc.
<br />
<syntaxhighlight lang="xml" enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]

<syntaxhighlight lang="text" enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang="xml" enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of kodi's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as Kodi is concerned) paths. Use this for mysql only.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;<port>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
:by default "MyVideos"+DB number will be used.
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.
* mysql: defines the name of the database to use

;<user>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<compression>
: ''Optional'' - Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}

;<key>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<cert>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ca>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<capath>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ciphers>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>kodi_video</name>
<user>kodi</user>
<pass>kodi</pass>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', '''<epgdatabase>''', and '''<adspdatabase>''' tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
</musicdatabase>
</syntaxhighlight>

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Music windows.

Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .mpa .wav .wma .ogg .mp3 .mp2 .m3u .mod .amf .669 .dmf .dsm .far .gdm
.imf .it .m15 .med .okt .s3m .stm .sfx .ult .uni .xm .sid .ac3 .dts .cue .aif .aiff .wpl .ape .mac .mpc
.mp+ .mpp .shn .zip .rar .wv .nsf .spc .gym .adplug .adx .dsp .adp .ymf .ast .afc .hps .xsp
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>
</syntaxhighlight>

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang="XML" enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang="xml" enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
{{anchor|.3Cmusiclibrary.3E}}
Options specific to the Music Library

<syntaxhighlight lang="xml" enclose="div">
<musiclibrary>
<hideallitems>true</hideallitems>  
<allitemsonbottom>true</allitemsonbottom> 
<backgroundupdate>true</backgroundupdate> 
<PromptFullTagScan>false</PromptFullTagScan> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumssortbyartistthenyear>true</albumssortbyartistthenyear> 
<albumformat>%B - %Y</albumformat> 
<albumformatright>%A</albumformatright> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
</musiclibrary>
</syntaxhighlight>
<br />
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. Even a rescan won't change the added ones, you have to remove the music source(s) and add them again, or delete the music database to achieve this. This process should be made easier in v18}}

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png, .jpg, .jpeg, .bmp, .gif, .ico, .tif, .tiff, .tga, .pcx, .cbz, .zip, .cbr, .rar, .rss, .webp, .jp2, .apng
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

<syntaxhighlight lang="xml" enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang="xml" enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang="xml" enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang="xml" enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
</network>
</syntaxhighlight>

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

=== cache ===
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

=== tuxbox ===
{{anchor|.3Ctuxbox.3E}}
<syntaxhighlight lang="xml" enclose="div">
<tuxbox>

<audiochannelselection>false</audiochannelselection>

<submenuselection>false</submenuselection>

<defaultrootmenu>0</defaultrootmenu>

<defaultsubmenu>4</defaultsubmenu>

<pictureicon>true</pictureicon>

<epgrequesttime>10</epgrequesttime>

<zapwaittime>0</zapwaittime>
</tuxbox>
</syntaxhighlight>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[add-on]] rollback feature. Increasing the size should increase the amount of past versions saved.
| example = Example: <syntaxhighlight lang="xml" enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />
=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}
Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang="xml" enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang="xml" enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== remoterepeat ===
{{anchor|.3Cremoterepeat.3E}}
This used to adjust the amount of time in milliseconds between repeated keystrokes. Used to prevent key-bounce, in other words prevents Kodi (lirc?) seeing one key press as multiple key presses with certain remotes.

<syntaxhighlight lang="xml" enclose="div">
<remoterepeat>800</remoterepeat>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
The controller deadzone is the region of movement around the center which is not recognized by the device. Because joysticks can have noise (report motion when still) and bias (report an offset when centered), spurious events can be reported even though the controller isn't being touched. If you notice these kinds of events, you most likely need to increase your controller's deadzone (both axes recommended). The values range from 0.0 (no deadzone, Kodi will see all input your controller is capable of registering) to 1.0 (it will ignore all input inside of the device's physical limits).

<syntaxhighlight lang="xml" enclose="div">
<controllerdeadzone>0.2</controllerdeadzone>
</syntaxhighlight>

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang="xml" enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang="xml" enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang="xml" enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang="xml" enclose="div">
<window><width>WIDTH</width><height>HEIGHT</height></window>
</syntaxhighlight>

=== allowd3d9ex ===
{{anchor|.3Callowd3d9ex.3E}}
Applies only to Windows Vista and up. Values: true/false. Allows Kodi to use Direct3D 9Ex, which is a bit more stable and robust than Direct3D 9.

Default:
<syntaxhighlight lang="xml" enclose="div">
<allowd3d9ex>true</allowd3d9ex>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang="xml" enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== forced3d9ex ===
{{anchor|.3Cforced3d9ex.3E}}
Windows only: Kodi attempts to detect drivers released for a version earlier than Vista, to avoid using advanced features which are often not emulated correctly. The detection may be incorrect and this setting allows forcing the using of D3D9Ex.

<syntaxhighlight lang="xml" enclose="div">
<forced3d9ex>false</forced3d9ex>
</syntaxhighlight>

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" /> {{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3, combined with nofliptimeout=0, is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This, combined with nofliptimeout is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setup's where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang="xml" enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang="xml" enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang="xml" enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang="xml" enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang="xml" enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

Alternate code.
<syntaxhighlight lang="xml" enclose="div">
<videoscreen>
<fakefullscreen>false</fakefullscreen>
</videoscreen>
</syntaxhighlight>

== Removed tags ==
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[action ID]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 <cachemembuffersize> is renamed to <memorysize> and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<lingertime>''' - Removed in v17
* '''<nofliptimeout>''' - Removed in v17

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang="xml" enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

{{Updated|17}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]

Music tagging

2017-02-21T13:07:59Z

DaveBlake: /* Data Kodi Scrapes */

{{mininav| [[Music library]] }}

<section begin="intro" />

Starting in v16 "Jarvis", Kodi will ask the user who adds any file music source, if it should be loaded into the library.

We recommend you say yes to this prompt as the Kodi Music library has many extra features that help with music navigation, metadata and artwork retrieval.

Once the music is loaded in Kodi's library, you can start to organize and browse music in all kinds of awesome ways. We have chart views, artist, genre, and many other views. Starting from v15 "Helix" you can also create your own custom music nodes just like smart playlists. For example you can now create an A-Z artist view, or all music from the 2000's. See [[Music nodes]] for a guide.

<section end="intro" />
== Explanation of Music importing options ==

The first thing we need to do is go to System >> Settings >> Music >> Library

And look at the options available:

[[File:Music-Library-settings.jpg]]

'''Include Artists who appear only on compilation albums'''

Turning this option on will the artists lists will show many more artists than you would normally like to see, it will include all artists found on every track of the album rather than just the main album artist(s). An example could be an album by a band, with 1 track that has a collaboration with a rapper on 1 song. With it on the rapper would be listed, off only the band is shown. Unfortunately this option is poorly named, and has nothing to do with compilations. When you tag your music you can either set the album artist(s) or if all the songs in an album have the same artist that that is taken as the album artist. If all the songs in an album have different artists then the album artist is taken as "various artists". Basically you will normally want to turn this option off if you want a nice clean Artists view.

'''Fetch additional information during updates'''

This option will grab extra metadata and artwork for artists and albums from online sites (or local NFO files). Since we are a media centre and this kind of stuff is great, we recommend you turn this option on. It will download lots of things with scrapers such as artist biographies, moods, artist thumbnails, album artwork etc. However if you have a large music collection it can take some time, and you have to be confident that your files are well tagged first.

'''Prefer online information'''

This option will overide some of the artist and album data, that was initially derived from the tags in your song files, with information it finds online. The song files themselves are not changed in any way, just the data in the library. Providing that the scraper can uniquely identify the artist or album, this could be used to compensate for minimal tagging, but if you have tagged your music well it is better to let them take precedence, hence we recommend you switch it off normally. This makes it easy to tag your music files and know exactly how they will show up in Kodi. It also makes it easy to change data by simply editing the id3 tag.

'''Scraper selection'''

This option lets you choose a scraper to grab metadata such as artist biographies, and artwork such as pictures or artists. Kodi uses 2 scrapers here, one for the artist, and another for the albums. The difference being the album scraper is able to grab cover-art and album descriptions, genres and reviews. We recommend you stick with the universal scraper here, which will use the MusicBrainz API to search and a number of different sites such as Fanart.tv, TheAudioDB.com and Allmusic to grab the additional data. Since some of these sites are open, it is possible to add information to these sites and scrape the new data from them instantly.

== Tagging with MusicBrainz Picard ==

OK.. lets get one thing straight before we start. Kodi uses the Musicbrainz Artist and Album ID's to do all its metadata lookups. If you have these tags present in your music files then Kodi does not need to do a name search on your music which could introduce errors. This means that the chances of accurate artwork and metadata retrieval will be hugely increased. It also helps to avoid problems such as confusion over artists with the same name. Both Mp3tag and Picard tagging software that can add these tags. MusicBrainz Picard is thats what we are going to use in this example. Thankfully, once its installed it takes about 4 clicks to tag something perfectly as the tagger app is based on online lookups.

'''NOTE''': That's not to say the old method of tagging files(with software likehttp://www.mp3tag.de/en/ or MediaMonkey http://www.mediamonkey.com/) with accurate Artist and Album naming doesn't work. We just have a better way these days. Ultimately this method still uses the MusicBrainz ID to lookup metadata and artwork, you are just relying on the musicbrainz NameSearch API.

So with that said, lets look at how to tag an album in Picard to be loaded into Kodi.

Install (https://picard.musicbrainz.org/) then open Picard . Lets try to Auto Tag an Album:

1) Click the Add folder icon in the top left of the toolbar and select the folder the album is in.

2) Click the "Cluster" button (this brings all the files together so picard knows its a single album).

3) Now click "Lookup". You should now see the album on the right hand side box. (Picard has basically preformed an online search for your music on the MB site and selected what it thinks is the album)

4) Assuming its found the correct album, thats basically it. All you need to do is click save and Picard will save a whole wealth of new tags in your music.

Lets now look at those tags:

[[File:Picard1.jpg]]

Now lets click on a file that has 2 artists collaborating. In this case its track number 3

'''03-50_cent-patiently_waiting_ft._eminem.flac'''

[[File:Picard2.jpg]]

So this song has 2 artists "50 Cent" and "Eminem".

As you can see it has them listed in the ARTISTS tag.

This is very important as Kodi will now have 2 artists on the album and treat it as a compilation release.

[[File:Picard3.jpg]]

And if we look further down the list, we can see the release has lots of MBID's now that Kodi can use for online lookups.

That's basically it, picard makes music tagging incredibly easy and quick.

NOTE: Picard works by using drag and drop a lot. If it misidentifies a track or release, try dragging it onto a track to match it up. You can also right click on the album >> other verions. To select the correct release.

== Loading Music into Kodi Music Library==

Lets now add this folder as a source in Kodi and scan in it into the library.

Go to:

Kodi >> Music >> Files >> Add Music >> Select the album folder (or your music folder if you have many albums) >> Scan to library when prompted.

Assuming you have the options to search online for metadata enabled, Kodi will now scan the tags to populate the libarary, and then lookup and additional bits of artwork and metadata for artists and albums.

[[File:Kodimusicimport1.jpg]]

You can now browse the library by artist, album or via many different views.

[[File:Kodimusicimport2.jpg]]

All artwork, artist biographies and details are now loaded into kodi's library.

You can see the biography and additional details by selecting an artist in the Artists view, and hitting the info button ("i" on the keyboard).

[[File:Kodimusicimport3.jpg]]

You can even change your scraper settings to download the biography in many different languages.

== Tags Kodi reads ==

The music library is created by scanning metadata that is embedded in the music files, not by looking at the file names or the folders they are located in. Kodi reads the following tags. The Kodi version shows that the tag was added from that version onwards, and the actual ag name is given in the various tag formats supported.

{| class="wikitable"
! style="text-align:left;"| Kodi Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|}

== Data Kodi Scrapes ==
Having created the music library entries, Kodi can then scrape additional artist and album data from either online sources or from local NFO files. This can be automated as part of update library by enabling "Fetch additional information on update" setting. However, it can be best to scan music files and check the resulting library first, before scraping additional information.

The Universal Album Scraper and The Universal Artist Scraper settings allow the user to choose which online sources are used for different pices of information.

TADB - The Audio Database
AM - Allmusic
MB - Musicbrainz

The additional information scraped is:

'''Artist'''
* Life span (Born, Died) - TADB/AM/MB
* Formed, Disbanded
* YearsActive - AM
* Genres - TADB/AM
* Moods - TADB/AM
* Styles - TADB/AM
* Instruments
* Biography - TADB
* Discography - TADB/AM/MB
* Thumb - fanart.tv/TADB/AM/HT
* Fanart - fanart.tv/TADB/HT

'''Album'''
* Genres
* Year
* Compilation
* Moods - TADB/AM
* Styles - TADB/AM
* Themes - TADB/AM
* Review (description) - TADB
* Thumb (cover) - fanart.tv/TADB/AM
* Label
* Rating - TADB/AM/MB
* Votes

Notice that Genres, Year, Compilation and Label may have been derrived from tag data and these will take prescidence. These values can be overwritten by the scarped values if "Prefer Online Information" setting is enabled. But note that if an album is mis-idenitified by the scraper then with "Prefer Online Information" the album artists will also be replaced with those the scraper found.

== NFO files ==
{{main|NFO files}}
Like with most metadata in XBMC, MusicBrainz tags can be added using [[NFO files]]. Both album.nfo and artist.nfo files can contain the MusicBrainz tag or simply contain a URL to the correct page on the MusicBrainz website, similar to how Movies can contain an IMDb URL NFO file.

== See also ==
=== Similar page names ===
{{#lst:MusicBrainz|similar pages}}

{{updated|16}}

[[Category:Music library]]
[[Category:Manual]]

Music tagging

2017-02-21T12:56:50Z

DaveBlake: /* Tags Kodi reads */

{{mininav| [[Music library]] }}

<section begin="intro" />

Starting in v16 "Jarvis", Kodi will ask the user who adds any file music source, if it should be loaded into the library.

We recommend you say yes to this prompt as the Kodi Music library has many extra features that help with music navigation, metadata and artwork retrieval.

Once the music is loaded in Kodi's library, you can start to organize and browse music in all kinds of awesome ways. We have chart views, artist, genre, and many other views. Starting from v15 "Helix" you can also create your own custom music nodes just like smart playlists. For example you can now create an A-Z artist view, or all music from the 2000's. See [[Music nodes]] for a guide.

<section end="intro" />
== Explanation of Music importing options ==

The first thing we need to do is go to System >> Settings >> Music >> Library

And look at the options available:

[[File:Music-Library-settings.jpg]]

'''Include Artists who appear only on compilation albums'''

Turning this option on will the artists lists will show many more artists than you would normally like to see, it will include all artists found on every track of the album rather than just the main album artist(s). An example could be an album by a band, with 1 track that has a collaboration with a rapper on 1 song. With it on the rapper would be listed, off only the band is shown. Unfortunately this option is poorly named, and has nothing to do with compilations. When you tag your music you can either set the album artist(s) or if all the songs in an album have the same artist that that is taken as the album artist. If all the songs in an album have different artists then the album artist is taken as "various artists". Basically you will normally want to turn this option off if you want a nice clean Artists view.

'''Fetch additional information during updates'''

This option will grab extra metadata and artwork for artists and albums from online sites (or local NFO files). Since we are a media centre and this kind of stuff is great, we recommend you turn this option on. It will download lots of things with scrapers such as artist biographies, moods, artist thumbnails, album artwork etc. However if you have a large music collection it can take some time, and you have to be confident that your files are well tagged first.

'''Prefer online information'''

This option will overide some of the artist and album data, that was initially derived from the tags in your song files, with information it finds online. The song files themselves are not changed in any way, just the data in the library. Providing that the scraper can uniquely identify the artist or album, this could be used to compensate for minimal tagging, but if you have tagged your music well it is better to let them take precedence, hence we recommend you switch it off normally. This makes it easy to tag your music files and know exactly how they will show up in Kodi. It also makes it easy to change data by simply editing the id3 tag.

'''Scraper selection'''

This option lets you choose a scraper to grab metadata such as artist biographies, and artwork such as pictures or artists. Kodi uses 2 scrapers here, one for the artist, and another for the albums. The difference being the album scraper is able to grab cover-art and album descriptions, genres and reviews. We recommend you stick with the universal scraper here, which will use the MusicBrainz API to search and a number of different sites such as Fanart.tv, TheAudioDB.com and Allmusic to grab the additional data. Since some of these sites are open, it is possible to add information to these sites and scrape the new data from them instantly.

== Tagging with MusicBrainz Picard ==

OK.. lets get one thing straight before we start. Kodi uses the Musicbrainz Artist and Album ID's to do all its metadata lookups. If you have these tags present in your music files then Kodi does not need to do a name search on your music which could introduce errors. This means that the chances of accurate artwork and metadata retrieval will be hugely increased. It also helps to avoid problems such as confusion over artists with the same name. Both Mp3tag and Picard tagging software that can add these tags. MusicBrainz Picard is thats what we are going to use in this example. Thankfully, once its installed it takes about 4 clicks to tag something perfectly as the tagger app is based on online lookups.

'''NOTE''': That's not to say the old method of tagging files(with software likehttp://www.mp3tag.de/en/ or MediaMonkey http://www.mediamonkey.com/) with accurate Artist and Album naming doesn't work. We just have a better way these days. Ultimately this method still uses the MusicBrainz ID to lookup metadata and artwork, you are just relying on the musicbrainz NameSearch API.

So with that said, lets look at how to tag an album in Picard to be loaded into Kodi.

Install (https://picard.musicbrainz.org/) then open Picard . Lets try to Auto Tag an Album:

1) Click the Add folder icon in the top left of the toolbar and select the folder the album is in.

2) Click the "Cluster" button (this brings all the files together so picard knows its a single album).

3) Now click "Lookup". You should now see the album on the right hand side box. (Picard has basically preformed an online search for your music on the MB site and selected what it thinks is the album)

4) Assuming its found the correct album, thats basically it. All you need to do is click save and Picard will save a whole wealth of new tags in your music.

Lets now look at those tags:

[[File:Picard1.jpg]]

Now lets click on a file that has 2 artists collaborating. In this case its track number 3

'''03-50_cent-patiently_waiting_ft._eminem.flac'''

[[File:Picard2.jpg]]

So this song has 2 artists "50 Cent" and "Eminem".

As you can see it has them listed in the ARTISTS tag.

This is very important as Kodi will now have 2 artists on the album and treat it as a compilation release.

[[File:Picard3.jpg]]

And if we look further down the list, we can see the release has lots of MBID's now that Kodi can use for online lookups.

That's basically it, picard makes music tagging incredibly easy and quick.

NOTE: Picard works by using drag and drop a lot. If it misidentifies a track or release, try dragging it onto a track to match it up. You can also right click on the album >> other verions. To select the correct release.

== Loading Music into Kodi Music Library==

Lets now add this folder as a source in Kodi and scan in it into the library.

Go to:

Kodi >> Music >> Files >> Add Music >> Select the album folder (or your music folder if you have many albums) >> Scan to library when prompted.

Assuming you have the options to search online for metadata enabled, Kodi will now scan the tags to populate the libarary, and then lookup and additional bits of artwork and metadata for artists and albums.

[[File:Kodimusicimport1.jpg]]

You can now browse the library by artist, album or via many different views.

[[File:Kodimusicimport2.jpg]]

All artwork, artist biographies and details are now loaded into kodi's library.

You can see the biography and additional details by selecting an artist in the Artists view, and hitting the info button ("i" on the keyboard).

[[File:Kodimusicimport3.jpg]]

You can even change your scraper settings to download the biography in many different languages.

== Tags Kodi reads ==

The music library is created by scanning metadata that is embedded in the music files, not by looking at the file names or the folders they are located in. Kodi reads the following tags. The Kodi version shows that the tag was added from that version onwards, and the actual ag name is given in the various tag formats supported.

{| class="wikitable"
! style="text-align:left;"| Kodi Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|}

== Data Kodi Scrapes ==
'''Artist'''
* Life span (Born, Died) - TADB/AM/MB
* Formed, Disbanded
* YearsActive - AM
* Genres - TADB/AM
* Moods - TADB/AM
* Styles - TADB/AM
* Instruments
* Biography - TADB
* Discography - TADB/AM/MB
* Thumb - fanart.tv/TADB/AM/HT
* Fanart - fanart.tv/TADB/HT

'''Album'''
* Genres
* Year
* Compilation
* Moods - TADB/AM
* Styles - TADB/AM
* Themes - TADB/AM
* Review (description) - TADB
* Thumb (cover) - fanart.tv/TADB/AM
* Label
* Rating - TADB/AM/MB

== NFO files ==
{{main|NFO files}}
Like with most metadata in XBMC, MusicBrainz tags can be added using [[NFO files]]. Both album.nfo and artist.nfo files can contain the MusicBrainz tag or simply contain a URL to the correct page on the MusicBrainz website, similar to how Movies can contain an IMDb URL NFO file.

== See also ==
=== Similar page names ===
{{#lst:MusicBrainz|similar pages}}

{{updated|16}}

[[Category:Music library]]
[[Category:Manual]]

Music tagging

2017-02-21T12:52:14Z

DaveBlake: /* Tags Kodi reads */

{{mininav| [[Music library]] }}

<section begin="intro" />

Starting in v16 "Jarvis", Kodi will ask the user who adds any file music source, if it should be loaded into the library.

We recommend you say yes to this prompt as the Kodi Music library has many extra features that help with music navigation, metadata and artwork retrieval.

Once the music is loaded in Kodi's library, you can start to organize and browse music in all kinds of awesome ways. We have chart views, artist, genre, and many other views. Starting from v15 "Helix" you can also create your own custom music nodes just like smart playlists. For example you can now create an A-Z artist view, or all music from the 2000's. See [[Music nodes]] for a guide.

<section end="intro" />
== Explanation of Music importing options ==

The first thing we need to do is go to System >> Settings >> Music >> Library

And look at the options available:

[[File:Music-Library-settings.jpg]]

'''Include Artists who appear only on compilation albums'''

Turning this option on will the artists lists will show many more artists than you would normally like to see, it will include all artists found on every track of the album rather than just the main album artist(s). An example could be an album by a band, with 1 track that has a collaboration with a rapper on 1 song. With it on the rapper would be listed, off only the band is shown. Unfortunately this option is poorly named, and has nothing to do with compilations. When you tag your music you can either set the album artist(s) or if all the songs in an album have the same artist that that is taken as the album artist. If all the songs in an album have different artists then the album artist is taken as "various artists". Basically you will normally want to turn this option off if you want a nice clean Artists view.

'''Fetch additional information during updates'''

This option will grab extra metadata and artwork for artists and albums from online sites (or local NFO files). Since we are a media centre and this kind of stuff is great, we recommend you turn this option on. It will download lots of things with scrapers such as artist biographies, moods, artist thumbnails, album artwork etc. However if you have a large music collection it can take some time, and you have to be confident that your files are well tagged first.

'''Prefer online information'''

This option will overide some of the artist and album data, that was initially derived from the tags in your song files, with information it finds online. The song files themselves are not changed in any way, just the data in the library. Providing that the scraper can uniquely identify the artist or album, this could be used to compensate for minimal tagging, but if you have tagged your music well it is better to let them take precedence, hence we recommend you switch it off normally. This makes it easy to tag your music files and know exactly how they will show up in Kodi. It also makes it easy to change data by simply editing the id3 tag.

'''Scraper selection'''

This option lets you choose a scraper to grab metadata such as artist biographies, and artwork such as pictures or artists. Kodi uses 2 scrapers here, one for the artist, and another for the albums. The difference being the album scraper is able to grab cover-art and album descriptions, genres and reviews. We recommend you stick with the universal scraper here, which will use the MusicBrainz API to search and a number of different sites such as Fanart.tv, TheAudioDB.com and Allmusic to grab the additional data. Since some of these sites are open, it is possible to add information to these sites and scrape the new data from them instantly.

== Tagging with MusicBrainz Picard ==

OK.. lets get one thing straight before we start. Kodi uses the Musicbrainz Artist and Album ID's to do all its metadata lookups. If you have these tags present in your music files then Kodi does not need to do a name search on your music which could introduce errors. This means that the chances of accurate artwork and metadata retrieval will be hugely increased. It also helps to avoid problems such as confusion over artists with the same name. Both Mp3tag and Picard tagging software that can add these tags. MusicBrainz Picard is thats what we are going to use in this example. Thankfully, once its installed it takes about 4 clicks to tag something perfectly as the tagger app is based on online lookups.

'''NOTE''': That's not to say the old method of tagging files(with software likehttp://www.mp3tag.de/en/ or MediaMonkey http://www.mediamonkey.com/) with accurate Artist and Album naming doesn't work. We just have a better way these days. Ultimately this method still uses the MusicBrainz ID to lookup metadata and artwork, you are just relying on the musicbrainz NameSearch API.

So with that said, lets look at how to tag an album in Picard to be loaded into Kodi.

Install (https://picard.musicbrainz.org/) then open Picard . Lets try to Auto Tag an Album:

1) Click the Add folder icon in the top left of the toolbar and select the folder the album is in.

2) Click the "Cluster" button (this brings all the files together so picard knows its a single album).

3) Now click "Lookup". You should now see the album on the right hand side box. (Picard has basically preformed an online search for your music on the MB site and selected what it thinks is the album)

4) Assuming its found the correct album, thats basically it. All you need to do is click save and Picard will save a whole wealth of new tags in your music.

Lets now look at those tags:

[[File:Picard1.jpg]]

Now lets click on a file that has 2 artists collaborating. In this case its track number 3

'''03-50_cent-patiently_waiting_ft._eminem.flac'''

[[File:Picard2.jpg]]

So this song has 2 artists "50 Cent" and "Eminem".

As you can see it has them listed in the ARTISTS tag.

This is very important as Kodi will now have 2 artists on the album and treat it as a compilation release.

[[File:Picard3.jpg]]

And if we look further down the list, we can see the release has lots of MBID's now that Kodi can use for online lookups.

That's basically it, picard makes music tagging incredibly easy and quick.

NOTE: Picard works by using drag and drop a lot. If it misidentifies a track or release, try dragging it onto a track to match it up. You can also right click on the album >> other verions. To select the correct release.

== Loading Music into Kodi Music Library==

Lets now add this folder as a source in Kodi and scan in it into the library.

Go to:

Kodi >> Music >> Files >> Add Music >> Select the album folder (or your music folder if you have many albums) >> Scan to library when prompted.

Assuming you have the options to search online for metadata enabled, Kodi will now scan the tags to populate the libarary, and then lookup and additional bits of artwork and metadata for artists and albums.

[[File:Kodimusicimport1.jpg]]

You can now browse the library by artist, album or via many different views.

[[File:Kodimusicimport2.jpg]]

All artwork, artist biographies and details are now loaded into kodi's library.

You can see the biography and additional details by selecting an artist in the Artists view, and hitting the info button ("i" on the keyboard).

[[File:Kodimusicimport3.jpg]]

You can even change your scraper settings to download the biography in many different languages.

== Tags Kodi reads ==

Kodi scans the following metadata tags from music files, tag name given in the various tag formats supported. The Kodi version shows tag added from that version onwards:

{| class="wikitable"
! style="text-align:left;"| Kodi Version
! Vorbis (.Flac)
! ID3v2 (.mp3)
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|}

== Data Kodi Scrapes ==
'''Artist'''
* Life span (Born, Died) - TADB/AM/MB
* Formed, Disbanded
* YearsActive - AM
* Genres - TADB/AM
* Moods - TADB/AM
* Styles - TADB/AM
* Instruments
* Biography - TADB
* Discography - TADB/AM/MB
* Thumb - fanart.tv/TADB/AM/HT
* Fanart - fanart.tv/TADB/HT

'''Album'''
* Genres
* Year
* Compilation
* Moods - TADB/AM
* Styles - TADB/AM
* Themes - TADB/AM
* Review (description) - TADB
* Thumb (cover) - fanart.tv/TADB/AM
* Label
* Rating - TADB/AM/MB

== NFO files ==
{{main|NFO files}}
Like with most metadata in XBMC, MusicBrainz tags can be added using [[NFO files]]. Both album.nfo and artist.nfo files can contain the MusicBrainz tag or simply contain a URL to the correct page on the MusicBrainz website, similar to how Movies can contain an IMDb URL NFO file.

== See also ==
=== Similar page names ===
{{#lst:MusicBrainz|similar pages}}

{{updated|16}}

[[Category:Music library]]
[[Category:Manual]]

Music tagging

2016-11-23T08:59:02Z

DaveBlake: /* Tags Kodi reads */

{{mininav| [[Music library]] }}

<section begin="intro" />

Starting in v16 "Jarvis", Kodi will ask the user who adds any file music source, if it should be loaded into the library.

We recommend you say yes to this prompt as the Kodi Music library has many extra features that help with music navigation, metadata and artwork retrieval.

Once the music is loaded in Kodi's library, you can start to organize and browse music in all kinds of awesome ways. We have chart views, artist, genre, and many other views. Starting from v15 "Helix" you can also create your own custom music nodes just like smart playlists. For example you can now create an A-Z artist view, or all music from the 2000's. See [[Music nodes]] for a guide.

<section end="intro" />
== Explanation of Music importing options ==

The first thing we need to do is go to System >> Settings >> Music >> Library

And look at the options available:

[[File:Music-Library-settings.jpg]]

'''Include Artists who appear only on compilation albums'''

Turning this option on will the artists lists will show many more artists than you would normally like to see, it will include all artists found on every track of the album rather than just the main album artist(s). An example could be an album by a band, with 1 track that has a collaboration with a rapper on 1 song. With it on the rapper would be listed, off only the band is shown. Unfortunately this option is poorly named, and has nothing to do with compilations. When you tag your music you can either set the album artist(s) or if all the songs in an album have the same artist that that is taken as the album artist. If all the songs in an album have different artists then the album artist is taken as "various artists". Basically you will normally want to turn this option off if you want a nice clean Artists view.

'''Fetch additional information during updates'''

This option will grab extra metadata and artwork for artists and albums from online sites (or local NFO files). Since we are a media centre and this kind of stuff is great, we recommend you turn this option on. It will download lots of things with scrapers such as artist biographies, moods, artist thumbnails, album artwork etc. However if you have a large music collection it can take some time, and you have to be confident that your files are well tagged first.

'''Prefer online information'''

This option will overide some of the artist and album data, that was initially derived from the tags in your song files, with information it finds online. The song files themselves are not changed in any way, just the data in the library. Providing that the scraper can uniquely identify the artist or album, this could be used to compensate for minimal tagging, but if you have tagged your music well it is better to let them take precedence, hence we recommend you switch it off normally. This makes it easy to tag your music files and know exactly how they will show up in Kodi. It also makes it easy to change data by simply editing the id3 tag.

'''Scraper selection'''

This option lets you choose a scraper to grab metadata such as artist biographies, and artwork such as pictures or artists. Kodi uses 2 scrapers here, one for the artist, and another for the albums. The difference being the album scraper is able to grab cover-art and album descriptions, genres and reviews. We recommend you stick with the universal scraper here, which will use the MusicBrainz API to search and a number of different sites such as Fanart.tv, TheAudioDB.com and Allmusic to grab the additional data. Since some of these sites are open, it is possible to add information to these sites and scrape the new data from them instantly.

== Tagging with MusicBrainz Picard ==

OK.. lets get one thing straight before we start. Kodi uses the Musicbrainz Artist and Album ID's to do all its metadata lookups. If you have these tags present in your music files then Kodi does not need to do a name search on your music which could introduce errors. This means that the chances of accurate artwork and metadata retrieval will be hugely increased. It also helps to avoid problems such as confusion over artists with the same name. Both Mp3tag and Picard tagging software that can add these tags. MusicBrainz Picard is thats what we are going to use in this example. Thankfully, once its installed it takes about 4 clicks to tag something perfectly as the tagger app is based on online lookups.

'''NOTE''': That's not to say the old method of tagging files(with software likehttp://www.mp3tag.de/en/ or MediaMonkey http://www.mediamonkey.com/) with accurate Artist and Album naming doesn't work. We just have a better way these days. Ultimately this method still uses the MusicBrainz ID to lookup metadata and artwork, you are just relying on the musicbrainz NameSearch API.

So with that said, lets look at how to tag an album in Picard to be loaded into Kodi.

Install (https://picard.musicbrainz.org/) then open Picard . Lets try to Auto Tag an Album:

1) Click the Add folder icon in the top left of the toolbar and select the folder the album is in.

2) Click the "Cluster" button (this brings all the files together so picard knows its a single album).

3) Now click "Lookup". You should now see the album on the right hand side box. (Picard has basically preformed an online search for your music on the MB site and selected what it thinks is the album)

4) Assuming its found the correct album, thats basically it. All you need to do is click save and Picard will save a whole wealth of new tags in your music.

Lets now look at those tags:

[[File:Picard1.jpg]]

Now lets click on a file that has 2 artists collaborating. In this case its track number 3

'''03-50_cent-patiently_waiting_ft._eminem.flac'''

[[File:Picard2.jpg]]

So this song has 2 artists "50 Cent" and "Eminem".

As you can see it has them listed in the ARTISTS tag.

This is very important as Kodi will now have 2 artists on the album and treat it as a compilation release.

[[File:Picard3.jpg]]

And if we look further down the list, we can see the release has lots of MBID's now that Kodi can use for online lookups.

That's basically it, picard makes music tagging incredibly easy and quick.

NOTE: Picard works by using drag and drop a lot. If it misidentifies a track or release, try dragging it onto a track to match it up. You can also right click on the album >> other verions. To select the correct release.

== Loading Music into Kodi Music Library==

Lets now add this folder as a source in Kodi and scan in it into the library.

Go to:

Kodi >> Music >> Files >> Add Music >> Select the album folder (or your music folder if you have many albums) >> Scan to library when prompted.

Assuming you have the options to search online for metadata enabled, Kodi will now scan the tags to populate the libarary, and then lookup and additional bits of artwork and metadata for artists and albums.

[[File:Kodimusicimport1.jpg]]

You can now browse the library by artist, album or via many different views.

[[File:Kodimusicimport2.jpg]]

All artwork, artist biographies and details are now loaded into kodi's library.

You can see the biography and additional details by selecting an artist in the Artists view, and hitting the info button ("i" on the keyboard).

[[File:Kodimusicimport3.jpg]]

You can even change your scraper settings to download the biography in many different languages.

== Tags Kodi reads ==

Kodi reads the following tags:

{| class="wikitable"
! style="text-align:left;"| Kodi Version
! Vorbis
! ID3v2
! APE
! MP4
! ASF
|-
|v16
|ARTIST
|TPE1
|ARTIST
|\251ART
|Author
|-
|v16
|ARTISTS
|ARTISTS
|ARTISTS
| ----:com.apple.iTunes:ARTISTS
|
|-
|v16
|ALBUMARTIST or ALBUM ARTIST
|TPE2 OR ALBUMARTIST or ALBUM ARTIST
|ALBUMARTIST or ALBUM ARTIST
|aART
|WM/AlbumArtist
|-
|v16
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
|ALBUMARTISTS or ALBUM ARTISTS
| ----:com.apple.iTunes:ALBUMARTISTS
|
|-
|v16
|ALBUM
|TALB
|ALBUM
|\251alb
|WM/AlbumTitle
|-
|v16
|TITLE
|TIT2
|TITLE
|\251nam
|
|-
|v16
|TRACKNUMBER
|TRCK
|TRACKNUMBER or TRACK
|trkn
|WM/TrackNumber or WM/Track
|-
|v16
|DISCNUMBER
|TPOS
|DISCNUMBER or DISC
|disk
|WM/PartOfSet
|-
|v16
|YEAR
|TYER
|YEAR
|\251day
|WM/Year
|-
|v16
|DATE
|TDRC, TDRL
|DATE
|
|
|-
|v16
|GENRE
|TCON
|GENRE
|\251gen
|WM/Genre
|-
|v16
|MOOD
|TMOO OR TXXX:MOOD
|MOOD
| ----:com.apple.iTunes:MOOD
|WM/Mood
|-
|v16
|COMMENT
|COMM
|COMMENT
|\251cmt
|(COMMENT)
|-
|v16
|CUESHEET
|
|CUESHEET
|
|
|-
|v16
|COMPILATION
|TCMP
|COMPILATION
|cpil
|
|-
|v16
|LYRICS
|USLT
|LYRICS
|
|
|-
|v16
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
|REPLAYGAIN_TRACK_GAIN
| ----:com.apple.iTunes:replaygain_track_gain
|replaygain_track_gain
|-
|v16
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
|REPLAYGAIN_ALBUM_GAIN
| ----:com.apple.iTunes:replaygain_album_gain
|replaygain_album_gain
|-
|v16
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
|REPLAYGAIN_TRACK_PEAK
| ----:com.apple.iTunes:replaygain_track_peak
|replaygain_track_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
|REPLAYGAIN_ALBUM_PEAK
| ----:com.apple.iTunes:replaygain_album_peak
|replaygain_album_peak
|-
|v16
|MUSICBRAINZ_ARTISTID
|MUSICBRAINZ ARTIST ID
|MUSICBRAINZ_ARTISTID
| ----:com.apple.iTunes:MusicBrainz Artist Id
|MusicBrainz/Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTISTID
|MUSICBRAINZ ALBUM ARTIST ID
|MUSICBRAINZ_ALBUMARTISTID
| ----:com.apple.iTunes:MusicBrainz Album Artist Id
|MusicBrainz/Album Artist Id
|-
|v16
|MUSICBRAINZ_ALBUMARTIST
|MUSICBRAINZ ALBUM ARTIST
|MUSICBRAINZ_ALBUMARTIST
| ----:com.apple.iTunes:MusicBrainz Album Artist
|MusicBrainz/Album Artist
|-
|v16
|MUSICBRAINZ_ALBUMID
|MUSICBRAINZ ALBUM ID
|MUSICBRAINZ_ALBUMID
| ----:com.apple.iTunes:MusicBrainz Album Id
|MusicBrainz/Album Id
|-
|v16
|MUSICBRAINZ_TRACKID
|UFID
|MUSICBRAINZ_TRACKID
| ----:com.apple.iTunes:MusicBrainz Track Id
|
|-
|v16
|RATING
|POPM
|
|
|
|-
|v16
|METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
|APIC
|
|covr
|WM/Picture
|-
|v17
|COMPOSER
|TCOM
|COMPOSER
|\251wrt
|WM/Composer
|-
|v17
|CONDUCTOR
|TPE3
|CONDUCTOR
| ----:com.apple.iTunes:CONDUCTOR
|WM/Conductor
|-
|v17
|LYRICIST
|TEXT
|LYRICIST
| ----:com.apple.iTunes:LYRICIST
|WM/Writer
|-
|v17
|REMIXER or MIXARTIST
|TPE4
|REMIXER or MIXARTIST
| ----:com.apple.iTunes:REMIXER
|WM/ModifiedBy
|-
|v17
|ENSEMBLE
|(TIPL) or TXXX:Ensemble
|ENSEMBLE
|
|
|-
|v17
|ARRANGER
|(TIPL)
|ARRANGER
|
|
|-
|v17
|ENGINEER
|(TIPL)
|ENGINEER
| ----:com.apple.iTunes:ENGINEER
|WM/Engineer
|-
|v17
|PRODUCER
|(TIPL)
|PRODUCER
| ----:com.apple.iTunes:PRODUCER
|WM/Producer
|-
|v17
|DJMIXER
|(TIPL)
|DJMIXER
| ----:com.apple.iTunes:DJMIXER
|WM/DJMixer
|-
|v17
|MIXER
|(TIPL)
|MIXER
| ----:com.apple.iTunes:MIXER
|WM/Mixer
|-
|v17
|PERFORMER
|TMCL
|PERFORMER
|
|
|
|-
|v17
|LABEL
|TPUB
|LABEL
| ----:com.apple.iTunes:LABEL
|WM/Publisher
|-
|v17
|RELEASETYPE
|MUSICBRAINZ ALBUM TYPE
|MUSICBRAINZ_ALBUMTYPE
| ---:com.apple.iTunes:MusicBrainz Album Type
|MusicBrainz/Album Type
|}

== Data Kodi Scrapes ==
'''Artist'''
* Life span (Born, Died) - TADB/AM/MB
* Formed, Disbanded
* YearsActive - AM
* Genres - TADB/AM
* Moods - TADB/AM
* Styles - TADB/AM
* Instruments
* Biography - TADB
* Discography - TADB/AM/MB
* Thumb - fanart.tv/TADB/AM/HT
* Fanart - fanart.tv/TADB/HT

'''Album'''
* Genres
* Year
* Compilation
* Moods - TADB/AM
* Styles - TADB/AM
* Themes - TADB/AM
* Review (description) - TADB
* Thumb (cover) - fanart.tv/TADB/AM
* Label
* Rating - TADB/AM/MB

== NFO files ==
{{main|NFO files}}
Like with most metadata in XBMC, MusicBrainz tags can be added using [[NFO files]]. Both album.nfo and artist.nfo files can contain the MusicBrainz tag or simply contain a URL to the correct page on the MusicBrainz website, similar to how Movies can contain an IMDb URL NFO file.

== See also ==
=== Similar page names ===
{{#lst:MusicBrainz|similar pages}}

{{updated|16}}

[[Category:Music library]]
[[Category:Manual]]