Official Kodi Wiki - User contributions [en]

Artwork/Cache

2025-05-18T17:14:22Z

Rmrector: /* Texture optimization */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | [[Artwork]] }}

= Introduction =
<section begin="intro" />{{Kodi}} maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When media is added to the library, {{Kodi}} initially only has a URL or path to the artwork. The artwork itself is downloaded (if from an online source) and then cached.<section end="intro" />

All images that {{Kodi}} loads, with the exception of textures that are provided directly by the skin, are cached to the userdata/Thumbnails folder.<br />

'''Note:''' It is not possible to disable the artwork cache and operate exclusively from locally saved artwork as described in the related artwork pages.

= Artwork for library items =
The artwork URLs associated with library items are stored in the art table inside the video or music databases. These store the original URL to the artwork (e.g. from local artwork files or from web sources such as https://themoviedb.org, https://thetvdb.com, or https://theaudiodb.com). This means that central databases store where the art is obtained from, and multiple devices then just keep a local thumbnail cache as described below.

= The caching procedure =
The caching procedure utilizes an optimized copy of the original image saved in .jpg or .png format and an SQL database that maintains the local cache.

The cache operates primarily on an "as and when needed" basis; i.e. textures are cached when they're first requested for display in a skin or web interface. In some cases textures may be cached before they're immediately needed, such as thumbnails generated from video files. In either case, the main caching procedure starts with an image URL. It caches as follows:

# {{Kodi}} generates a hash (CRC) of the URL, like "6a643bff".
# The texture is optimized (see [[#Texture optimization]]) and cached to a device-local file with the given URL hash. It is cached as a PNG if transparency is required and JPG otherwise.
# For local files, another hash of the image is generated based on size and modified date, which can be used to check if the original image has changed.
# These details are stored in the SQL database Textures.db, along with information on when the image was cached.

= Loading textures =
When loading a texture for display in a skin or web interface, {{Kodi}} basically just has a URL to the image. Given a particular URL, it loads the texture as follows:

# If the image is provided by the skin, skip to step 5.
# If the URL is directly to a cached version of a texture in the cache, skip to step 5.
# If the URL is for an image already cached in the thumbnail cache, swap the URL to the cached version and skip to step 5.
# Cache the image as outlined in the section above.
# Load the image. If the image is provided by the skin, skip steps 6 and 7.
# The access time for this texture is saved in the texture database.
# If the image is not from a web service (HTTP/S) and at least 24 hours have passed since it was last loaded, check the hash generated in step 3 of "The caching procedure" for changes to the image. If the hash has changed, cache the new image as outlined in the section above.

= Texture optimization =
# Cached images are limited to a maximum pixel dimension to fit in a 16:9 box, with a default configuration of 1920x1080 for images that are 16:9 (like fanart) and larger than this, and 1280x720 for all other images. This can be changed with '''[[Advancedsettings.xml#Library artwork| advancedsettings.xml]]'''.
#* Before Kodi 22, images in the GUI looked best by configuring this at or somewhat smaller than images are displayed by your skin and device. Additionally due to final scaling algorithm, a slightly larger image than the display area will look notably worse than a slightly smaller image.
#* If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or your {{Kodi}} device has minimal storage available, these defaults can be lowered to noticeably reduce the cost of artwork. For higher powered equipment these settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
# Images are re-encoded in a decoder-friendly way so that the image can be displayed as quickly as possible.

This optimized image is exported with {{Kodi}}'s '''[[Import-export_library|Library Export]]''' feature, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible.<ref>https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318</ref>

= Automatic cache cleaning =
{{Kodi}} 22 adds an automatic process to clean out unused images over time - images not associated with an item in the media library nor viewed within the last 30 days. There is also an option in [[Settings/Media/Library]] to immediately remove all such images at once.

= Advanced: How to refresh the cached image of an icon manually =
The [[Texture Cache Maintenance utility]] can do this in a safer way, but this is the manual option.
There is an image like ''/home/x/.kodi/addons/my.lovely.addon/icon.png'' . After changing that file, the old image is still visible in {{kodi}}. To solve this we need to remove the actual thumbnail file from the filesystem and its reference in the DB:

# Get the thumbnail path to remove the file from the filesystem
$ sqlite3 .kodi/userdata/Database/Textures13.db "SELECT cachedurl FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"
6/6a643bff.png

This ''6/6a643bff.png'' is the cached image under ''/home/x/.kodi/userdata/Thumbnails''. So: you need to remove from your filesystem ''/home/x/.kodi/userdata/Thumbnails/6/6a43bff.png''

# Remove the image->cached image link in the DB
$ sqlite3 .kodi/userdata/Database/Textures13.db "DELETE FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"

Next time Kodi needs the image, it will recreate the thumbnail.

:{{note|The <code>"Textures'''13'''.db"</code> '''[[Databases#Database_Versions|number/version can increase]]''' with later Kodi versions.}}

'''''See also: [[Databases#Database_Versions|Database Versions]]'''''

= Advanced: delete textures13.db =
This last resort procedure is one sure way to repair any image caching problem: delete the ''Textures13.db'' database and the thumbnail directory. This procedure does not affect the entries in the Video and Music libraries, so Kodi will not find more images after, this is just a brute-force solution to a caching problem. It affects the artwork database only. [[Texture Cache Maintenance utility]] can do very targeted fixes of the texture cache, so consider it before doing this.

'''Note'''
#Be aware that this should be a last resort procedure. Deleting this database file and the thumbnail directory will remove all cache entries and links, requiring remote URLs to web services to be downloaded again.
#As the URL link to the original artwork location is stored in the video or music databases, Kodi will use the existing URLs to rebuild the Texture database and thumbnail cache, rather than finding new images locally or from a scraper.
#{{red|Using this procedure, you cannot change the scraping location for artwork. ie- If you originally scraped from online sources, you cannot expect that Kodi will now scrape from your newly added local artwork and vice-versa. It will retrieve artwork from the same source as it was before, so the result will be the same image. To bulk change artwork, refer to ''[[Artwork#Importing-Scraping Artwork| Importing-Scraping Artwork]]''}}<br /><br />

You will need to perform the following for a clean start with respect to the artwork texture cache.
#Exit Kodi
#Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
#Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
Once the above steps are performed
#Restart Kodi
#Kodi will automatically rebuild the Textures database and repopulate the Thumbnails cache as the images are displayed in the GUI or other Kodi interface.

{{warning|Artwork links must be considered as a perishable item. Scraper sites frequently purge thousands of images. As a result, performing this advanced method may result in many images no longer displaying as they are no longer available at the scraper sites.}}

= Cache manipulation tools =
* [[Texture Cache Maintenance utility]]
** {{#lst:Texture_Cache_Maintenance_utility|intro}}

= Kodi version updates =
<section begin="CacheMaxResolution" />From v18, the 1920x1080 resolution limitation has been removed. Using the following code in your advancedsettings.xml will allow caching artwork at original size. <ref>https://github.com/xbmc/xbmc/pull/13599</ref>

<syntaxhighlight lang="xml">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>
<section end="CacheMaxResolution" />

= References =
<references />

{{Top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Artwork/Cache

2024-07-20T00:39:07Z

Rmrector: /* Automatic cache cleaner */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | [[Artwork]] }}

= Introduction =
<section begin="intro" />{{Kodi}} maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When media is added to the library, {{Kodi}} initially only has a URL or path to the artwork. The artwork itself is downloaded (if from an online source) and then cached.<section end="intro" />

All images that {{Kodi}} loads, with the exception of textures that are provided directly by the skin, are cached to the userdata/Thumbnails folder.<br />

'''Note:''' It is not possible to disable the artwork cache and operate exclusively from locally saved artwork as described in the related artwork pages.

= Artwork for library items =
The artwork URLs associated with library items are stored in the art table inside the video or music databases. These store the original URL to the artwork (e.g. from local artwork files or from web sources such as https://themoviedb.org, https://thetvdb.com, or https://theaudiodb.com). This means that central databases store where the art is obtained from, and multiple devices then just keep a local thumbnail cache as described below.

= The caching procedure =
The caching procedure utilizes an optimized copy of the original image saved in .jpg or .png format and an SQL database that maintains the local cache.

The cache operates primarily on an "as and when needed" basis; i.e. textures are cached when they're first requested for display in a skin or web interface. In some cases textures may be cached before they're immediately needed, such as thumbnails generated from video files. In either case, the main caching procedure starts with an image URL. It caches as follows:

# {{Kodi}} generates a hash (CRC) of the URL, like "6a643bff".
# The texture is optimized (see [[#Texture optimization]]) and cached to a device-local file with the given URL hash. It is cached as a PNG if transparency is required and JPG otherwise.
# For local files, another hash of the image is generated based on size and modified date, which can be used to check if the original image has changed.
# These details are stored in the SQL database Textures.db, along with information on when the image was cached.

= Loading textures =
When loading a texture for display in a skin or web interface, {{Kodi}} basically just has a URL to the image. Given a particular URL, it loads the texture as follows:

# If the image is provided by the skin, skip to step 5.
# If the URL is directly to a cached version of a texture in the cache, skip to step 5.
# If the URL is for an image already cached in the thumbnail cache, swap the URL to the cached version and skip to step 5.
# Cache the image as outlined in the section above.
# Load the image. If the image is provided by the skin, skip steps 6 and 7.
# The access time for this texture is saved in the texture database.
# If the image is not from a web service (HTTP/S) and at least 24 hours have passed since it was last loaded, check the hash generated in step 3 of "The caching procedure" for changes to the image. If the hash has changed, cache the new image as outlined in the section above.

= Texture optimization =
# Images are limited to a maximum pixel dimension to fit in a 16:9 box, with a default configuration of 1920x1080 for images that are 16:9 (like fanart) and larger than this, and 1280x720 for all other images. This can be changed with '''[[Advancedsettings.xml#Library artwork| advancedsettings.xml]]'''.
#* Images in the GUI will look best by configuring this at or somewhat smaller than images are displayed by your skin and device. Additionally due to final scaling algorithm, a slightly larger image than the display area will look notably worse than a slightly smaller image.
#* If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or your {{Kodi}} device has minimal storage available, these defaults can be lowered to noticeably reduce the cost of artwork. For higher powered equipment these settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
# Images are re-encoded in a decoder-friendly way so that the image can be displayed as quickly as possible.

This optimized image is exported with {{Kodi}}'s '''[[Import-export_library|Library Export]]''' feature, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible.<ref>https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318</ref>

= Automatic cache cleaning =
{{Kodi}} 22 adds an automatic process to clean out unused images over time - images not associated with an item in the media library nor viewed within the last 30 days. There is also an option in [[Settings/Media/Library]] to immediately remove all such images at once.

= Advanced: How to refresh the cached image of an icon manually =
The [[Texture Cache Maintenance utility]] can do this in a safer way, but this is the manual option.
There is an image like ''/home/x/.kodi/addons/my.lovely.addon/icon.png'' . After changing that file, the old image is still visible in {{kodi}}. To solve this we need to remove the actual thumbnail file from the filesystem and its reference in the DB:

# Get the thumbnail path to remove the file from the filesystem
$ sqlite3 .kodi/userdata/Database/Textures13.db "SELECT cachedurl FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"
6/6a643bff.png

This ''6/6a643bff.png'' is the cached image under ''/home/x/.kodi/userdata/Thumbnails''. So: you need to remove from your filesystem ''/home/x/.kodi/userdata/Thumbnails/6/6a43bff.png''

# Remove the image->cached image link in the DB
$ sqlite3 .kodi/userdata/Database/Textures13.db "DELETE FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"

Next time Kodi needs the image, it will recreate the thumbnail.

:{{note|The <code>"Textures'''13'''.db"</code> '''[[Databases#Database_Versions|number/version can increase]]''' with later Kodi versions.}}

'''''See also: [[Databases#Database_Versions|Database Versions]]'''''

= Advanced: delete textures13.db =
This last resort procedure is one sure way to repair any image caching problem: delete the ''Textures13.db'' database and the thumbnail directory. This procedure does not affect the entries in the Video and Music libraries, so Kodi will not find more images after, this is just a brute-force solution to a caching problem. It affects the artwork database only. [[Texture Cache Maintenance utility]] can do very targeted fixes of the texture cache, so consider it before doing this.

'''Note'''
#Be aware that this should be a last resort procedure. Deleting this database file and the thumbnail directory will remove all cache entries and links, requiring remote URLs to web services to be downloaded again.
#As the URL link to the original artwork location is stored in the video or music databases, Kodi will use the existing URLs to rebuild the Texture database and thumbnail cache, rather than finding new images locally or from a scraper.
#{{red|Using this procedure, you cannot change the scraping location for artwork. ie- If you originally scraped from online sources, you cannot expect that Kodi will now scrape from your newly added local artwork and vice-versa. It will retrieve artwork from the same source as it was before, so the result will be the same image. To bulk change artwork, refer to ''[[Artwork#Importing-Scraping Artwork| Importing-Scraping Artwork]]''}}<br /><br />

You will need to perform the following for a clean start with respect to the artwork texture cache.
#Exit Kodi
#Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
#Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
Once the above steps are performed
#Restart Kodi
#Kodi will automatically rebuild the Textures database and repopulate the Thumbnails cache as the images are displayed in the GUI or other Kodi interface.

{{warning|Artwork links must be considered as a perishable item. Scraper sites frequently purge thousands of images. As a result, performing this advanced method may result in many images no longer displaying as they are no longer available at the scraper sites.}}

= Cache manipulation tools =
* [[Texture Cache Maintenance utility]]
** {{#lst:Texture_Cache_Maintenance_utility|intro}}

= Kodi version updates =
<section begin="CacheMaxResolution" />From v18, the 1920x1080 resolution limitation has been removed. Using the following code in your advancedsettings.xml will allow caching artwork at original size. <ref>https://github.com/xbmc/xbmc/pull/13599</ref>

<syntaxhighlight lang="xml">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>
<section end="CacheMaxResolution" />

= References =
<references />

{{Top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Artwork/Cache

2024-07-20T00:38:31Z

Rmrector: /* Texture optimization */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | [[Artwork]] }}

= Introduction =
<section begin="intro" />{{Kodi}} maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When media is added to the library, {{Kodi}} initially only has a URL or path to the artwork. The artwork itself is downloaded (if from an online source) and then cached.<section end="intro" />

All images that {{Kodi}} loads, with the exception of textures that are provided directly by the skin, are cached to the userdata/Thumbnails folder.<br />

'''Note:''' It is not possible to disable the artwork cache and operate exclusively from locally saved artwork as described in the related artwork pages.

= Artwork for library items =
The artwork URLs associated with library items are stored in the art table inside the video or music databases. These store the original URL to the artwork (e.g. from local artwork files or from web sources such as https://themoviedb.org, https://thetvdb.com, or https://theaudiodb.com). This means that central databases store where the art is obtained from, and multiple devices then just keep a local thumbnail cache as described below.

= The caching procedure =
The caching procedure utilizes an optimized copy of the original image saved in .jpg or .png format and an SQL database that maintains the local cache.

The cache operates primarily on an "as and when needed" basis; i.e. textures are cached when they're first requested for display in a skin or web interface. In some cases textures may be cached before they're immediately needed, such as thumbnails generated from video files. In either case, the main caching procedure starts with an image URL. It caches as follows:

# {{Kodi}} generates a hash (CRC) of the URL, like "6a643bff".
# The texture is optimized (see [[#Texture optimization]]) and cached to a device-local file with the given URL hash. It is cached as a PNG if transparency is required and JPG otherwise.
# For local files, another hash of the image is generated based on size and modified date, which can be used to check if the original image has changed.
# These details are stored in the SQL database Textures.db, along with information on when the image was cached.

= Loading textures =
When loading a texture for display in a skin or web interface, {{Kodi}} basically just has a URL to the image. Given a particular URL, it loads the texture as follows:

# If the image is provided by the skin, skip to step 5.
# If the URL is directly to a cached version of a texture in the cache, skip to step 5.
# If the URL is for an image already cached in the thumbnail cache, swap the URL to the cached version and skip to step 5.
# Cache the image as outlined in the section above.
# Load the image. If the image is provided by the skin, skip steps 6 and 7.
# The access time for this texture is saved in the texture database.
# If the image is not from a web service (HTTP/S) and at least 24 hours have passed since it was last loaded, check the hash generated in step 3 of "The caching procedure" for changes to the image. If the hash has changed, cache the new image as outlined in the section above.

= Texture optimization =
# Images are limited to a maximum pixel dimension to fit in a 16:9 box, with a default configuration of 1920x1080 for images that are 16:9 (like fanart) and larger than this, and 1280x720 for all other images. This can be changed with '''[[Advancedsettings.xml#Library artwork| advancedsettings.xml]]'''.
#* Images in the GUI will look best by configuring this at or somewhat smaller than images are displayed by your skin and device. Additionally due to final scaling algorithm, a slightly larger image than the display area will look notably worse than a slightly smaller image.
#* If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or your {{Kodi}} device has minimal storage available, these defaults can be lowered to noticeably reduce the cost of artwork. For higher powered equipment these settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
# Images are re-encoded in a decoder-friendly way so that the image can be displayed as quickly as possible.

This optimized image is exported with {{Kodi}}'s '''[[Import-export_library|Library Export]]''' feature, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible.<ref>https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318</ref>

= Automatic cache cleaner =
{{Kodi}} 22 adds an automatic process to clean out unused images over time - images not associated with an item in the media library nor viewed within the last 30 days. There is also an option in [[Settings/Media/Library]] to immediately remove all such images at once.

= Advanced: How to refresh the cached image of an icon manually =
The [[Texture Cache Maintenance utility]] can do this in a safer way, but this is the manual option.
There is an image like ''/home/x/.kodi/addons/my.lovely.addon/icon.png'' . After changing that file, the old image is still visible in {{kodi}}. To solve this we need to remove the actual thumbnail file from the filesystem and its reference in the DB:

# Get the thumbnail path to remove the file from the filesystem
$ sqlite3 .kodi/userdata/Database/Textures13.db "SELECT cachedurl FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"
6/6a643bff.png

This ''6/6a643bff.png'' is the cached image under ''/home/x/.kodi/userdata/Thumbnails''. So: you need to remove from your filesystem ''/home/x/.kodi/userdata/Thumbnails/6/6a43bff.png''

# Remove the image->cached image link in the DB
$ sqlite3 .kodi/userdata/Database/Textures13.db "DELETE FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"

Next time Kodi needs the image, it will recreate the thumbnail.

:{{note|The <code>"Textures'''13'''.db"</code> '''[[Databases#Database_Versions|number/version can increase]]''' with later Kodi versions.}}

'''''See also: [[Databases#Database_Versions|Database Versions]]'''''

= Advanced: delete textures13.db =
This last resort procedure is one sure way to repair any image caching problem: delete the ''Textures13.db'' database and the thumbnail directory. This procedure does not affect the entries in the Video and Music libraries, so Kodi will not find more images after, this is just a brute-force solution to a caching problem. It affects the artwork database only. [[Texture Cache Maintenance utility]] can do very targeted fixes of the texture cache, so consider it before doing this.

'''Note'''
#Be aware that this should be a last resort procedure. Deleting this database file and the thumbnail directory will remove all cache entries and links, requiring remote URLs to web services to be downloaded again.
#As the URL link to the original artwork location is stored in the video or music databases, Kodi will use the existing URLs to rebuild the Texture database and thumbnail cache, rather than finding new images locally or from a scraper.
#{{red|Using this procedure, you cannot change the scraping location for artwork. ie- If you originally scraped from online sources, you cannot expect that Kodi will now scrape from your newly added local artwork and vice-versa. It will retrieve artwork from the same source as it was before, so the result will be the same image. To bulk change artwork, refer to ''[[Artwork#Importing-Scraping Artwork| Importing-Scraping Artwork]]''}}<br /><br />

You will need to perform the following for a clean start with respect to the artwork texture cache.
#Exit Kodi
#Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
#Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
Once the above steps are performed
#Restart Kodi
#Kodi will automatically rebuild the Textures database and repopulate the Thumbnails cache as the images are displayed in the GUI or other Kodi interface.

{{warning|Artwork links must be considered as a perishable item. Scraper sites frequently purge thousands of images. As a result, performing this advanced method may result in many images no longer displaying as they are no longer available at the scraper sites.}}

= Cache manipulation tools =
* [[Texture Cache Maintenance utility]]
** {{#lst:Texture_Cache_Maintenance_utility|intro}}

= Kodi version updates =
<section begin="CacheMaxResolution" />From v18, the 1920x1080 resolution limitation has been removed. Using the following code in your advancedsettings.xml will allow caching artwork at original size. <ref>https://github.com/xbmc/xbmc/pull/13599</ref>

<syntaxhighlight lang="xml">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>
<section end="CacheMaxResolution" />

= References =
<references />

{{Top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Artwork/Cache

2024-04-14T22:51:18Z

Rmrector: /* Texture optimization */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | [[Artwork]] }}

= Introduction =
<section begin="intro" />{{Kodi}} maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When media is added to the library, {{Kodi}} initially only has a URL or path to the artwork. The artwork itself is downloaded (if from an online source) and then cached.<section end="intro" />

All images that {{Kodi}} loads, with the exception of textures that are provided directly by the skin, are cached to the userdata/Thumbnails folder.<br />

'''Note:''' It is not possible to disable the artwork cache and operate exclusively from locally saved artwork as described in the related artwork pages.

= Artwork for library items =
The artwork URLs associated with library items are stored in the art table inside the video or music databases. These store the original URL to the artwork (e.g. from local artwork files or from web sources such as https://themoviedb.org, https://thetvdb.com, or https://theaudiodb.com). This means that central databases store where the art is obtained from, and multiple devices then just keep a local thumbnail cache as described below.

= The caching procedure =
The caching procedure utilizes an optimized copy of the original image saved in .jpg or .png format and an SQL database that maintains the local cache.

The cache operates primarily on an "as and when needed" basis; i.e. textures are cached when they're first requested for display in a skin or web interface. In some cases textures may be cached before they're immediately needed, such as thumbnails generated from video files. In either case, the main caching procedure starts with an image URL. It caches as follows:

# {{Kodi}} generates a hash (CRC) of the URL, like "6a643bff".
# The texture is optimized (see [[#Texture optimization]]) and cached to a device-local file with the given URL hash. It is cached as a PNG if transparency is required and JPG otherwise.
# For local files, another hash of the image is generated based on size and modified date, which can be used to check if the original image has changed.
# These details are stored in the SQL database Textures.db, along with information on when the image was cached.

= Loading textures =
When loading a texture for display in a skin or web interface, {{Kodi}} basically just has a URL to the image. Given a particular URL, it loads the texture as follows:

# If the image is provided by the skin, skip to step 5.
# If the URL is directly to a cached version of a texture in the cache, skip to step 5.
# If the URL is for an image already cached in the thumbnail cache, swap the URL to the cached version and skip to step 5.
# Cache the image as outlined in the section above.
# Load the image. If the image is provided by the skin, skip steps 6 and 7.
# The access time for this texture is saved in the texture database.
# If the image is not from a web service (HTTP/S) and at least 24 hours have passed since it was last loaded, check the hash generated in step 3 of "The caching procedure" for changes to the image. If the hash has changed, cache the new image as outlined in the section above.

= Texture optimization =
# Images are limited to a maximum pixel dimension to fit in a 16:9 box, with a default configuration of 1920x1080 for images that are 16:9 (like fanart) and larger than this, and 1280x720 for all other images. This can be changed with '''[[Advancedsettings.xml#Library artwork| advancedsettings.xml]]'''.
#* Images in the GUI will look best by configuring this at or somewhat smaller than images are displayed by your skin and device. Additionally due to final scaling algorithm, a slightly larger image than the display area will look notably worse than a slightly smaller image.
#* If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or your {{Kodi}} device has minimal storage available, these defaults can be lowered to noticeably reduce the cost of artwork. For higher powered equipment these settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
# Images are re-encoded in a decoder-friendly way so that the image can be displayed as quickly as possible.

This optimized image is exported with {{Kodi}}'s '''[[Import-export_library|Library Export]]''' feature, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible.<ref>https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318</ref>

= Advanced: How to refresh the cached image of an icon manually =
The [[Texture Cache Maintenance utility]] can do this in a safer way, but this is the manual option.
There is an image like ''/home/x/.kodi/addons/my.lovely.addon/icon.png'' . After changing that file, the old image is still visible in {{kodi}}. To solve this we need to remove the actual thumbnail file from the filesystem and its reference in the DB:

# Get the thumbnail path to remove the file from the filesystem
$ sqlite3 .kodi/userdata/Database/Textures13.db "SELECT cachedurl FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"
6/6a643bff.png

This ''6/6a643bff.png'' is the cached image under ''/home/x/.kodi/userdata/Thumbnails''. So: you need to remove from your filesystem ''/home/x/.kodi/userdata/Thumbnails/6/6a43bff.png''

# Remove the image->cached image link in the DB
$ sqlite3 .kodi/userdata/Database/Textures13.db "DELETE FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"

Next time Kodi needs the image, it will recreate the thumbnail.

:{{note|The <code>"Textures'''13'''.db"</code> '''[[Databases#Database_Versions|number/version can increase]]''' with later Kodi versions.}}

'''''See also: [[Databases#Database_Versions|Database Versions]]'''''

= Advanced: delete textures13.db =
This last resort procedure is one sure way to repair any image caching problem: delete the ''Textures13.db'' database and the thumbnail directory. This procedure does not affect the entries in the Video and Music libraries, so Kodi will not find more images after, this is just a brute-force solution to a caching problem. It affects the artwork database only. [[Texture Cache Maintenance utility]] can do very targeted fixes of the texture cache, so consider it before doing this.

'''Note'''
#Be aware that this should be a last resort procedure. Deleting this database file and the thumbnail directory will remove all cache entries and links, requiring remote URLs to web services to be downloaded again.
#As the URL link to the original artwork location is stored in the video or music databases, Kodi will use the existing URLs to rebuild the Texture database and thumbnail cache, rather than finding new images locally or from a scraper.
#{{red|Using this procedure, you cannot change the scraping location for artwork. ie- If you originally scraped from online sources, you cannot expect that Kodi will now scrape from your newly added local artwork and vice-versa. It will retrieve artwork from the same source as it was before, so the result will be the same image. To bulk change artwork, refer to ''[[Artwork#Importing-Scraping Artwork| Importing-Scraping Artwork]]''}}<br /><br />

You will need to perform the following for a clean start with respect to the artwork texture cache.
#Exit Kodi
#Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
#Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
Once the above steps are performed
#Restart Kodi
#Kodi will automatically rebuild the Textures database and repopulate the Thumbnails cache as the images are displayed in the GUI or other Kodi interface.

{{warning|Artwork links must be considered as a perishable item. Scraper sites frequently purge thousands of images. As a result, performing this advanced method may result in many images no longer displaying as they are no longer available at the scraper sites.}}

= Cache manipulation tools =
* [[Texture Cache Maintenance utility]]
** {{#lst:Texture_Cache_Maintenance_utility|intro}}

= Kodi version updates =
<section begin="CacheMaxResolution" />From v18, the 1920x1080 resolution limitation has been removed. Using the following code in your advancedsettings.xml will allow caching artwork at original size. <ref>https://github.com/xbmc/xbmc/pull/13599</ref>

<syntaxhighlight lang="xml">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>
<section end="CacheMaxResolution" />

= References =
<references />

{{Top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Artwork/Accessing with skins and JSON-RPC

2024-01-26T19:11:28Z

Rmrector: /* Kodi-encoded URL */ adjust example to match

{{Artwork_Contents}}
{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =
Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are: <code>Player.Art(poster)</code>, <code>Player.Art(fanart)</code>, <code>ListItem.Art(banner)</code>, <code>ListItem.Art(tvshow.clearlogo)</code>.

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==
There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =
Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==
Example request:
<syntaxhighlight lang="json">
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}
</syntaxhighlight>

and a possible response:
<syntaxhighlight lang="json">
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}
</syntaxhighlight>

== Kodi-encoded URL ==
The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "image/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/image/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/image/image%3A%2F%2Fnfs%253a%252f%252fSERVER%252fmedia%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =
For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|- valign="top"
| album.thumb
| ListItem.Art(thumb)
| Thumb of the currently focused media item. This has some notable fallback behavior in the video library. It will be the artwork type named exactly "thumb" if it exists for the current item, but will fall back to "poster" then "banner" if not.
|}

= {{Kodi}} version updates =

* {{Kodi}} 17 and before in the '''music library''' 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. The video library has had this level of support for some time.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.
* {{Kodi}} 19 moves that configuration to the '''[[Settings/Media/Videos#Artwork| Settings UI]]'''.

{{Top}}

{{updated|20}}
[[Category:Development]]
[[Category:Skin_development]]

Artwork/Accessing with skins and JSON-RPC

2024-01-26T18:05:54Z

Rmrector: format initial examples and small adjust JSON-RPC result example

{{Artwork_Contents}}
{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =
Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are: <code>Player.Art(poster)</code>, <code>Player.Art(fanart)</code>, <code>ListItem.Art(banner)</code>, <code>ListItem.Art(tvshow.clearlogo)</code>.

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==
There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =
Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==
Example request:
<syntaxhighlight lang="json">
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}
</syntaxhighlight>

and a possible response:
<syntaxhighlight lang="json">
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fSERVER%2fmedia%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}
</syntaxhighlight>

== Kodi-encoded URL ==
The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "image/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/image/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/image/image%3A%2F%2Fnfs%253a%252f%252fCUBER%252fmedia%252fpreserved%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =
For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|- valign="top"
| album.thumb
| ListItem.Art(thumb)
| Thumb of the currently focused media item. This has some notable fallback behavior in the video library. It will be the artwork type named exactly "thumb" if it exists for the current item, but will fall back to "poster" then "banner" if not.
|}

= {{Kodi}} version updates =

* {{Kodi}} 17 and before in the '''music library''' 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. The video library has had this level of support for some time.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.
* {{Kodi}} 19 moves that configuration to the '''[[Settings/Media/Videos#Artwork| Settings UI]]'''.

{{Top}}

{{updated|20}}
[[Category:Development]]
[[Category:Skin_development]]

Advancedsettings.xml

2023-02-11T19:39:26Z

Rmrector: remove video library extra artwork

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

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

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

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

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

== Layout ==

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

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

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

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

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

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

== Troubleshooting settings ==

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

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

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

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

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

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

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

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

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

== Audio/video playback settings ==

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

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

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

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

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

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

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

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

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

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

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

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

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

<ac3downmixgain>12.0</ac3downmixgain>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>
</audio>
</syntaxhighlight>

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

Default: Off

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

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

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

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

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

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

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

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

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

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

== Video library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains Regular Expression syntax to match the locally stored trailers to movies in the library.

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

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

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

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

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

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

== Library artwork ==

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

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

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

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

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

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

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

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

[https://github.com/xbmc/xbmc/blob/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>

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

== Video and music library settings ==

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

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

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

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

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

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

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

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

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

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

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

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

'''Parent tags:'''

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

'''Child tags: '''

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

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

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

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

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

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

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

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

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

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

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

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

'''Examples:'''

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

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

<section end="videodatabase" />

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

== Music settings ==

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

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

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

<section end="musicextensions" />

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

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

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

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

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

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

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

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


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

== Photos settings ==

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

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

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

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

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

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



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

== Network settings ==

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

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

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

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

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

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

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

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

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

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

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

== File system settings ==

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

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

Default: False

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

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

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

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

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

Default: No path substitutions defined.

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

== Input control settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

== Other interface settings ==

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

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

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

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

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

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

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

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

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

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

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

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

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

=== smartredraw ===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

= 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]]

Artwork/Accessing with skins and JSON-RPC

2023-02-04T18:36:39Z

Rmrector: link to settings for Kodi 19+

{{Artwork_Contents}}
{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =
Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are:
<syntaxhighlight lang="json">
{{code|Player.Art(poster)}}
{{code|Player.Art(fanart)}}
{{code|ListItem.Art(banner)}}
{{code|ListItem.Art(tvshow.clearlogo)}}
</syntaxhighlight>

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==
There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =
Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==
Example request:
<syntaxhighlight lang="json">
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}
</syntaxhighlight>

and a possible response:
<syntaxhighlight lang="json">
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}
</syntaxhighlight>

== Kodi-encoded URL ==
The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "image/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/image/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/image/image%3A%2F%2Fnfs%253a%252f%252fCUBER%252fmedia%252fpreserved%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =
For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|- valign="top"
| album.thumb
| ListItem.Art(thumb)
| Thumb of the currently focused media item. This has some notable fallback behavior in the video library. It will be the artwork type named exactly "thumb" if it exists for the current item, but will fall back to "poster" then "banner" if not.
|}

= {{Kodi}} version updates =

* The '''music library''' in {{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. The video library has had this level of support for some time now.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.
* {{Kodi}} 19 moves that configuration to the '''[[Settings/Media/Videos#Artwork| Settings UI]]'''.

{{Top}}

{{updated|18}}
[[Category:Development]]

Artwork/Cache

2021-01-24T18:15:53Z

Rmrector: /* The caching procedure */ only local files are checked for changes

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | [[Artwork]] }}

<section begin="intro" />{{Kodi}} maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When artwork is added to the library, {{Kodi}} initially only has a URL or path to the artwork. The artwork itself is only downloaded (if from an online source) and then cached when the image is displayed in the GUI or other interface such as the Chorus web interface.<section end="intro" />

All images that {{Kodi}} loads, with the exception of textures that are provided directly by the skin, are cached to the userdata/Thumbnails folder.<br />

= Artwork for library items =
The artwork URLs associated with library items are stored in the art table inside the video or music databases. These store the original URL to the artwork (e.g. from local artwork files or from web sources such as https://themoviedb.org, https://thetvdb.com, or https://theaudiodb.com). This means that central databases store where the art is obtained from, and multiple devices then just keep a local thumbnail cache as described below.

= The caching procedure =
The caching procedure utilizes an optimized copy of the original image saved in .jpg or .png format and an SQL database that maintains the local cache.

The cache operates primarily on an "as and when needed" basis; i.e. textures are cached when they're first requested for display in a skin or web interface. In some cases textures may be cached before they're immediately needed, such as thumbnails generated from video files. In either case, the main caching procedure starts with an image URL. It caches as follows:

# {{Kodi}} generates a hash (CRC) of the URL, like "6a643bff".
# The texture is optimized (see [[#Texture optimization]]) and cached to a device-local file with the given URL hash. It is cached as a PNG if transparency is required and JPG otherwise.
# For local files, another hash of the image is generated based on size and modified date, which can be used to check if the original image has changed.
# These details are stored in the SQL database Textures.db, along with information on when the image was cached.

= Loading textures =
When loading a texture for display in a skin or web interface, {{Kodi}} basically just has a URL to the image. Given a particular URL, it loads the texture as follows:

# If the image is provided by the skin, skip to step 5.
# If the URL is directly to a cached version of a texture in the cache, skip to step 5.
# If the URL is for an image already cached in the thumbnail cache, swap the URL to the cached version and skip to step 5.
# Cache the image as outlined in the section above.
# Load the image. If the image is provided by the skin, skip steps 6 and 7.
# The access time for this texture is saved in the texture database.
# If the image is not from a web service (HTTP/S) and at least 24 hours have passed since it was last loaded, check the hash generated in step 3 of "The caching procedure" for changes to the image. If the hash has changed, cache the new image as outlined in the section above.

= Texture optimization =
# Images are limited to a maximum pixel dimension to fit in a 16:9 box, with a default configuration of 1920x1080 for images that are 16:9 (like fanart) and larger than this, and 1280x720 for all other images. This can be changed with ''[[Advancedsettings.xml#Library artwork| advancedsettings.xml]]''.
#* If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or your {{Kodi}} device has minimal storage available, these defaults can be lowered to noticeably reduce the cost of artwork. For higher powered equipment these settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
# Images are re-encoded in a decoder-friendly way so that the image can be displayed as quickly as possible.

This optimized image is exported with {{Kodi}}'s [[Import-export_library|Library Export]] feature, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible.<ref>https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318</ref>

= Advanced: How to refresh the cached image of an icon manually =
The [[Texture Cache Maintenance utility]] can do this in a safer way, but this is the manual option.
There is an image like ''/home/x/.kodi/addons/my.lovely.addon/icon.png'' . After changing that file, the old image is still visible in {{kodi}}. To solve this we need to remove the actual thumbnail file from the filesystem and its reference in the DB:

# Get the thumbnail path to remove the file from the filesystem
$ sqlite3 .kodi/userdata/Database/Textures13.db "SELECT cachedurl FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"
6/6a643bff.png

This ''6/6a643bff.png'' is the cached image under ''/home/x/.kodi/userdata/Thumbnails''. So: you need to remove from your filesystem ''/home/x/.kodi/userdata/Thumbnails/6/6a43bff.png''

# Remove the image->cached image link in the DB
$ sqlite3 .kodi/userdata/Database/Textures13.db "DELETE FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"

Next time Kodi needs the image, it will recreate the thumbnail.

:{{note|The <code>"Textures'''13'''.db"</code> '''[[Databases#Database_Versions|number/version can increase]]''' with later Kodi versions.}}

'''''See also: [[Databases#Database_Versions|Database Versions]]'''''

= Advanced: delete textures13.db =
This last resort procedure is one sure way to repair any image caching problem: delete the ''Textures13.db'' database and the thumbnail directory. This procedure does not affect the entries in the Video and Music libraries, so Kodi will not find more images after, this is just a brute-force solution to a caching problem. It affects the artwork database only. [[Texture Cache Maintenance utility]] can do very targeted fixes of the texture cache, so consider it before doing this.

'''Note'''
#Be aware that this should be a last resort procedure. Deleting this database file and the thumbnail directory will remove all cache entries and links, requiring remote URLs to web services to be downloaded again.
#As the URL link to the original artwork location is stored in the video or music databases, Kodi will use the existing URLs to rebuild the Texture database and thumbnail cache, rather than finding new images locally or from a scraper.
#{{red|Using this procedure, you cannot change the scraping location for artwork. ie- If you originally scraped from online sources, you cannot expect that Kodi will now scrape from your newly added local artwork and vice-versa. It will retrieve artwork from the same source as it was before, so the result will be the same image. To bulk change artwork, refer to ''[[Artwork#Importing-Scraping Artwork| Importing-Scraping Artwork]]''}}<br /><br />

You will need to perform the following for a clean start with respect to the artwork texture cache.
#Exit Kodi
#Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
#Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
Once the above steps are performed
#Restart Kodi
#Kodi will automatically rebuild the Textures database and repopulate the Thumbnails cache as the images are displayed in the GUI or other Kodi interface.

= Cache manipulation tools =
* [[Texture Cache Maintenance utility]]
** {{#lst:Texture_Cache_Maintenance_utility|intro}}

= Kodi version updates =
<section begin="CacheMaxResolution" />From v18, the 1920x1080 resolution limitation has been removed. Using the following code in your advancedsettings.xml will allow caching artwork at original size. <ref>https://github.com/xbmc/xbmc/pull/13599</ref>

<syntaxhighlight lang="xml">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>
<section end="CacheMaxResolution" />

= References =
<references />

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Music library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Artwork types

2020-05-03T16:10:27Z

Rmrector: /* fanart# */ clarify multiple fanart usage

{{Artwork_Contents}}
{{mininav|[[Video library]] {{l2| [[Music library]] }}| [[Artwork]] }}

= Common Art Types =
<section begin="intro" />This page describes the common types of artwork used by {{kodi}} skins, scrapers and other art add-ons, where they are used and their specifications. See the linked pages for information on how to use them in {{kodi}}.

With the release of v18, the lines between basic and extended artwork have been blurred. All artwork has an artwork '''type''' and is treated the same as the traditional ''thumb or poster'' and ''fanart''. If a skin has been coded to recognise an artwork type, and the artwork is scanned into {{kodi}}, then it will be displayed.<section end="intro" />

'''Note: '''All resolutions are suggestions and roughly fall in line with the sizing at the scraper sites. You may modify the resolution to suit your own needs, but the aspect ratio must be maintained otherwise the image may undergo stretching, squashing or cropping when viewed in {{kodi}}. If you intend to share your artwork, check the scraper sites to ensure your artworks are within their minimum and maximum limits.

== actor ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

The Actor artwork is a portrait of an actor for display in the cast information pages.

The files are named as '''''<FirstName>_<LastName>.jpg''''' and are saved in the dedicated '''.actors''' folder in the movie folder and tv show folder.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|<FirstName>_<LastName>.jpg
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1500h
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== back ==
'''Used in:''' {{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}

This is the album back cover, which often includes a track listing, though the design varies. They are often used in detail views focused on a single album.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|back
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1000h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| No
|}

== banner ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

In the video library, banners are wide and short images that contain recognizable characters or props from the video and typically includes a clearly visible logo or the name of the movie, movie set or tv show.

In the music library it contains the artist or band members and typically includes a clearly visible logo or the name of the artist/band

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|banner
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1000w x 185h
|-
| Aspect Ratio
| 200:37
|-
| Transparent background
| No
|}

== characterart ==
'''Used in:''' {{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Characterart are png transparent images of iconic characters or objects from the show. Not in common use in {{kodi}}

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|characterart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 512w x 512h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| Yes
|}

== characterart# ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

This is multiple character art for Movies. It has the same concept as character art for TV-Shows described above. In contrast the artwork has no official conventions in terms of resolution and aspect ratio. This is newer but already accessible from '''''[https://www.kyradb.com www.kyradb.com]'''''. It has also been implemented in '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' and some skins <ref>https://forum.kodi.tv/showthread.php?tid=258886&pid=2866420#pid2866420</ref>.

It could be used as single artwork named "characterart" or multiple artwork named "characterart1", "characterart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded and each number needs a corresponding whitelist entry in the advancedsettings.xml file.

More information and sample content can be found in the '''''[https://forum.kodi.tv/showthread.php?tid=342468 official forum thread]'''''.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|characterart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| variable
|-
| Aspect Ratio
| variable
|-
| Transparent background
| Yes
|}

== clearart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Clearart have a transparent background with recognizable characters or props from the video along with a logo or name and its transparent background allows it to be overlaid images or video with minimal impact.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|clearart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 1000w x 562h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| Yes
|}

== clearlogo ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Logos typically use the distinctive font associated with the video and is uncluttered by other images. The transparent background allows it to be overlaid images or video with minimal impact.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|clearlogo
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 800w x 310h
|-
| Aspect Ratio
| 80:31
|-
| Transparent background
| Yes
|}

== discart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}

Discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|discart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 1000w x 1000h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| Yes
|}

== fanart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

They are used as full screen displays.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|fanart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1920w x 1080h<br>
3840w x 2160h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

Note: For the Music library, the file names recognised by {{Kodi}} and loaded as local fanart can be configured by entries in the ''[[Advancedsettings.xml#fanart|advancedsettings.xml]]''

== fanart# ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This is Multiple fanart. It has the same specifications as fanart in the previous section.

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Multiple fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. Multiple fanart is an alternative to the "extrafanart" folders, adding all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart, but can be overcome with the use of '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded and each number needs a corresponding whitelist entry in the advancedsettings.xml file. The advantage is improved performance and behavior.

== keyart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|keyart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1500h<br>
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== landscape ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. If the Landscape image is not available, skins can make passable replacements by using fanart and overlaying the clearlogo.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|landscape
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 562h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

== poster ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the video.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|poster
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1000w x 1500h
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== poster# - character poster sets ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

This is multiple posters and has the same specifications as Posters above.

These multiple posters are released as a set which displays the characters of the movie. Each poster in the set highlights one character and there can be up to 20 poster per movie. There can be multiple sets per movie, each set differing in style. Each poster in the set is designed to have a fixed position order, usually because they can be placed edge to edge to create a larger artwork.

The intention is that they are displayed in a multiimage sideshow. More information and examples can be found [https://forum.kodi.tv/showthread.php?tid=345299 in this thread].

== spine ==
'''Used in:''' {{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}

Album spines replicate the album spine found on standard CD cases. They typically have the name of the album and artist, but are too thin to have much of a design beyond continuing the front or back image. They are often used as thin identifiers for unfocused items in a list of albums.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|spine
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 50w x 1000h
|-
| Aspect Ratio
| 1:20
|-
| Transparent background
| No
|}

== thumb ==

''Thumb'' is the most basic art type (and the oldest historically) used by {{Kodi}} skins. The properties differ depending on the area of {{kodi}} it is being used in. Skins often show this type of art both full size, and also as a small icon alongside each item in a list.

=== Video Library ===
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This art type hold thumbnails that are still images from the movie itself, and can be generated from the video file in your library. They are also used as images for episodes in TV Shows.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|thumb
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 960w x 540h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

=== Music Library ===
'''Used in:''' {{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}
{{highlight|[[Music_artwork|Source Folder Icons]]|color=#b1d9b6}}

This art type holds high quality images of the album front cover or square (or near to square) artist images. The artist images usually show the whole band without any text or logos. Kodi will recognise a variety of file names and load them as a ''thumb'', these file names can be adjusted by entries in ''[[Advancedsettings.xml#musicthumbs|advancedsettings.xml]]''. The export facility will export this art type as ''folder.jpg'' which may mean duplicated artwork if you used the thumb filename in local art and export artwork to the same location.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|folder, cover or thumb
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 500w x 500h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| No
|}

= Other Types =
This section lists other artwork types that are...
# Still in the experimental stage, or
# Still in use, but being phased out, and
# Used by only a small number of skins at this time, usually for one of the previous two reasons

== Animated Artwork ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Still experimental, but {{kodi}} has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

=== Limitations of animated artwork ===
Kodi's support for displaying animated artwork is basic, and does have some limitations.

;Limitation 1-
:{{kodi}} does not save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system. ie- Animated artwork will not work across networks.

;Limitation 2-
:There is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
::Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
::1920 × 1080 = 2,073,600 * 11 (frames) = 22,809,600 pixels '''plus''' one more frame

== extrafanart Folder ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This method is slowly being phased out in favour of the ''fanart#'' method described in the previous section

<section begin="ExtrafanartFolder" />It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

In v17 and prior, Extra Fanart is stored in a separate folder named '''''extrafanart'''''. Create a folder named '''''extrafanart''''' in the folder of the movie or the TV Show, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins access the folder directly. A downside to this method is that it can wake hard drives while browsing the library and cause freezing of the GUI while the drives wake up. The filename is mostly not important.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|fanart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1920w x 1080h<br>
3840w x 2160h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

== extrathumbs Folder ==
{{anchor|Extra Thumbs}}
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images.

This artwork is not in common use.

== Source Folder Icon ==
<section begin="SourceFolderArtwork" />The Source Folder icon is a landscape image that can be used to replace the standard folder icons when browsing your '''sources''' in the video menu. This image file is saved directly within the Source directory.

To enable the image...
#Navigate to Videos>Files in the menu system
#Highlight a source and call up the '''''[[Basic_controls#Context_Menu|context menu]]'''''
#Select ''Choose Thumbnail''.
If you have saved in 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. Deleting the image will remove it from view in the folder icon.

You are able to apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows

<syntaxhighlight lang="xml" line='line'>
<source>
<name>Movies</name>
<path pathversion="1">F:\Movies\</path>
<allowsharing>true</allowsharing>
<thumbnail>F:\Movies\folder.jpg</thumbnail>
</source>
</syntaxhighlight>

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|folder
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 640w x 360h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

= Artwork Usage Chart =
The following is a guide only and charts common usage. <sup>1</sup>

Artwork is skin dependant and skinners are free to use artwork how and where they choose. Some skins may conform with the following, others may not.

{| class="prettytable"
! colspan="11" style="text-align:center;" | Artwork Usage
|-
! colspan="1" style="text-align:right;" |
! colspan="2" style="text-align:center; background-color:#fdfefe" | Movies
! colspan="2" style="text-align:center; background-color:#fdfefe" | Music
! colspan="1" style="text-align:center;" |
! colspan="3" style="text-align:center; background-color:#fdfefe" | TV Shows
! colspan="1" style="text-align:center;" |
!
|-
! style="width:110px;" |
! style="width:150px; background-color:#ddddff"|Movie
! style="width:150px; background-color:#ddffdd"|Movie Sets
! style="width:150px; background-color:#72d2f7"|Artists
! style="width:150px; background-color:#72d2f7"|Albums
! style="width:150px; background-color:#ffc7ff"|Music Video
! style="width:150px; background-color:#f5f5a1"|TV Show
! style="width:150px; background-color:#f5f5a1"|Seasons
! style="width:150px; background-color:#f5f5a1"|Episodes
! style="width:5px; background-color:#"|
! style="width:150px; background-color:#b1d9b6"|Source Folder
|-
!scope="row"| actor || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| back || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| banner || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| characterart || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| characterart# || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| clearart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| clearlogo || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| discart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| fanart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| fanart# || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| keyart || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| landscape || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| poster || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| spine || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| thumb || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} |||| {{Yes}}
|}

:<sup>1</sup> “Common usage” here means that the scrapers can return this type of art, and/or it is displayed by one or more skins in the official Kodi repo.

= Sample Images =
Screenshots of various artworks displays.

== Movies ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-DiscArt01.jpg|Movie discart
File:Artwork-Thumbs01.jpg|Movie landscape
</gallery>

== TV Shows ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-PosterView02.jpg|TV show poster
File:Artwork-FanartView03.jpg|TV show fanart
File:Artwork-Banner01.jpg|TV show banner
File:Artwork-ClearArt02.jpg|TV show clearart
File:Artwork-ClearLogo02.jpg|TV show clearlogo
File:Artwork-Landscape01.jpg|TV show landscape
File:Artwork-CharacterArt01.jpg|TV show characterart
File:Artwork-EpisodeThumb01.jpg|Episode thumb
File:Artwork-EpisodeFanart01.jpg|Episode fanart
</gallery>

== Music ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-MusicFanart01.jpg|Artist fanart
File:Artwork-MusicArtist01.jpg|Grid of artist thumb
File:Artwork-MusicBanner01.jpg|Artist banner and clearlogo
File:Artwork-TS-clearart-AeonNox5modmaybe.jpg|Artist clearart in center right
File:Artwork-musiclandscape-EstuaryATF.jpg|Grid of artist landscape
</gallery>

= References =
<references />

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Settings/Media/Videos

2019-12-25T17:01:49Z

Rmrector: "MSIF" in Kodi 19

{{bigger|This category contains the settings for how information for videos is collected, stored, shown and navigated.}}
__TOC__
{{-}}
== All ==
[[File:SettingsMediaVideos-leia1.jpg|500px]]
=== Default select action ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Lets you toggle between '''Choose''', '''Play''', '''Resume''' and '''Show information'''

'''Choose''', will select item, eg open a directory in files mode.

On '''Resume''' Kodi will automatically resume videos from the last position that you were viewing them, even after restarting the system.

Default is '''Play'''
|}

=== Use video tags ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If *.mp4 or *.mkv files do have tags, enable this setting to use them for the library metadata.
|}

=== Extract video information from files ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract metadata information such as codec and aspect ratio from videos.
|}

=== Extract thumbnails from video files ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract thumbnails to display in library mode
|}

=== Extract chapter thumbnails ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract chapter thummbnails for presentation in the chapters/bookmarks dialogue. This might increase CPU load
|}

== Files ==
[[File:Settings_media_videos_files.JPG|500px]]
=== Combine split video items ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files, DVD folders or movie folders, down to a single item in the non-library views
|}

=== Replace file names with library titles ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the metadata title instead of the filename
|}
{{-}}

== Library ==
[[File:SettingsMediaVideos-leia2.jpg|500px]]
=== Show all items entry ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in directory, e.g. "All Albums" or "All seasons"
|}

=== Show plot for unwatched items ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Show information for unwatched media in the video library or hide them if not selected to prevent spoilers. Available options are: "Movie plot", "Episode plot" and "Episode thumb".
|}

=== Show movie sets ===
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When enabled, movies that are tagged with a "Movie set" are grouped together under one entry in the movie library. This entry can then be opened to display the individual movies. When disabled, each movie will have its own entry in the movie library, even if it belongs to a set. It has no affect on the Movie Sets node.
|}
<section end="Show movie sets" />

==== Include sets containing a single movie ====
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting. It is recommended that this setting is enabled
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.
*This setting has no affect on the Movie Sets node
|}
<section end="Show movie sets SingleMovie" />
{{see|Movie sets}}

=== Flatten hierarchy ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Romeves the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

=== Flatten TV show seasons ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the TV show season node, toggles between "If only one season" (default), "Always" and "Never".
|}

=== Show empty TV shows ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Shows TV shows with no episodes when browsing through the library
|}

=== Select first unwatched TV show season / episode ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When entering TV show season or episode views, automatically selects the first unwatched item.
If viewing seasons, selects the first season with unwatched episodes.
If viewing episodes, selects the first unwatched episode. Only applies if sort method is set to Episode
|}

==== Include "All seasons" and "Specials" ====
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Whether or not consider the items from "All season" and "Specials in the unwatched item selection
|}

=== Download actor thumbnails ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Gets thumbnails for actors when scanning media.
|}

== Changes in Kodi 19 Matrix ==
=== Movie set information folder ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the folder where movie set information (images) are saved locally.
|- valign="top"
| '''Note:'''
| Located at the bottom of the '''Library''' section above.
|}

{{updated|18}}

Movie sets artwork

2019-12-25T02:07:22Z

Rmrector: add setting "Movie set information folder" in v19

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />As movie sets comprise a number of movies, dedicated artwork is available that (should) differ from the artwork of the individual movies in the set. This unique movie set artwork can be scraped and displayed while browsing your {{kodi}} library.<section end="intro" />

v19 has full support for movie set artwork, as described below.

Changes in v18 enable '''scraping of online''' movie set artwork <ref>https://github.com/xbmc/xbmc/pull/14667</ref>, but add-ons are still required to '''scan local''' movie set artwork. While in v17 and prior, {{Kodi}} has limited functionality for movie set artwork. Users were required to either use the '''''[[Artwork#Kodi-_Choose_Art|Choose Art]]''''' method or use an add-on to source and cache movie set artwork- such as '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''.

= Scanning & Scraping =

== Scraping ==
v18 introduces the ability to scrape extended artwork from the online information providers without the use of additional add-ons. It is considered an advanced feature.

To use this feature requires completing the following three steps...

: '''1.''' Add the below code to the '''[[Advancedsettings.xml| advancedsettings.xml]]''' file, ensuring you do not duplicate any tags if they already exist... eg ''<advancedsettings></advancedsettings>, <videolibrary></videolibrary>''
: '''2.''' Install the '''[[Add-on:Universal_Movie_Scraper|Universal Movie Scraper]]''' and adjust the settings to enable scraping of Extended artwork as they are disabled by default. (see image)
: '''3.''' Restart {{kodi}} and scrape movies as per usual. Collection artwork will be scraped and cached for use in {{kodi}}

:'''Note:''' The code box below adds common extended artwork that most 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.
<syntaxhighlight lang="xml" line='line'>
<advancedsettings>
<videolibrary>
<moviesetextraart>
<arttype>banner</arttype>
<arttype>clearart</arttype>
<arttype>clearlogo</arttype>
<arttype>discart</arttype>
<arttype>fanart1</arttype> 
<arttype>fanart2</arttype> 
<arttype>fanart3</arttype>
<arttype>keyart</arttype>
<arttype>landscape</arttype>
</moviesetextraart>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

<gallery mode="packed-overlay" widths="500px" heights="283px">
File:UniversalMovieScraper02.jpg|Enable the Extra Artwork options.
</gallery>

== Scanning Local Artwork ==
Local movie set artwork is saved in the [[Settings/Media/Videos#Movie_set_information_folder|Movie Set Information Folder]] starting with Kodi v19. The artwork whitelist above must be configured. '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' can be used for Kodi version 16-18.

To set up the local artwork, use the following method...
# Create the Central Movie Set folder
# Create sub-folders for each movie set
# Name the movie set sub-folder '''exactly''' as the collection is named in {{kodi}}. This is important or else the movie set folder will be ignored.
# Save artwork to the sub-folder using '''short''' filenames. (See image)

<gallery mode="packed" widths="800px" heights="450px">
File:LocalMovieSetsArt01.jpg|'''''Folder structure and file naming for central movie set artwork folder'''''
</gallery>

= References =
<references />

{{Top}}
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Settings/Media/Videos

2019-12-25T01:55:10Z

Rmrector: /* Library */

{{bigger|This category contains the settings for how information for videos is collected, stored, shown and navigated.}}
__TOC__
{{-}}
== All ==
[[File:SettingsMediaVideos-leia1.jpg|500px]]
=== Default select action ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Lets you toggle between '''Choose''', '''Play''', '''Resume''' and '''Show information'''

'''Choose''', will select item, eg open a directory in files mode.

On '''Resume''' Kodi will automatically resume videos from the last position that you were viewing them, even after restarting the system.

Default is '''Play'''
|}

=== Use video tags ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If *.mp4 or *.mkv files do have tags, enable this setting to use them for the library metadata.
|}

=== Extract video information from files ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract metadata information such as codec and aspect ratio from videos.
|}

=== Extract thumbnails from video files ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract thumbnails to display in library mode
|}

=== Extract chapter thumbnails ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract chapter thummbnails for presentation in the chapters/bookmarks dialogue. This might increase CPU load
|}

== Files ==
[[File:Settings_media_videos_files.JPG|500px]]
=== Combine split video items ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files, DVD folders or movie folders, down to a single item in the non-library views
|}

=== Replace file names with library titles ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the metadata title instead of the filename
|}
{{-}}

== Library ==
[[File:SettingsMediaVideos-leia2.jpg|500px]]
=== Show all items entry ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in directory, e.g. "All Albums" or "All seasons"
|}

=== Show plot for unwatched items ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Show information for unwatched media in the video library or hide them if not selected to prevent spoilers. Available options are: "Movie plot", "Episode plot" and "Episode thumb".
|}

=== Show movie sets ===
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When enabled, movies that are tagged with a "Movie set" are grouped together under one entry in the movie library. This entry can then be opened to display the individual movies. When disabled, each movie will have its own entry in the movie library, even if it belongs to a set. It has no affect on the Movie Sets node.
|}
<section end="Show movie sets" />

==== Include sets containing a single movie ====
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting. It is recommended that this setting is enabled
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.
*This setting has no affect on the Movie Sets node
|}
<section end="Show movie sets SingleMovie" />
{{see|Movie sets}}

=== Flatten hierarchy ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Romeves the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

=== Flatten TV show seasons ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the TV show season node, toggles between "If only one season" (default), "Always" and "Never".
|}

=== Show empty TV shows ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Shows TV shows with no episodes when browsing through the library
|}

=== Select first unwatched TV show season / episode ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When entering TV show season or episode views, automatically selects the first unwatched item.
If viewing seasons, selects the first season with unwatched episodes.
If viewing episodes, selects the first unwatched episode. Only applies if sort method is set to Episode
|}

==== Include "All seasons" and "Specials" ====
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Whether or not consider the items from "All season" and "Specials in the unwatched item selection
|}

=== Download actor thumbnails ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Gets thumbnails for actors when scanning media.
|}

=== Movie set information folder ===
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Select the folder where movie set information (images) are saved locally.
|- valign="top"
| '''Note:'''
| Introduced in Kodi 19 Matrix.
|}

{{updated|18}}

Movie sets

2019-12-25T01:52:44Z

Rmrector: /* Movie Set Artwork */

{{mininav|[[Video library]]|[[Video management|Management]] }}
{{See also|Linking movies to TV shows|Movie sets|Season rename|NFO files|}}

= Description =
[[File:MovieSets01.jpg|400px|right]]
<section begin=intro />A Movie Set, also known as movie collection, film or movie series, film or movie franchise, and cinematic universe is a collection of related films that are part of the same fictional universe. The normal scraper sites include metadata for Movie Sets which is scraped by {{kodi}} and creates the Movie Set in your library. Movie sets are versatile and can be created to suit your own preferences as they are easily edited in {{kodi}} using the built in sets editor or by using [[NFO files]].<section end=intro />
<br /><br />
Example Movie Set usage:
*According to TMDB, the three movies from The Lord of the Rings are considered a set. The three movies from The Hobbit are considered as another set. This would create two movie sets in {{kodi}}. ''(scraper created movie set)''
*Some users will combine these two sets into one set. The set now contains six movies and can be renamed to The Middle Earth Collection or similar. ''(created with movie set editor or nfo files)''
*Movie Sets can be used to collate separate versions of a movie- eg Willy Wonka & the Chocolate Factory (1971) and Charlie and the Chocolate Factory (2005) ''(created with movie set editor or nfo files)''
*Movie Sets can also be used to stack multiple versions of the same movie- eg Blade Runner (US Theatrical Releasae}, Blade Runner (International Theatrical Release), Blade Runner (Directors Cut) etc. ''(created with movie set editor or nfo files)''

{{note|'''Movies can only be used in one set at a time'''. To use movies in more than one collection requires a different method using Tags. '''''See: [[video library tags]]'''''.}}

= Settings =
The following are the available settings to control Movie Sets.

== Movie Set Node ==
The Movie Set Node is accessed from the Movies Home Screen. Along the top row of Categories, the icon '''Sets''' will become visible when the library contains Movie Sets. Selecting the Sets icon will open the Movie Sets node.

As long as Movie Set metadata has been scraped, then the Movie Set node will be automatically populated. The only available settings when using the Movie Sets Node are those that are accessed by the Sidebar Menu.

{{See also|Basic_controls#Sidebar_menu}}

== Movie Library ==
[[File:SettingsMediaVideos-leia2.jpg|400px|right]]
When viewing your movies from the main movie listing, or from a movie node such as Genre, Year, Country, etc, it is possible to show Movie Sets by adjusting settings as follows...
<br /><br />
'''Show Movie Sets'''
{{#lst:Settings/Media/Videos|Show movie sets}}

'''Include sets containing a single movie'''
{{#lst:Settings/Media/Videos|Show movie sets SingleMovie}}
{{see also|Settings/Media/Videos#Library|label 1=Video Library Settings}}

= Creating & Editing Movie Sets =
The following methods are available for creating and editing Movie Sets. You cannot use the Scraper method to edit movie sets.

{{red|'''Each movie required in a Movie Set must have Movie Set metadata.'''}}

== Scraper ==
Using the native {{kodi}} scraper will automatically download Movie Set metadata and create the Movie Set. {{kodi}} relies on the scraper site for this information.

The naming of the set, and the movies contained within the set, is controlled by the scraper site. These variables can be edited using one of the following two methods.

== {{kodi}} Movie Set Editor ==
{{Kodi}} has an inbuilt Movie Set Editor which can be used to create and edit Movie Sets. The following guide and images should assist in locating and using the Editor. The Editor cannot be accessed from Videos>Files. It must be accessed from the Movie Library. Movies must have already been scraped into the library.

{{red|'''Note:''' Ensure you have enabled the setting '''''[[Videos#Include_sets_containing_a_single_movie| Include sets containing a single movie]]''''' otherwise sets with a single movie will not be listed in the Movie Set Editor shown in Image 3 above. This setting can be enabled without enabling the parent setting ''Show movie sets''.}}

'''Manage individual movies in a Movie Set:'''
#''Image 1''- Highlight the movie to be added to a Movie Set and call up the '''''[[Basic_controls#Context_Menu|Context Menu]]'''''
#''Image 1''- Select '''''Manage'''''
#''Image 2''- Select '''''Manage movie set'''''
#''Image 3''- This is the Movie Set Editor. From this screen, your options are as follows:
##'''''No set'''''- The first option from the list. Allows you to remove an existing movie from a movie set.
##'''''Keep current set''''' - Allows you to exit the Editor without making any changes
##'''''<List of other collections>''''' - Allows you to move the selected movie from the current Movie Set and place it into another, existing, Movie Set
##'''''Add movie to a new collection''''' - This is the button above the '''''Cancel''''' button. The button name is not fully visible due to the length of the button name. Pressing this button calls up the on-screen keyboard which allows you to type the name of the new Movie Set. Selecting Enter will then create the Movie Set and place the currently selected movie into the new Set. Additional movies can be placed into the new Movie Collection by repeating steps 1, 2, 3 and 4.3.

<gallery widths=450px heights=250px>
File:MovieSets02.jpg|Image 1- Call up the Context Menu and select ''Manage...''
File:MovieSets03.jpg|Image 2- Select ''Manage movie set''
File:MovieSets04.jpg|Image 3- The Movie Set Editor
</gallery>

'''Manage bulk movies in a Movie Set:'''
#If your set does not exist, then create your Movie Set as shown above using '''''Add movie to a new collection'''''
#Highlight the '''Movie Set''' from the Sets listing and call up the '''''[[Basic_controls#Context_Menu|Context Menu]]'''''
#Select '''''Manage'''''
#Select '''''Manage movie set'''''
#This list displays all movies in the library including movies already in another existing set
#Select each movie to be added or removed from the set. A selected movie will be in '''{{green|green coloured font}}'''.
#Selecting a movie already in a set will remove it from the existing set once you select '''OK'''
#Select '''OK''' to save your changes

== nfo Files ==
Using nfo files allows you to add Movie Set data to specific movies and then scrape into the library.

The following two XML tags are used in Movie Sets:
#''<name></name>''- The name of the Set. Must be identical for each movie nfo you intend to place into the Set otherwise multiple, similarly named, Movie Sets will be created.
#''<overview></overview>'' - Allows the entry of a Movie Set synopsis. Requires a compatible skin to display the overview. As of 7 January 2018, the scrapers were modified to scrape Movie Set Overview.

The code is entered into the nfo file as follows.
<set>
<name></name>
<overview></overview>
</set>

:'''''See: [[NFO_files]]'''''

= Movie Set Overview =
It was possible to add Movie Set Overview information to Sets with the use of NFO Files. As of January 2018, TheMovieDB scraper was updated to enable scraping of Movie Set Overviews. These are a short synopsis of the Set as a whole.

Most skins will display the Overview information. But, as this is a recently added feature, some skins may have glitches with displaying the overview. Most commonly because it overlays other information. The skin developers are rectifying these issues as they are reported.

The following is the method to add the Overview to Movie Sets
;Adding new movies to a new Set
:No special procedure required. Scrape as per normal. Once the second movie in the set is added, the set will become visible and the Overview will be displayed in supported views and skins

;Adding Overview to existing Movie Sets
:To add Movie Set Overview to existing sets, remove the Set from the Sets node via the Manage '''''[[Basic_controls#Context_Menu|context menu]]''''', then refresh each movie that belongs in that set

= Sort Title =
[[File:MovieSets05.jpg|400px|right]]
{{kodi}} is able to sort movie lists by a number of different parameters. The more common sort orders available for movies are...
*Year- This is based on the year of release of the movie
*Title- Standard alphabetical sorting of movies

Many enthusiasts prefer to sort their Sets by Canonical Order. This is a sort order based on the story timeline. This means that prequel movies, made after the original movie, would come first in the sort order.

An example of this is combining The Hobbit and The Lord of the Rings into one set.
*Using Year sort would list The Lord of the Rings first, which is incorrect as The Hobbit should be listed first, according to the story timeline
*Using Title sort will list The Hobbit first and The Lord of the Rings would be listed second, but the three movies within each film group will be sorted incorrectly

Although {{kodi}} has no Canonical Order option, it is possible to force this order by adding a '''''Sort Title''''' to the movie entry. See image to the right which shows Canonical Order of the movies, whereas the first image at the top of the page in [[Movie_sets#Description|1 Description]] shows normal alphabetical listing.

{{red|'''Be aware that using Sort Order will also affect the Title sort order in the main library view. In most cases, this is preferable.'''}}<br />
{{red|'''The Sort Title is NOT displayed in any movie list. It is a hidden title used internally by {{kodi}}.'''}}

The following table shows a Sort Title renaming using The Hobbit and The Lord of the Rings as an example. Only use suffix numbering. Using prefix numbering will send all movies with prefix numbering to the top of the Library View list.

:{|class="prettytable"
! Original Title
!Sort Title
Recommended
|-
| The Hobbit: An Unexpected Journey (2012) || Hobbit 01
|-
| The Hobbit: The Desolation of Smaug (2013) || Hobbit 02
|-
| The Hobbit: The Battle of the Five Armies (2014) || Hobbit 03
|-
| The Lord of the Rings: The Fellowship of the Ring (2001) || Lord of the Rings 01
|-
| The Lord of the Rings: The Two Towers (2002) || Lord of the Rings 02
|-
| The Lord of the Rings: The Return of the King (2003) || Lord of the Rings 03
|}

The following are the two methods that enable adding Sort Titles to movies.

== Sort Title Editor ==
{{Kodi}} has an inbuilt Sort Order Editor. The following guide and images should assist in locating and using the Editor. The Editor cannot be accessed from Videos>Files. It must be accessed from the Movie Library. Movies must have already been scraped into the library.

#''Image 1''- Highlight the movie to be edited. Call up the Context Menu
#''Image 1''- Select '''''Manage...'''''
#''Image 2''- Select '''''Edit sort title'''''
#Enter the new title.

<gallery widths=450px heights=250px>
File:MovieSets02.jpg|Image 1- Call up the Context Menu and select ''Manage...''
File:MovieSets03.jpg|Image 2- Select ''Edit sort title''
</gallery>

== nfo Files ==
Using nfo files allows you to add a Sort title to specific movies and then scrape into the library.

The following XML tag is used:
*''<sorttitle></sorttitle> ''

:'''''See: [[NFO_files]]'''''

= Movie Set Artwork =
Up to v17.6, there is no facility to scrape Movie Set Artwork.

v18 introduces scraping of Movie Set artwork. v19 allows scanning local Movie Set artwork.
:'''''See: [[Movie_sets_artwork| Movie Set Artwork]]'''''

= Cinematic Universe =
{{#lst:HOW-TO:Movie_universe|intro}}
:'''''See: [[HOW-TO:Movie universe]]'''''

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Artwork types

2019-12-14T15:19:03Z

Rmrector: /* Video Library */

{{Artwork_Contents}}
{{mininav|[[Video library]] {{l2| [[Music library]] }}| [[Artwork]] }}

= Common Art Types =
<section begin="intro" />This page describes the common types of artwork used by {{kodi}} skins, scrapers and other art add-ons, where they are used and their specifications. See the linked pages for information on how to use them in {{kodi}}.

With the release of v18, the lines between basic and extended artwork have been blurred. All artwork has an artwork '''type''' and is treated the same as the traditional ''thumb or poster'' and ''fanart''. If a skin has been coded to recognise an artwork type, and the artwork is scanned into {{kodi}}, then it will be displayed.<section end="intro" />

'''Note: '''All resolutions are suggestions and roughly fall in line with the sizing at the scraper sites. You may modify the resolution to suit your own needs, but the aspect ratio must be maintained otherwise the image may undergo stretching, squashing or cropping when viewed in {{kodi}}. If you intend to share your artwork, check the scraper sites to ensure your artworks are within their minimum and maximum limits.

== actor ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

The Actor artwork is a portrait of an actor for display in the cast information pages.

The files are named as '''''<FirstName>_<LastName>.jpg''''' and are saved in the dedicated '''.actors''' folder in the movie folder and tv show folder.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|<FirstName>_<LastName>.jpg
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1500h
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== back ==
'''Used in:''' {{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}

This is the album back cover, which often includes a track listing, though the design varies. They are often used in detail views focused on a single album.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|back
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1000h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| No
|}

== banner ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

In the video library, banners are wide and short images that contain recognizable characters or props from the video and typically includes a clearly visible logo or the name of the movie, movie set or tv show.

In the music library it contains the artist or band members and typically includes a clearly visible logo or the name of the artist/band

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|banner
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1000w x 185h
|-
| Aspect Ratio
| 200:37
|-
| Transparent background
| No
|}

== characterart ==
'''Used in:''' {{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Characterart are png transparent images of iconic characters or objects from the show. Not in common use in {{kodi}}

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|characterart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 512w x 512h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| Yes
|}

== characterart# ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

This is multiple character art for Movies. It has the same concept as character art for TV-Shows described above. In contrast the artwork has no official conventions in terms of resolution and aspect ratio. This is newer but already accessible from '''''[https://www.kyradb.com www.kyradb.com]'''''. It has also been implemented in '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' and some skins <ref>https://forum.kodi.tv/showthread.php?tid=258886&pid=2866420#pid2866420</ref>.

It could be used as single artwork named "characterart" or multiple artwork named "characterart1", "characterart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded and each number needs a corresponding whitelist entry in the advancedsettings.xml file.

More information and sample content can be found in the '''''[https://forum.kodi.tv/showthread.php?tid=342468 official forum thread]'''''.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|characterart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| variable
|-
| Aspect Ratio
| variable
|-
| Transparent background
| Yes
|}

== clearart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Clearart have a transparent background with recognizable characters or props from the video along with a logo or name and its transparent background allows it to be overlaid images or video with minimal impact.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|clearart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 1000w x 562h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| Yes
|}

== clearlogo ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Logos typically use the distinctive font associated with the video and is uncluttered by other images. The transparent background allows it to be overlaid images or video with minimal impact.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|clearlogo
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 800w x 310h
|-
| Aspect Ratio
| 80:31
|-
| Transparent background
| Yes
|}

== discart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}

Discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|discart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 1000w x 1000h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| Yes
|}

== fanart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

They are used as full screen displays.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|fanart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1920w x 1080h<br>
3840w x 2160h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

Note: For the Music library, the file names recognised by {{Kodi}} and loaded as local fanart can be configured by entries in the ''[[Advancedsettings.xml#fanart|advancedsettings.xml]]''

== fanart# ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This is Multiple fanart. It has the same specifications as fanart in the previous section.

Multiple fanart is an alternative to the "extrafanart" folders. Multiple fanart adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart, but can be overcome with the use of '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded and each number needs a corresponding whitelist entry in the advancedsettings.xml file. The advantage is improved performance and behavior.

== keyart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|keyart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1500h<br>
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== landscape ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. If the Landscape image is not available, skins can make passable replacements by using fanart and overlaying the clearlogo.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|landscape
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 562h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

== poster ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the video.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|poster
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1000w x 1500h
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== poster# - character poster sets ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

This is multiple posters and has the same specifications as Posters above.

These multiple posters are released as a set which displays the characters of the movie. Each poster in the set highlights one character and there can be up to 20 poster per movie. There can be multiple sets per movie, each set differing in style. Each poster in the set is designed to have a fixed position order, usually because they can be placed edge to edge to create a larger artwork.

The intention is that they are displayed in a multiimage sideshow. More information and examples can be found [https://forum.kodi.tv/showthread.php?tid=345299 in this thread].

== spine ==
'''Used in:''' {{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}

Album spines replicate the album spine found on standard CD cases. They typically have the name of the album and artist, but are too thin to have much of a design beyond continuing the front or back image. They are often used as thin identifiers for unfocused items in a list of albums.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|spine
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 50w x 1000h
|-
| Aspect Ratio
| 1:20
|-
| Transparent background
| No
|}

== thumb ==

''Thumb'' is the most basic art type (and the oldest historically) used by {{Kodi}} skins. The properties differ depending on the area of {{kodi}} it is being used in. Skins often show this type of art both full size, and also as a small icon alongside each item in a list.

=== Video Library ===
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This art type hold thumbnails that are still images from the movie itself, and can be generated from the video file in your library. They are also used as images for episodes in TV Shows.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|thumb
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 960w x 540h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

=== Music Library ===
'''Used in:''' {{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}
{{highlight|[[Music_artwork|Source Folder Icons]]|color=#b1d9b6}}

This art type holds high quality images of the album front cover or square (or near to square) artist images. The artist images usually show the whole band without any text or logos. Kodi will recognise a variety of file names and load them as a ''thumb'', these file names can be adjusted by entries in ''[[Advancedsettings.xml#musicthumbs|advancedsettings.xml]]''. The export facility will export this art type as ''folder.jpg'' which may mean duplicated artwork if you used the thumb filename in local art and export artwork to the same location.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|folder, cover or thumb
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 500w x 500h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| No
|}

= Other Types =
This section lists other artwork types that are...
# Still in the experimental stage, or
# Still in use, but being phased out, and
# Used by only a small number of skins at this time, usually for one of the previous two reasons

== Animated Artwork ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Still experimental, but {{kodi}} has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

=== Limitations of animated artwork ===
Kodi's support for displaying animated artwork is basic, and does have some limitations.

;Limitation 1-
:{{kodi}} does not save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system. ie- Animated artwork will not work across networks.

;Limitation 2-
:There is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
::Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
::1920 × 1080 = 2,073,600 * 11 (frames) = 22,809,600 pixels '''plus''' one more frame

== extrafanart Folder ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This method is slowly being phased out in favour of the ''fanart#'' method described in the previous section

<section begin="ExtrafanartFolder" />It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

In v17 and prior, Extra Fanart is stored in a separate folder named '''''extrafanart'''''. Create a folder named '''''extrafanart''''' in the folder of the movie or the TV Show, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins access the folder directly. A downside to this method is that it can wake hard drives while browsing the library and cause freezing of the GUI while the drives wake up. The filename is mostly not important.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|fanart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1920w x 1080h<br>
3840w x 2160h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

== extrathumbs Folder ==
{{anchor|Extra Thumbs}}
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images.

This artwork is not in common use.

== Source Folder Icon ==
<section begin="SourceFolderArtwork" />The Source Folder icon is a landscape image that can be used to replace the standard folder icons when browsing your '''sources''' in the video menu. This image file is saved directly within the Source directory.

To enable the image...
#Navigate to Videos>Files in the menu system
#Highlight a source and call up the '''''[[Basic_controls#Context_Menu|context menu]]'''''
#Select ''Choose Thumbnail''.
If you have saved in 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. Deleting the image will remove it from view in the folder icon.

You are able to apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows

<syntaxhighlight lang="xml" line='line'>
<source>
<name>Movies</name>
<path pathversion="1">F:\Movies\</path>
<allowsharing>true</allowsharing>
<thumbnail>F:\Movies\folder.jpg</thumbnail>
</source>
</syntaxhighlight>

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|folder
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 640w x 360h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

= Artwork Usage Chart =
The following is a guide only and charts common usage. <sup>1</sup>

Artwork is skin dependant and skinners are free to use artwork how and where they choose. Some skins may conform with the following, others may not.

{| class="prettytable"
! colspan="11" style="text-align:center;" | Artwork Usage
|-
! colspan="1" style="text-align:right;" |
! colspan="2" style="text-align:center; background-color:#fdfefe" | Movies
! colspan="2" style="text-align:center; background-color:#fdfefe" | Music
! colspan="1" style="text-align:center;" |
! colspan="3" style="text-align:center; background-color:#fdfefe" | TV Shows
! colspan="1" style="text-align:center;" |
!
|-
! style="width:110px;" |
! style="width:150px; background-color:#ddddff"|Movie
! style="width:150px; background-color:#ddffdd"|Movie Sets
! style="width:150px; background-color:#72d2f7"|Artists
! style="width:150px; background-color:#72d2f7"|Albums
! style="width:150px; background-color:#ffc7ff"|Music Video
! style="width:150px; background-color:#f5f5a1"|TV Show
! style="width:150px; background-color:#f5f5a1"|Seasons
! style="width:150px; background-color:#f5f5a1"|Episodes
! style="width:5px; background-color:#"|
! style="width:150px; background-color:#b1d9b6"|Source Folder
|-
!scope="row"| actor || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| back || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| banner || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| characterart || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| characterart# || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| clearart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| clearlogo || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| discart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| fanart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| fanart# || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| keyart || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| landscape || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| poster || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| spine || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| thumb || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} |||| {{Yes}}
|}

:<sup>1</sup> “Common usage” here means that the scrapers can return this type of art, and/or it is displayed by one or more skins in the official Kodi repo.

= Sample Images =
Screenshots of various artworks displays.

== Movies ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-DiscArt01.jpg|Movie discart
File:Artwork-Thumbs01.jpg|Movie landscape
</gallery>

== TV Shows ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-PosterView02.jpg|TV show poster
File:Artwork-FanartView03.jpg|TV show fanart
File:Artwork-Banner01.jpg|TV show banner
File:Artwork-ClearArt02.jpg|TV show clearart
File:Artwork-ClearLogo02.jpg|TV show clearlogo
File:Artwork-Landscape01.jpg|TV show landscape
File:Artwork-CharacterArt01.jpg|TV show characterart
File:Artwork-EpisodeThumb01.jpg|Episode thumb
File:Artwork-EpisodeFanart01.jpg|Episode fanart
</gallery>

== Music ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-MusicFanart01.jpg|Artist fanart
File:Artwork-MusicArtist01.jpg|Grid of artist thumb
File:Artwork-MusicBanner01.jpg|Artist banner and clearlogo
File:Artwork-TS-clearart-AeonNox5modmaybe.jpg|Artist clearart in center right
File:Artwork-musiclandscape-EstuaryATF.jpg|Grid of artist landscape
</gallery>

= References =
<references />

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Artwork types

2019-08-10T14:57:53Z

Rmrector: /* Limitations */

{{Artwork_Contents}}
{{mininav|[[Video library]] {{l2| [[Music library]] }}| [[Artwork]] }}

= Common Art Types =
<section begin="intro" />This page describes the common types of artwork used by {{kodi}} skins, scrapers and other art add-ons, where they are used and their specifications. See the linked pages for information on how to use them in {{kodi}}.

With the release of v18, the lines between basic and extended artwork have been blurred. All artwork has an artwork '''type''' and is treated the same as the traditional ''thumb or poster'' and ''fanart''. If a skin has been coded to recognise an artwork type, and the artwork is scanned into {{kodi}}, then it will be displayed.<section end="intro" />

'''Note: '''All resolutions are suggestions and roughly fall in line with the sizing at the scraper sites. You may modify the resolution to suit your own needs, but the aspect ratio must be maintained otherwise the image may undergo stretching, squashing or cropping when viewed in {{kodi}}. If you intend to share your artwork, check the scraper sites to ensure your artworks are within their minimum and maximum limits.

== actor ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

The Actor artwork is a portrait of an actor for display in the cast information pages.

The files are named as '''''<FirstName>_<LastName>.jpg''''' and are saved in the dedicated '''.actors''' folder in the movie folder and tv show folder.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|<FirstName>_<LastName>.jpg
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1500h
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== back ==
'''Used in:''' {{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}

This is the album back cover, which often includes a track listing, though the design varies. They are often used in detail views focused on a single album.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|back
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1000h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| No
|}

== banner ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

In the video library, banners are wide and short images that contain recognizable characters or props from the video and typically includes a clearly visible logo or the name of the movie, movie set or tv show.

In the music library it contains the artist or band members and typically includes a clearly visible logo or the name of the artist/band

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|banner
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1000w x 185h
|-
| Aspect Ratio
| 200:37
|-
| Transparent background
| No
|}

== characterart ==
'''Used in:''' {{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Characterart are png transparent images of iconic characters or objects from the show. Not in common use in {{kodi}}

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|characterart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 512w x 512h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| Yes
|}

== characterart# ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

This is multiple character art for Movies. It has the same concept as character art for TV-Shows described above. In contrast the artwork has no official conventions in terms of resolution and aspect ratio. This is newer but already accessible from '''''[https://www.kyradb.com www.kyradb.com]'''''. It has also been implemented in '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' and some skins <ref>https://forum.kodi.tv/showthread.php?tid=258886&pid=2866420#pid2866420</ref>.

It could be used as single artwork named "characterart" or multiple artwork named "characterart1", "characterart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded and each number needs a corresponding whitelist entry in the advancedsettings.xml file.

More information and sample content can be found in the '''''[https://forum.kodi.tv/showthread.php?tid=342468 official forum thread]'''''.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|characterart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| variable
|-
| Aspect Ratio
| variable
|-
| Transparent background
| Yes
|}

== clearart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Clearart have a transparent background with recognizable characters or props from the video along with a logo or name and its transparent background allows it to be overlaid images or video with minimal impact.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|clearart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 1000w x 562h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| Yes
|}

== clearlogo ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Logos typically use the distinctive font associated with the video and is uncluttered by other images. The transparent background allows it to be overlaid images or video with minimal impact.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|clearlogo
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 800w x 310h
|-
| Aspect Ratio
| 80:31
|-
| Transparent background
| Yes
|}

== discart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}

Discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|discart
|-
|style="width:190px;"| Type
|style="width:220px;"| png
|-
| Resolution
| 1000w x 1000h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| Yes
|}

== fanart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

They are used as full screen displays.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|fanart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1920w x 1080h<br>
3840w x 2160h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

Note: For the Music library, the file names recognised by {{Kodi}} and loaded as local fanart can be configured by entries in the ''[[Advancedsettings.xml#fanart|advancedsettings.xml]]''

== fanart# ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This is Multiple fanart. It has the same specifications as fanart in the previous section.

Multiple fanart is an alternative to the "extrafanart" folders. Multiple fanart adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart, but can be overcome with the use of '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]'''''.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded and each number needs a corresponding whitelist entry in the advancedsettings.xml file. The advantage is improved performance and behavior.

== keyart ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|keyart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 1500h<br>
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== landscape ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. If the Landscape image is not available, skins can make passable replacements by using fanart and overlaying the clearlogo.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|landscape
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 1000w x 562h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

== poster ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the video.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|poster
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1000w x 1500h
|-
| Aspect Ratio
| 2:3
|-
| Transparent background
| No
|}

== spine ==
'''Used in:''' {{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}

Album spines replicate the album spine found on standard CD cases. They typically have the name of the album and artist, but are too thin to have much of a design beyond continuing the front or back image. They are often used as thin identifiers for unfocused items in a list of albums.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|spine
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 50w x 1000h
|-
| Aspect Ratio
| 1:20
|-
| Transparent background
| No
|}

== thumb ==

=== Video Library ===
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

''Thumb'' is the most basic art type (and the oldest historically) used by {{Kodi}} skins. The properties differ depending on the area of {{kodi}} it is being used in. Skins often show this type of art both full size, and also as a small icon alongside each item in a list.

This art type hold thumbnails that are still images from the movie itself, and can be generated from the video file in your library. They are also used as images for episodes in TV Shows.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|thumb
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 960w x 540h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

=== Music Library ===
'''Used in:''' {{highlight|[[Music_artwork|Music- Artists artwork]]|color=#72d2f7}}
{{highlight|[[Music_artwork|Music- Albums artwork]]|color=#72d2f7}}
{{highlight|[[Music_artwork|Source Folder Icons]]|color=#b1d9b6}}

This art type holds high quality images of the album front cover or square (or near to square) artist images. The artist images usually show the whole band without any text or logos. Kodi will recognise a variety of file names and load them as a ''thumb'', these file names can be adjusted by entries in ''[[Advancedsettings.xml#musicthumbs|advancedsettings.xml]]''. The export facility will export this art type as ''folder.jpg'' which may mean duplicated artwork if you used the thumb filename in local art and export artwork to the same location.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|folder, cover or thumb
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 500w x 500h
|-
| Aspect Ratio
| 1:1
|-
| Transparent background
| No
|}

= Other Types =
This section lists other artwork types that are...
# Still in the experimental stage, or
# Still in use, but being phased out, and
# Used by only a small number of skins at this time, usually for one of the previous two reasons

== Animated Artwork ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

Still experimental, but {{kodi}} has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

=== Limitations of animated artwork ===
Kodi's support for displaying animated artwork is basic, and does have some limitations.

Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
* Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
** 1920 × 1080 = 2,073,600 * 11 =
*** 22,809,600 pixels '''plus''' one more frame

Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.

== extrafanart Folder ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}
{{highlight|[[Movie sets artwork]]|color=#ddffdd}}
{{highlight|[[Music Video artwork]]|color=#ffc7ff}}
{{highlight|[[TV-Show artwork]]|color=#f5f5a1}}

This method is slowly being phased out in favour of the ''fanart#'' method described in the previous section

<section begin="ExtrafanartFolder" />It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

In v17 and prior, Extra Fanart is stored in a separate folder named '''''extrafanart'''''. Create a folder named '''''extrafanart''''' in the folder of the movie or the TV Show, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins access the folder directly. A downside to this method is that it can wake hard drives while browsing the library and cause freezing of the GUI while the drives wake up. The filename is mostly not important.

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|fanart
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg or png
|-
| Resolution
| 1920w x 1080h<br>
3840w x 2160h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

== extrathumbs Folder ==
{{anchor|Extra Thumbs}}
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images.

This artwork is not in common use.

== poster# - character poster sets ==
'''Used in:''' {{highlight|[[Movie artwork]]|color=#ddddff}}

This is multiple posters and has the same specifications as Posters above.

These multiple posters are released as a set which displays the characters of the movie. Each poster in the set highlights one character and there can be up to 20 poster per movie. There can be multiple sets per movie, each set differing in style. Each poster in the set is designed to have a fixed position order, usually because they can be placed edge to edge to create a larger artwork.

The intention is that they are displayed in a multiimage sideshow. More information and examples can be found [https://forum.kodi.tv/showthread.php?tid=345299 in this thread].

== Source Folder Icon ==
<section begin="SourceFolderArtwork" />The Source Folder icon is a landscape image that can be used to replace the standard folder icons when browsing your '''sources''' in the video menu. This image file is saved directly within the Source directory.

To enable the image...
#Navigate to Videos>Files in the menu system
#Highlight a source and call up the '''''[[Basic_controls#Context_Menu|context menu]]'''''
#Select ''Choose Thumbnail''.
If you have saved in 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. Deleting the image will remove it from view in the folder icon.

You are able to apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows

<syntaxhighlight lang="xml" line='line'>
<source>
<name>Movies</name>
<path pathversion="1">F:\Movies\</path>
<allowsharing>true</allowsharing>
<thumbnail>F:\Movies\folder.jpg</thumbnail>
</source>
</syntaxhighlight>

{| class="prettytable"
|-
! colspan="2" style="text-align:center;" | Image specifications
|-
|Name
|folder
|-
|style="width:190px;"| Type
|style="width:220px;"| jpg
|-
| Resolution
| 640w x 360h
|-
| Aspect Ratio
| 16:9
|-
| Transparent background
| No
|}

= Artwork Usage Chart =
The following is a guide only and charts common usage. <sup>1</sup>

Artwork is skin dependant and skinners are free to use artwork how and where they choose. Some skins may conform with the following, others may not.

{| class="prettytable"
! colspan="11" style="text-align:center;" | Artwork Usage
|-
! colspan="1" style="text-align:right;" |
! colspan="2" style="text-align:center; background-color:#fdfefe" | Movies
! colspan="2" style="text-align:center; background-color:#fdfefe" | Music
! colspan="1" style="text-align:center;" |
! colspan="3" style="text-align:center; background-color:#fdfefe" | TV Shows
! colspan="1" style="text-align:center;" |
!
|-
! style="width:110px;" |
! style="width:150px; background-color:#ddddff"|Movie
! style="width:150px; background-color:#ddffdd"|Movie Sets
! style="width:150px; background-color:#72d2f7"|Artists
! style="width:150px; background-color:#72d2f7"|Albums
! style="width:150px; background-color:#ffc7ff"|Music Video
! style="width:150px; background-color:#f5f5a1"|TV Show
! style="width:150px; background-color:#f5f5a1"|Seasons
! style="width:150px; background-color:#f5f5a1"|Episodes
! style="width:5px; background-color:#"|
! style="width:150px; background-color:#b1d9b6"|Source Folder
|-
!scope="row"| actor || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| back || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| banner || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| characterart || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| characterart# || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| clearart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| clearlogo || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| discart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| fanart || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| fanart# || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| keyart || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| landscape || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} |||| {{No}}
|-
!scope="row"| poster || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} |||| {{No}}
|-
!scope="row"| spine || {{No}} || {{No}} || {{No}} || {{Yes}} || {{No}} || {{No}} || {{No}} || {{No}} |||| {{No}}
|-
!scope="row"| thumb || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{Yes}} || {{No}} || {{No}} || {{Yes}} |||| {{Yes}}
|}

:<sup>1</sup> “Common usage” here means that the scrapers can return this type of art, and/or it is displayed by one or more skins in the official Kodi repo.

= Sample Images =
Screenshots of various artworks displays.

== Movies ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-DiscArt01.jpg|Movie discart
File:Artwork-Thumbs01.jpg|Movie landscape
</gallery>

== TV Shows ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-PosterView02.jpg|TV show poster
File:Artwork-FanartView03.jpg|TV show fanart
File:Artwork-Banner01.jpg|TV show banner
File:Artwork-ClearArt02.jpg|TV show clearart
File:Artwork-ClearLogo02.jpg|TV show clearlogo
File:Artwork-Landscape01.jpg|TV show landscape
File:Artwork-CharacterArt01.jpg|TV show characterart
File:Artwork-EpisodeThumb01.jpg|Episode thumb
File:Artwork-EpisodeFanart01.jpg|Episode fanart
</gallery>

== Music ==
<gallery mode="packed" widths="500px" heights="282px">
File:Artwork-MusicFanart01.jpg|Artist fanart
File:Artwork-MusicArtist01.jpg|Grid of artist thumb
File:Artwork-MusicBanner01.jpg|Artist banner and clearlogo
File:Artwork-TS-clearart-AeonNox5modmaybe.jpg|Artist clearart in center right
File:Artwork-musiclandscape-EstuaryATF.jpg|Grid of artist landscape
</gallery>

= References =
<references />

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Video file tagging

2019-05-19T01:10:55Z

Rmrector: light clarification

{{mininav|[[Video library]]||}}
{{incomplete}}
{{notice|This feature is currently for movies only. TV Shows and music videos are not yet supported.}}
{{VideoLibraryCreate}}
'''{{red|{{resize|1.3em|This page describes an EXPERIMENTAL and alternative way of adding Movies only to the library that is not dependent on file names or online scrapers.}}}}'''

'''{{red|{{resize|1.3em|If you have already named and organized your files using Kodi's naming guidelines, then you can safely ignore this page and go to the next step.}}}}'''

<section begin="intro" />Kodi v18- Leia introduces support for embedded video tags using '''*.mkv''' and '''*.mp4''' video files. They are similar in principle to the tags saved in audio files. Only limited movie support is available at this time.<section end="intro" />

= Benifits of embedded video tags =
There are multiple reasons why one would want to use this feature:
Media may already contain useful metadata (the reverse however is also true - many files contain "junk" metadata, hence why the feature defaults to off).
It gives one more control over the metadata than scrapers do (as scrapers may misclassify media and pull the wrong data).
It does away with the need to have .nfo files. Since metadata travels with the media file, there is no longer a need for potentially thousands of these smaller files and can make directory management even easier.
Using ultra-high resolution Artwork/cover images that looks nicer on newer HD displays.(Pretty pictures!)

== How does it change/differ to the old model? ==
Kodi has two options for metadata import: using an online scraper or using local information, traditionally in the form of .nfo files. local tag reading is bundled into the "Local Information" arm, as logically, metadata is still local (i.e not network-drawn) information. Thus, one can still use a combination of .nfo files and embedded information if they choose "Local Information" rather than to use a scraper.

It is important to note however that .nfo files will override embedded information. Not all of Kodi's NFO features are supported by embedded metadata yet, so many users may wish to still use the NFO method. (https://forum.kodi.tv/showthread.php?tid=326340.

== Settings ==
The {{kodi}} settings has the option to enable or disable the reading of video file tags. The default setting is disabled.<br />
{{red|link to settings page here- Settings>Media Settings>Videos>Use video tags}}

This page assumes this setting has been enabled.

= Folder & File Structure =
The use of Video File Tags does not absolve you from using the correct Folder and File structure for Movies, TV Shows and [[Music_videos|Music Videos]] as detailed in the previous pages. Use the navbox above to locate and read those requirements.

= Tagging =
{{no endorsement notice}}

{{note|User-friendly options for adding and editing embedded metadata may be lacking for your given platform. Be prepared for challenges when going down this path.}}

== Windows ==
mp3tag is a Windows based metadata editor for many different files types, including MP4 (despite what it's name may suggest). While somewhat complex, it provides very fine-grained control over tagging, and is a worthwhile asset in any media management library.

MetaX is a user friendly tagging solution, However it is proprietary and paid ($10). It features much the same core features as MP3tag, but adds an online search functionality to grab metadata from providers such as iTunes, Amazon and others, as well as an autotag feature. This can be useful to people with enormous media collections where the time saved manually tagging justifies the price.

== Mac ==
;MP4 tagging:
* [https://griff.github.io/metaz/ MetaZ] is a free and open source metadata lookup and editor for Mac OS.

== Linux ==

= A note on iTunes =
Apple, in their wisdom, have created a subset of tags that are strictly speaking only meant for use with iTunes. However, most tagging software can read and write these iTunes tags. These tags are also quite useful But will not work with Kodi. Tags include the ability to store Cast (actors), Screenwriter and Director information, as well as age restriction data such as MPAA ratings.

The important point to note here is that just because your tagging software allows you to add these does not mean they will be used. After all, they are unstandardized and were created by Apple solely for use with iTunes and iOS/macOS devices.

= Core Tags =

While there are an absolute myriad of tags that one can use, many, if not most of these are unnecessary for video files. Remember that MP4 tags have to have fields for everything - TV shows, movies, music videos and Music! We do not want to populate tags related to music (Such as Artist) in a movie file! As such here are some of the most critical tags for video (TV show and Movie) files.

== Title ==
It seems that Kodi will not import a media file without a valid title in the metadata tag. This makes it the most critical tag of all.

Title also differs from Filename - I may have a file called Blade_Runner_2049_(2017)Withalotofexcessinformation.mp4, But the title value can simply be "Blade Runner 2049". Kodi will then display "Blade Runner 2049).

== Description ==
This describes the movie/TV Show. A snippet from iTunes' description of Blade Runner 2049 is as follows: "Thirty years after the events of the first film, a new blade runner, LAPD Officer K (Ryan Gosling), unearths a long buried secret that has the potential to plunge what’s left of society into chaos."

Descriptions thus actually describe the character or basic plot of a movie or TV Show. These will be displayed in Kodi when the file is selected.

Best practice at this point seems to be to mirror the Long Description and Short Description, as there does not seem to be any practical distinction between the two.

When using this tag with TV Shows, every episode can be individually described according to the plot of that particular episode.

== Content Type ==
In MP4 there should be four choices: Music, Music Video, Movie and TV Show. The choice does not seem to matter at this point as Kodi can not distinguish files based on this tag, but rather relies on the manual setting when the directory was added. It might be useful to set this properly when tagging however, as a future change to allow Kodi to distinguish these tags may prove invaluable.

== Cover/Picture ==
Probably the singular greatest benefit to tags is being able to set your own cover image. Don't like the standard cover? Use the collectors Edition or Digital Download cover.

== TV Show Specific Tags ==
There are three more tags that should be filled in for TV Shows: Show, Season and Episode Number. At the moment these tags do not seem to be of any practical use in Kodi, but should nevertheless be filled out as this may change.

= Supported Tags =

{{red|are the tags in this table for both mkv and mp4?}}

Both MP4 and MKV tags are supported, although they use fundamentally different methods of encoding metadata.

{{red|Is it ok to remove the music related tags? Are they separated accurately?}}

{{red|I cannot find these video related tags in mp3tag}}

To get to all the juicy video file related tags in mp3tag, right click on your video file and select "Extended Tags". From here one can see all the tags currently in a file. Add new ones by clicking on the Add button, selecting a Field (what tag to edit" and entering a value. The most critical one in all cases is TITLE, as it seems Kodi will not add a media file if this core tag is missing (and there is no .nfo file).

This will also allow you to add the cover artwork.

{{red|What format is this- id3, APE, Generic, MP4, other?}}

MP4 files use "moov" atoms embedded within the file. These are the same ones used in AAC audio files (such as m4a).

{{red|IMDBURL/TMDBURL is this one tag or two separate tags?}}

== MP4 tag options ==

The below table shows the ''mp4tags'' (part of mp4v2) command line options for all standard MP4 tags, Kodi roughly supports the ones applicable to movies.

{| class="prettytable"
|-
! colspan="4" style="background-color:#a1f5e4;" | Video File Tags
|+
! style="background-color:#f5f5a1; text-align:left; width:050px" | ?
! style="background-color:#f5f5a1; text-align:left; width:100px" | Tag
! style="background-color:#f5f5a1; text-align:left; width:050px" | Type
! style="background-color:#f5f5a1; text-align:left; width:450px" | Description
|-
| -B
| -podcast
| NUM
| Set the podcast flag
|-
| -c
| -comment
| STR
| Set a general comment
|-
| -C
| -copyright
| STR
| Set the copyright information
|-
| -e
| -encodedby
| STR
| Set the name of the person or company who encoded the file
|-
| -E
| -tool
| STR
| Set the software used for encoding
|-
| -g
| -genre
| STR
| Set the genre name
|-
| -G
| -grouping
| STR
| Set the grouping name
|-
| -H
| -hdvideo
| NUM
| Set the HD flag (1\0)
|-
| -i
| -type
| STR
| Set the Media Type(tvshow, movie, music, ...)
|-
| -I
| -contentid
| NUM
| Set the content ID
|-
| -j
| -genreid
| NUM
| Set the genre ID
|-
| -l
| -longdesc
| STR
| Set the long description
|-
| -m
| -description
| STR
| Set the short description
|-
| -M
| -episode
| NUM
| Set the episode number
|-
| -n
| -season
| NUM
| Set the season number
|-
| -N
| -network
| STR
| Set the TV network
|-
| -o
| -episodeid
| STR
| Set the TV episode ID
|-
| -O
| -category
| STR
| Set the category
|-
| -p
| -playlistid
| NUM
| Set the playlist ID
|-
| -P
| -picture
| PTH
| Set the picture as a .png
|-
| -r
| -remove
| STR
| Remove tags by code (e.g. "-r cs" removes the comment and song tags)
|-
| -S
| -show
| STR
| Set the TV show
|-
| -X
| -rating
| STR
| Set the Rating(none, clean, explicit)
|-
| -y
| -year
| NUM
| Set the release date
|-
|
| -help
|
| Display this help text and exit
|-
|
| -version
|
| Display version information and exit
|-
! colspan="4" style="background-color:#a1f5e4;" | Music File Tags- TO BE REMOVED FROM LIST? or is it used for Music Videos?
|+
! style="background-color:#f5f5a1; text-align:left; width:050px" | ?
! style="background-color:#f5f5a1; text-align:left; width:100px" | Tag
! style="background-color:#f5f5a1; text-align:left; width:050px" | Type
! style="background-color:#f5f5a1; text-align:left; width:400px" | Description
|-
| -A
| -album
| STR
| Set the album title
|-
| -a
| -artist
| STR
| Set the artist information
|-
| -b
| -tempo
| NUM
| Set the tempo (beats per minute)
|-
| -d
| -disk
| NUM
| Set the disk number
|-
| -D
| -disks
| NUM
| Set the number of disks
|-
| -L
| -lyrics
| NUM
| Set the lyrics
|-
| -R
| -albumartist
| STR
| Set the album artist
|-
| -s
| -song
| STR
| Set the song title
|-
| -t
| -track
| NUM
| Set the track number
|-
| -T
| -tracks
| NUM
| Set the number of tracks
|-
| -w
| -writer
| STR
| Set the composer information
|-
| -z
| -artistid
| NUM
| Set the artist ID
|-
| -Z
| -composerid
| NUM
| Set the composer ID
|}

== MKV tag options ==

MKV tagging currently does not support the Matroska tagging "spec" to fill library info, rather a Kodi standard NFO file can be embedded into MKV files.

* An attachment named '''kodi-metadata''' will be scanned as an embedded .nfo file
* An attachment named '''kodi-override-metadata''' will be scanned as a url nfo if combined with specifying IMDB/TMDB url. if alone, you get an override nfo

= Artwork =
For MKV you can have embedded images. currently limited to:
* 'small_cover.png' or 'small_cover.jpg' for thumbnails
* 'cover.png' or 'cover.jpg' for posters
* 'fanart.png' or 'fanart.jpg' for fanart

'poster' images can be embedded in MP4 files.

{{top}}

<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Adding_video_sources|'''Add Source & Scrape''']]}} </div>

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:How-to]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:General topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Movie artwork

2019-05-11T02:30:25Z

Rmrector: /* Multiple fanart */ add long artwork filename

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The default name for movie artwork file names is '''<movie file name>-<arttype>.<ext>''' - with some arttype examples listed below and extension matching the image type. There is also a short name "<arttype>.<ext>" that can be used if your movie source folder is configured with [[Adding video sources#Set Content |Movies are in separate folders that match the movie title]], but the long name "<movie file name>-<arttype>.<ext>" still takes precedence. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| movie file
| Blade Runner 2049 (2017).mkv
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017).mkv
|
|
|- valign="top"
| width=100px |'''''Artwork type'''''
| width=200px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\clearlogo.jpg
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\clearart.jpg
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\keyart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\thumb.jpg
| 960x540
| match video aspect
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg
f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart1.jpg
f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart2.jpg
f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Import-export library

2019-03-24T18:28:16Z

Rmrector: copy "a note on artwork" from Artwork/Cache

{{mininav|[[Video_library|Video Library]]{{l2|[[Music_library|Music Library]]}}}}
{{see also|NFO files|Artwork|HOW-TO:Backup_the_video_library}}

= Introduction =
<section begin="intro" />Kodi offers the ability to import and export metadata and artwork 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, in a form that can be transfered.

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 media classes:
*Movies- Metadata and artwork
*TV Shows- Metadata and artwork
*Music Videos- Metadata and artwork

By adding suitable code to ''advancedsettings.xml'', you are able to further modify which data is exported and imported. The following three tags are availble... {{small see also|Advancedsettings.xml}}
<pre>
<advancedsettings>
<videolibrary>
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
</videolibrary>
</advancedsettings>
</pre>

In settings, select '''Export library''' as shown in the first image. Ensure you choose the option in the Video library section (top) and not the Music library section (bottom). You will be required to choose the Export method as depicted in the second image. 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]]
'''Note''': Do not use this option if you have changed, or intend to change, the filenames or paths of your video files after running the Export. For example, renaming movie files, moving files between Sources or to new Sources. Doing so will leave you with a dead library. The data will be imported but Kodi will not be able to locate the moved files. Use the Separate files method instead.

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|Updating_or_removing_videos}}

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.

<section begin="MusicExportSingleFile" />{{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}}<section end="MusicExportSingleFile" />

'''{{red|The music section of v18 is undergoing a major overhaul and this issue will be resolved with the release of v18}}'''

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
{{-}}

== 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. {{see also|Update_Music_Library}}

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.

= A Note on Artwork =

The optimized image from {{Kodi}}'s [[Artwork/Cache]] is exported, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible. An easily understandable explanation of the effects of these optimizations can be located in the [https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318 forum here].

= 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}}

For an explanation of what artwork is exported and imported '''''See: [[Music_Video_artwork]]

= Pictures =
The Pictures section of Kodi is simply an Image Browser. It does not use a library database. Therefore you cannot Import or Export pictures.



{{top}}

{{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]]

Artwork

2019-03-23T18:50:40Z

Rmrector: /* Kodi- Choose Art */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} |[[HOW-TO:Create_Music_Library|Create Music Library]] {{l2|[[HOW-TO:Create_Video_Library|Create Video Library]]}}}}

<section begin="intro" />The use of artwork takes pride of place in Kodi. The 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" />

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Choose the subject that interests you to obtain further information. Information common to all categories is located on this page. Specific category details are located on linked pages.

'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''

= Flexible artwork types =

<gallery mode="packed" widths=350px heights=200px>
File:Artwork-PosterView01.jpg
File:Artwork-FanartView01.jpg
File:Artwork-Banner01.jpg
File:Artwork-PosterView02.jpg
File:Artwork-MusicArtist01.jpg
File:Artwork-ClearLogo02.jpg
</gallery>

{{Kodi}}'s support for artwork types to represent media items is very flexible: Any number of artwork can be added to a media item with free-form names that have only a few rules.

To view all art types that are already assigned in your Kodi library for any particular media type, use Kodi's built-in [[Artwork#Kodi- Choose Art| Choose Art]] dialog on nearly any item in the library (movie, TV show, episode, so on), and the list of artwork types shown on this window are assigned to at least one media item of the same type.

== Naming rules ==

* artwork names must be
** only alphanumeric characters
** lowercase letters
** keep them short - 20 characters is a bit long, though not forbidden
* Named by convention so that skins and JSON-RPC consumers can find and use them reliably
* Some common types of artwork are "fanart", "clearlogo", "landscape", "banner", and "poster"

== Artwork whitelist ==

Starting with Kodi 18, there is a whitelist configuration for artwork types to be added automatically. This whitelist applies to all artwork added automatically by Kodi, either when scanning in local files or scraping from online sources. This allows you to share one media file library with a full artwork selection and configure individual Kodi clients separately based on processing power, skin selection, or client-local storage space (the local artwork cache takes up the most space of all Kodi running data). It is currently configured with advancedsettings.xml '''[[Advancedsettings.xml#Extra artwork| for the video library]]''' and '''[[Advancedsettings.xml#Extra artwork 2| for the music library]]'''.

= Obtaining Artwork =
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.

== Scrapers ==
A scraper is a Kodi core function which, in combination with the relevant metadata API add-on, will preform an automatic online search for movie, tv show and music information and then retrieve all relevant metadata and artwork and import the data into the Kodi Library and the artwork into the [[Artwork#Cache|cache]]. The default sources for information are:

Movies- [https://www.themoviedb.org/ The MovieDB]<br />
TV Shows- [http://thetvdb.com/ The TVDB]<br />
Music- [http://www.theaudiodb.com/ The AudioDB]<br />
<br />
There are many other scraper information sources, but most are specialist listings for foreign language movies or Disney movies, for example.

The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.

The Music scraping process is reliant on correct file naming and music tags.

Kodi will then match the video or music and download all relevant metadata and artwork. It is important to note that if you already have correctly named artwork in the video and music folder, then Kodi will scrape the local artwork and ignore the online source. Metadata will still be downloaded though.

If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to [[Artwork#Kodi-_Choose_Art|paragraph 2.1]] below.
; {{see also|Naming video files}}
; {{see also|Add-on:The Movie Database}}
; {{see also|Add-on:The TVDB}}
; {{see also|Add-on:Universal Album Scraper}}
; {{see also|Add-on:Universal Artist Scraper}}

== 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 ==
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/documentation/editing/images<nowiki>themoviedb- Image Creation Guide</nowiki>]''
*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>]''

= Importing-Scanning Artwork =
{{anchor|Importing-Scraping Artwork}}

This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.

'''When performing an Update Library or Scrape, Kodi will always use Local Artwork first if it exists. If there is no local artwork, Kodi will obtain the artwork from online sources.'''

'''It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans.''' If you have made changes to either 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 [[Music_artwork]]
#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]]'''''

== "Available" artwork ==

Scrapers and NFO files can include multiple images for a single type of artwork. The first image will be assigned to the media item for skins and other interfaces to access for display, and the full list will be saved for the "Choose art" dialog, where you can select a new image for any art type.

== Kodi- Choose Art ==
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

#Highlight the media item whose artwork you want to change.
#Call up the ''Information'' page, (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 Page
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 scraper site, 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:
#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 artwork and metadata - Select '''No''' note- If you have no local nfo file, Kodi will scrape metadata from the online scraper site
#*To scrape online artwork and metadata - Select '''Yes'''

= Artwork details for media sections =

<gallery mode="packed" widths=350px heights=200px>
File:Skin.rapier fullscreen music.jpg
File:Artwork-MusicBanner01.jpg
File:Artwork-FanartView02.jpg
File:Rapier new tvshows.jpg
File:Artwork-Animated01.gif
File:Artwork-musiclandscape-EstuaryATF.jpg
</gallery>

== Movie Artwork ==
{{#lst:Movie_artwork|intro}}
{{see|Movie artwork}}

== TV Show Artwork ==
{{#lst:TV-Show_artwork|intro}}
{{see|TV-Show artwork}}

== Music Artwork ==
{{#lst:Music_artwork|intro}}
{{see|Music artwork}}

== Music Videos Artwork ==
{{#lst:Music_Video_artwork|intro}}
{{see|Music Video artwork}}

== Live TV Artwork ==
{{#lst:Live_TV_Artwork|intro}}
{{see|Live TV Artwork}}

== Pictures Artwork ==
There is no user definable artwork for the Pictures section of Kodi.<br />
:'''''See: [[Pictures]]

All images added to Pictures are cached as follows:
#Embedded EXIF previews are scanned and cached. If none available then
#Preview images are created and cached
:'''''See: [[Artwork#Cache|Artwork Cache]]'''''<br />

To add an image to the folder icon:
:'''''See: [[Movie_artwork#Source Folder Artwork|Folder Image]]'''''

= 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 ==
{{#lst:import-export_library|intro}}
; {{see also|Import-export library}}

= 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}}

= Animated artwork - experimental =

Kodi has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

== Limitations of animated artwork ==

Kodi's support for displaying animated artwork is basic, and does have some limitations.

Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
* Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
** 1920 × 1080 = 2,073,600 * 11 =
*** 22,809,600 pixels '''plus''' one more frame

Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.

= Accessing with skins and JSON-RPC =
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
; {{see also|Artwork/Accessing with skins and JSON-RPC}}

{{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]]

Music artwork

2019-02-22T02:28:50Z

Rmrector: /* Experimental music artwork */ "extrafanart" folder hack doesn't work in the music library

{{MusicLibraryCreate}}
{{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, but this page will describe the types of artwork readily available for the Music library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
*To ensure '''local artwork''' is added when scanning new media items, the image files must be arranged in a certain folder hierarchy. See [[Music tagging#Folder_and_File_Structure| Music folder and file structure]] for a basic option and the [[Artist information folder]] for a separate directory option just for artist artwork and NFO files.
* Each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.
* Kodi 18 is required for expanded artwork type support in the music library.

= Artist artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-MusicFanart01.jpg|Artist fanart
File:Artwork-MusicArtist01.jpg|Grid of artist thumb
File:Artwork-MusicBanner01.jpg|Artist banner and clearlogo
File:Artwork-TS-clearart-AeonNox5modmaybe.jpg|Artist clearart in center right
File:Artwork-musiclandscape-EstuaryATF.jpg|Grid of artist landscape
</gallery>

== Artist "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience. The fanart displays the artist or band.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Artist "thumb" ==
Artist thumbnails display the artist or band members, and are often paired with an artist logo or title of the band.

Artist thumbnails have a '''recommended resolution of 1000x1000''', with a '''square (1:1) to somewhat portrait aspect ratio'''. They do not have transparency and preferably do not have a logo or artist name on the image.

== Artist "banner" ==
Artist banners are wide and short images that contain the artist or band members and typically includes a clearly visible logo or the name of the band.

Artist banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Artist "clearlogo" ==
Artist logos typically use the distinctive font associated with the musicians and is uncluttered by other images.

Artist logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Artist "clearart" ==
Artist clearart have a transparent background with an image of the artist or band along with their logo or name.

Artist clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Artist "landscape" ==
Landscape images are specially made 16x9 images that contain an image of the artist or band and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Artist landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Local artist artwork ==

Local artist artwork can be saved in the '''[[Artist information folder]]''' or a '''[[Music tagging#Folder and File Structure| common artist folder among your music files]]''' if Kodi can find one. The general rule for artist artwork file names is "<arttype>.<ext>" with some arttype examples listed below and extension matching the file type. Artist artwork can also be added from online services with an '''[[Scraping Music| "information provider" scraper add-on]]'''. * "folder.jpg" to "thumb" is a special case for the music library.

<div style="{{linear-gradient|top|#f5e3ff, #72d2f7}}">
'''''Example naming convention for locally saved artist artwork:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=400px |'''''Save name & location example'''''
| width=300px |'''''Recommended resolution'''''
| width=500px |'''''Aspect ratio'''''
|- valign="top"
| width=300px |fanart
| width=250px |fanart.jpg
| width=400px |f:\Music\Madonna\fanart.jpg<br>h:\centralinfo\artists\Madonna\fanart.jpg
| width=300px |1920x1080
| width=500px |16:9
|- valign="top"
| width=300px |banner
| width=250px |banner.jpg
| width=400px |f:\Music\Madonna\banner.jpg<br>h:\centralinfo\artists\Madonna\banner.jpg
| width=300px |1000x185
| width=500px |1:0.185
|- valign="top"
| width=300px |landscape
| width=250px |landscape.jpg
| width=400px |f:\Music\Madonna\landscape.jpg<br>h:\centralinfo\artists\Madonna\landscape.jpg
| width=300px |1000x562
| width=500px |16:9
|- valign="top"
| width=300px |clearlogo
| width=250px |clearlogo.png
| width=400px |f:\Music\Madonna\clearlogo.png<br>h:\centralinfo\artists\Madonna\clearlogo.png
| width=300px |800x310
| width=500px |1:0.388
|- valign="top"
| width=300px |clearart
| width=250px |clearart.png
| width=400px |f:\Music\Madonna\clearart.png<br>h:\centralinfo\artists\Madonna\clearart.png
| width=300px |1000x562
| width=500px |16:9
|- valign="top"
| width=300px |thumb
| width=250px |folder.jpg *
| width=400px |f:\Music\Madonna\folder.jpg *<br>h:\centralinfo\artists\Madonna\folder.jpg *
| width=300px |1000x1000
| width=500px |approximately 1:1
|}
</div>

= Album artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-MusicAlbum01.jpg|Grid of album "thumb"
File:Artwork-MusicBanner01.jpg|"discart" in bottom left and bottom right
</gallery>

== Album "thumb" ==
Album thumbnails are high quality images of the album front cover. The design varies widely and may or may not include the name of the album and or artist.

Album thumbnails have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. Depending on design they can be somewhat wider or somewhat taller, and many skins are designed to accommodate that. They do not have transparency.

== Album "discart" ==
Album discart replicates the picture on the physical CD or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Album discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Album "back" ==
This is the album back cover, which often includes a track listing, though the design varies. They are often used in detail views focused on a single album.

Album backs have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. Depending on design they can be somewhat wider or somewhat taller to match the album cover. They do not have transparency.

== Album "spine" ==
Album spines replicate the album spine found on standard CD cases. They typically have the name of the album and artist, but are too thin to have much of a design beyond continuing the front or back image. They are often used as thin identifiers for unfocused items in a list of albums.

Album spines have a '''recommended resolution of 50x1000''' with an '''aspect ratio of 1:20'''. They do not have transparency.

== Local album artwork ==

Local album artwork can be saved in the '''[[Music tagging#Folder and File Structure| album folder]]'''. The general rule for album artwork file names is "<arttype>.<ext>" with some arttype examples listed below and extension matching the file type. Album artwork can also be added from online services with an '''[[Scraping Music| "information provider" scraper add-on]]'''. *"folder.jpg" to "thumb" is a special case for the music library.

<div style="{{linear-gradient|top|#f5e3ff, #72d2f7}}">
'''''Example naming convention for locally saved album artwork:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=250px |'''''Recommended resolution'''''
| width=600px |'''''Aspect ratio'''''
|- valign="top"
| width=300px |thumb
| width=250px |folder.jpg *
| width=600px |f:\Music\Madonna\Like A Prayer\folder.jpg *
| width=250px |1000x1000
| width=600px |approximately 1:1
|- valign="top"
| width=300px |discart
| width=250px |discart.png
| width=600px |f:\Music\Madonna\Like A Prayer\discart.png
| width=250px |1000x1000
| width=600px |1:1
|- valign="top"
| width=300px |back
| width=250px |back.jpg
| width=600px |f:\Music\Madonna\Like A Prayer\back.jpg
| width=250px |1000x1000
| width=600px |approximately 1:1
|- valign="top"
| width=300px |spine
| width=250px |spine.jpg
| width=600px |f:\Music\Madonna\Like A Prayer\spine.jpg
| width=250px |50x1000
| width=600px |1:20
|}
</div>

= 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|#f5e3ff, #72d2f7}}">
'''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|#f5e3ff, #72d2f7}}">
'''''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:\Music\Music.jpg
|}
</div>

= Experimental music artwork =

== Multiple fanart ==

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Multiple fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. Each individual fanart# must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

<div style="{{linear-gradient|top|#72d2f7, #f5e3ff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Music\Madonna\fanart.jpg
h:\centralinfo\artists\Madonna\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Music\Madonna\fanart1.jpg
h:\centralinfo\artists\Madonna\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Music\Madonna\fanart2.jpg
h:\centralinfo\artists\Madonna\fanart2.jpg
|}
</div>

= 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 =

# Local artwork files
#* Local artwork files next to your media items or in the "[[Artist information folder]]". These are expected to be mid-high quality level for display in an interface like Kodi.
#* all types of artwork can be saved to local artwork files
# Artwork embedded in tracks
#* Artwork embedded in individual tracks of an album. These are expected to be lower quality to reduce the size of the image duplicated to many song files.
#* Only supports the album front cover
# Online source from "information provider"/scraper
#* only if the option in Kodi settings -> Media -> Music -> "Fetch additional information during updates" is enabled
#* will only be set if there is no local or embedded artwork unless the option in Kodi settings -> Media -> Music -> "Prefer online information" is enabled
#* all types of artwork can be added from information providers

= File Mode =
File 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 does not provide the added benefits of Extended Artwork and Album/Artist metadata that the properly scanned and scraped library provides. As a result, Music Artwork is handled differently using this mode as follows:

*The only artwork displayed in File Mode is artist thumb and album thumb.
*You must have local artwork named and saved as detailed in the sections above.
*These images are not loaded automatically. The Artist or Album must be viewed once to allow Kodi to locate and cache the image.
*When '''Enable tag reading''' is '''''Enabled''''' the song must be viewed to allow Kodi to scan for embedded images if no local image is available.

Kodi looks for and caches artwork in the following order:
*'''For Artist artwork:'''
*#Local artwork named and saved as detailed in the sections above. There is no fallback image

*'''For Album artwork:'''
*#Local artwork named and saved as detailed in the sections above. If there is no local artwork then
*#If you have '''Enable tag reading''' set as '''''Disabled''''' in Settings>Media Settings>Music then there is no fallback image
*#If you have '''Enable tag reading''' set as '''''Enabled''''' in Settings>Media Settings>Music then Kodi will search for an embedded image to cache.

Be aware that if you use File Mode, then upgrade to Library Mode at a later stage, your existing cached artwork may interfere with the correct scanning and scraping of new artwork. There is no simple fix for this. Your choices are
#Manually amend the affected artwork as described in chapter 2 above
#Perform the [[Artwork/Cache#Advanced: delete textures13.db|delete textures13.db]] procedure. This will also affect your Video Library.

= {{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:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Artwork

2019-02-17T20:35:14Z

Rmrector: /* Flexible artwork types */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} |[[HOW-TO:Create_Music_Library|Create Music Library]] {{l2|[[HOW-TO:Create_Video_Library|Create Video Library]]}}}}

<section begin="intro" />The use of artwork takes pride of place in Kodi. The 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" />

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Choose the subject that interests you to obtain further information. Information common to all categories is located on this page. Specific category details are located on linked pages.

'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''

= Flexible artwork types =

<gallery mode="packed" widths=350px heights=200px>
File:Artwork-PosterView01.jpg
File:Artwork-FanartView01.jpg
File:Artwork-Banner01.jpg
File:Artwork-PosterView02.jpg
File:Artwork-MusicArtist01.jpg
File:Artwork-ClearLogo02.jpg
</gallery>

{{Kodi}}'s support for artwork types to represent media items is very flexible: Any number of artwork can be added to a media item with free-form names that have only a few rules.

To view all art types that are already assigned in your Kodi library for any particular media type, use Kodi's built-in [[Artwork#Kodi- Choose Art| Choose Art]] dialog on nearly any item in the library (movie, TV show, episode, so on), and the list of artwork types shown on this window are assigned to at least one media item of the same type.

== Naming rules ==

* artwork names must be
** only alphanumeric characters
** lowercase letters
** keep them short - 20 characters is a bit long, though not forbidden
* Named by convention so that skins and JSON-RPC consumers can find and use them reliably
* Some common types of artwork are "fanart", "clearlogo", "landscape", "banner", and "poster"

== Artwork whitelist ==

Starting with Kodi 18, there is a whitelist configuration for artwork types to be added automatically. This whitelist applies to all artwork added automatically by Kodi, either when scanning in local files or scraping from online sources. This allows you to share one media file library with a full artwork selection and configure individual Kodi clients separately based on processing power, skin selection, or client-local storage space (the local artwork cache takes up the most space of all Kodi running data). It is currently configured with advancedsettings.xml '''[[Advancedsettings.xml#Extra artwork| for the video library]]''' and '''[[Advancedsettings.xml#Extra artwork 2| for the music library]]'''.

= Obtaining Artwork =
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.

== Scrapers ==
A scraper is a Kodi core function which, in combination with the relevant metadata API add-on, will preform an automatic online search for movie, tv show and music information and then retrieve all relevant metadata and artwork and import the data into the Kodi Library and the artwork into the [[Artwork#Cache|cache]]. The default sources for information are:

Movies- [https://www.themoviedb.org/ The MovieDB]<br />
TV Shows- [http://thetvdb.com/ The TVDB]<br />
Music- [http://www.theaudiodb.com/ The AudioDB]<br />
<br />
There are many other scraper information sources, but most are specialist listings for foreign language movies or Disney movies, for example.

The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.

The Music scraping process is reliant on correct file naming and music tags.

Kodi will then match the video or music and download all relevant metadata and artwork. It is important to note that if you already have correctly named artwork in the video and music folder, then Kodi will scrape the local artwork and ignore the online source. Metadata will still be downloaded though.

If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to [[Artwork#Kodi-_Choose_Art|paragraph 2.1]] below.
; {{see also|Naming video files}}
; {{see also|Add-on:The Movie Database}}
; {{see also|Add-on:The TVDB}}
; {{see also|Add-on:Universal Album Scraper}}
; {{see also|Add-on:Universal Artist Scraper}}

== 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 ==
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/documentation/editing/images<nowiki>themoviedb- Image Creation Guide</nowiki>]''
*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>]''

= Importing-Scanning Artwork =
{{anchor|Importing-Scraping Artwork}}

This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.

'''When performing an Update Library or Scrape, Kodi will always use Local Artwork first if it exists. If there is no local artwork, Kodi will obtain the artwork from online sources.'''

'''It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans.''' If you have made changes to either 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 [[Music_artwork]]
#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]]'''''

== "Available" artwork ==

Scrapers and NFO files can include multiple images for a single type of artwork. The first image will be assigned to the media item for skins and other interfaces to access for display, and the full list will be saved for the "Choose art" dialog, where you can select a new image for any art type.

== Kodi- Choose Art ==
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

#Highlight the media item whose artwork you want to change.
#Call up the ''Information'' page, (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)
#* This dialog is filled with artwork already assigned to similar media items in the library. If your type of artwork is not listed, then use the '''Add art''' button. 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 Page
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 scraper site, 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:
#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 artwork and metadata - Select '''No''' note- If you have no local nfo file, Kodi will scrape metadata from the online scraper site
#*To scrape online artwork and metadata - Select '''Yes'''

= Artwork details for media sections =

<gallery mode="packed" widths=350px heights=200px>
File:Skin.rapier fullscreen music.jpg
File:Artwork-MusicBanner01.jpg
File:Artwork-FanartView02.jpg
File:Rapier new tvshows.jpg
File:Artwork-Animated01.gif
File:Artwork-musiclandscape-EstuaryATF.jpg
</gallery>

== Movie Artwork ==
{{#lst:Movie_artwork|intro}}
{{see|Movie artwork}}

== TV Show Artwork ==
{{#lst:TV-Show_artwork|intro}}
{{see|TV-Show artwork}}

== Music Artwork ==
{{#lst:Music_artwork|intro}}
{{see|Music artwork}}

== Music Videos Artwork ==
{{#lst:Music_Video_artwork|intro}}
{{see|Music Video artwork}}

== Live TV Artwork ==
{{#lst:Live_TV_Artwork|intro}}
{{see|Live TV Artwork}}

== Pictures Artwork ==
There is no user definable artwork for the Pictures section of Kodi.<br />
:'''''See: [[Pictures]]

All images added to Pictures are cached as follows:
#Embedded EXIF previews are scanned and cached. If none available then
#Preview images are created and cached
:'''''See: [[Artwork#Cache|Artwork Cache]]'''''<br />

To add an image to the folder icon:
:'''''See: [[Movie_artwork#Source Folder Artwork|Folder Image]]'''''

= 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 ==
{{#lst:import-export_library|intro}}
; {{see also|Import-export library}}

= 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}}

= Animated artwork - experimental =

Kodi has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

== Limitations of animated artwork ==

Kodi's support for displaying animated artwork is basic, and does have some limitations.

Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
* Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
** 1920 × 1080 = 2,073,600 * 11 =
*** 22,809,600 pixels '''plus''' one more frame

Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.

= Accessing with skins and JSON-RPC =
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
; {{see also|Artwork/Accessing with skins and JSON-RPC}}

{{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]]

Movie artwork

2019-02-12T02:31:39Z

Rmrector: /* Local movie artwork */

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The default name for movie artwork file names is '''<movie file name>-<arttype>.<ext>''' - with some arttype examples listed below and extension matching the image type. There is also a short name "<arttype>.<ext>" that can be used if your movie source folder is configured with [[Adding video sources#Set Content |Movies are in separate folders that match the movie title]], but the long name "<movie file name>-<arttype>.<ext>" still takes precedence. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| movie file
| Blade Runner 2049 (2017).mkv
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017).mkv
|
|
|- valign="top"
| width=100px |'''''Artwork type'''''
| width=200px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\clearlogo.jpg
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\clearart.jpg
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\keyart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\thumb.jpg
| 960x540
| match video aspect
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Movie artwork

2019-02-12T02:22:34Z

Rmrector: /* Local movie artwork */

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The default name for movie artwork file names is '''<movie file name>-<arttype>.<ext>''' - with some arttype examples listed below and extension matching the image type. There is also a short name "<arttype>.<ext>" that can be used if your movie source folder is configured with [[Adding video sources#Set Content |Movies are in separate folders that match the movie title]], but the long name "<movie file name>-<arttype>.<ext>" still takes precedence. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| movie file
| Blade Runner 2049 (2017).mkv
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017).mkv
|
|
|- valign="top"
| width=100px |'''''Artwork type'''''
| width=200px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 960x540
| match video aspect
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Movie artwork

2019-02-12T02:12:19Z

Rmrector: /* Local movie artwork */

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The general rule for movie artwork file names is '''<movie file name>-<arttype>.<ext>''' - with some arttype examples listed below and extension matching the image type. There is also a short name "<arttype>.<ext>" that can be used if your movie source folder is configured with [[Adding video sources#Set Content |Movies are in separate folders that match the movie title]], but the long name "<movie file name>-<arttype>.<ext>" still takes precedence. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| movie file
| Blade Runner 2049 (2017).mkv
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017).mkv
|
|
|- valign="top"
| width=100px |'''''Artwork type'''''
| width=200px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 960x540
| match video aspect
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Movie artwork

2019-02-12T01:10:46Z

Rmrector: /* Local movie artwork */

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The general rule for movie artwork file names is '''<movie file name>-<arttype>.<ext>''' - with some arttype examples listed below and extension matching the image type. There is also a short name "<arttype>.<ext>" that can be used if your movie source folder is configured with [[Adding video sources#Set Content |Movies are in separate folders that match the movie title]], but the long name "<movie file name>-<arttype>.<ext>" will always work. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| movie file
| Blade Runner 2049 (2017).mkv
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017).mkv
|
|
|- valign="top"
| width=100px |'''''Artwork type'''''
| width=200px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
| 960x540
| match video aspect
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Movie artwork

2019-02-09T00:51:12Z

Rmrector: /* Local movie artwork */

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The general rule for movie artwork file names is '''<arttype>.<ext>''' or '''<movie file name>-<arttype>.<ext>''' - with some arttype examples listed below and extension matching the file type. The short name "<arttype>.<ext>" can only be used if your movie source folder is configured with '''[[Adding video sources#Set Content |Movies are in separate folders that match the movie title]]''', but the long name "<movie file name>-<arttype>.<ext>" will always work. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg
| 960x540
| match video resolution
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Movie artwork

2019-02-08T02:12:55Z

Rmrector: /* Local movie artwork */

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The general rule for movie artwork file names is "<arttype>.<ext>" or "<movie file name>-<arttype>.<ext>" - with some arttype examples listed below and extension matching the file type. The short name can only be used if your movie source folder is configured with '''[[Adding video sources#Set Content |Movies are in separate folders that match the movie title]]'''. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg
| 960x540
| match video resolution
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

User:Rmrector

2019-02-02T20:01:26Z

Rmrector: /* Merged */

=== v18 Artwork updates ===
* ''Nothing in progress''
* But still need to update the Music Videos pages

==== Merged ====
* [[User:Rmrector/Artwork/Accessing with skins and JSON-RPC - new]]
* [[User:Rmrector/Artwork - updates for Kodi 18]]
* [[User:Rmrector/Music artwork - for Kodi 18]]
* [[Movie artwork]] - updated directly
* [[TV-Show artwork]] - updated directly

User:Rmrector

2019-02-02T20:01:05Z

Rmrector: /* Merged */

User:Rmrector

2019-02-02T20:00:54Z

Rmrector: /* v18 Artwork updates */

Movie artwork

2019-02-02T19:56:01Z

Rmrector:

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails are often displayed in small boxes and have a '''recommended resolution of about 960x540'''.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The general rule for movie artwork file names is "<arttype>.<ext>" or "<movie file name>-<arttype>.<ext>" - with some arttype examples listed below and extension matching the file type. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\fanart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\poster.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\banner.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\landscape.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\clearlogo.png<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\clearart.png<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\keyart.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\thumb.jpg<br>f:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg
| 960x540
| match video resolution
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

= Actor Image =
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

TV-Show artwork

2019-02-02T19:55:18Z

Rmrector:

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />TV Show artwork are images directly related to a TV Show, preferably of high quality, that are displayed when viewing the entry in the library. The artwork support in {{Kodi}}'s video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the TV show library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= TV show artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-PosterView02.jpg|TV show poster
File:Artwork-FanartView03.jpg|TV show fanart
File:Artwork-Banner01.jpg|TV show banner
File:Artwork-ClearArt02.jpg|TV show clearart
File:Artwork-ClearLogo02.jpg|TV show clearlogo
File:Artwork-Landscape01.jpg|TV show landscape
File:Artwork-CharacterArt01.jpg|TV show characterart
File:Artwork-EpisodeThumb01.jpg|Episode thumb
File:Artwork-EpisodeFanart01.jpg|Episode fanart
</gallery>

== TV show "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== TV show "poster" ==
TV show posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name.

TV show posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== TV show "banner" ==
TV show banners are wide and short images that contain recognizable characters or props and typically includes a clearly visible logo or the name.

TV show banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== TV show "clearlogo" ==
TV show logos typically use the distinctive font associated with the TV show and is uncluttered by other images.

TV show logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== TV show "clearart" ==
TV show clearart have a transparent background with recognizable characters or props along with a logo or name.

TV show clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== TV show "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

TV show landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== TV show "characterart" ==
TV show character art is an image of the main or prominent character in a TV show. It uses a transparent background in a similar fashion to clearlogo and clearart.

TV show characterart have a '''recommended resolution of 800x310''' with an '''aspect ratio of 16:9'''. They have a transparent background.

== TV show "keyart" ==
TV show keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

TV show keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local TV show artwork ==

Local TV show artwork can be saved in the top level folder [[Naming_video_files/TV_shows#Recommended|of the TV show]]. The general rule for TV show artwork file names is "<arttype>.<ext>", with some arttype examples listed below and extension matching the file type. TV show artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Example naming convention for locally saved TV show artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=450px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\TVShows\Angel\fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\TVShows\Angel\poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\TVShows\Angel\banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\TVShows\Angel\landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\TVShows\Angel\clearlogo.png
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\TVShows\Angel\clearart.png
| 1000x562
| 16:9
|- valign="top"
| characterart
| characterart.jpg
| f:\TVShows\Angel\characterart.jpg
| 800x310
| approximately 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\TVShows\Angel\keyart.jpg
| 1000x1500
| approximately 1:1.5
|}
</div>

= Season artwork =

== Season "poster" ==
Season posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name and season number.

Season posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Season "banner" ==
Season banners are wide and short images that contain recognizable characters or props and typically includes a clearly visible logo or the name and season number.

Season banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Season "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props and a logo and season number. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and season name / number.

Season landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Local season artwork ==

Local Season artwork can be saved in the top level folder [[Naming_video_files/TV_shows#Recommended|of the TV show]]. The general rule for Season artwork file names is "season<num>-<arttype>.<ext>", with some arttype examples listed below and extension matching the file type - artwork can be saved for the "Specials" season as "season-specials-<arttype>.<ext>" and "season-all-<arttype>.<ext>" for the "All seasons" entry. Season artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Example naming convention for locally saved Season artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=450px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| poster
| poster.jpg
| f:\TVShows\Angel\season01-poster.jpg
f:\TVShows\Angel\season-specials-poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\TVShows\Angel\season01-banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\TVShows\Angel\season01-landscape.jpg
| 1000x562
| 16:9
|}
</div>

= Episode artwork =

== Episode thumbnail ==
The Episode Thumbnail is an individual and specific image to a particular episode. It usually is a snapshot of a memorable scene in that particular episode.

These images are often shown in a small box with several on screen at once, so have a '''recommended resolution of about 960x540'''.

== Episode fanart ==

The Episode fanart is a high resolution press-shot or capture of a particular episode. It usually is a snapshot of a memorable scene in that particular episode.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image.

== Local episode artwork ==

Local episode artwork can be saved next to the [[Naming_video_files/TV_shows#Recommended|episode file]]. The general rule for episode artwork file names is "<episode filename>-<arttype>.<ext>", with some arttype examples listed below and extension matching the file type. Episode artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Example naming convention for locally saved episode artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=450px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| thumb
| thumb.jpg
| f:\TVShows\Angel\Angel - 01x01 - City Of-thumb.jpg
| 960x540
| match video resolution
|- valign="top"
| fanart
| fanart.jpg
| f:\TVShows\Angel\Angel - 01x01 - City Of-fanart.jpg
| 1920x1080
| 16:9
|}
</div>

= Actor Image =
[[File:Artwork-Actors01.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification.

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

{{Red|It is important to note the following limitation with actor artwork. Kodi cannot download actor images for every listed actor in the show. This is due to a limitation with the TMDB and TVDB scraper sites. Those sites list only biographical data and images for the '''main cast actors''' only. Episode actors (those actors that appear in only one or two episodes) are line entries at the scraper sites, which means that the actor has no profile page or image attached to them.}}

{{red|If that episode actor is a main cast actor in another tv show or movie listed within your Kodi library, then an Actor Image and biographical data will be available for display. When viewing the actors for a tv show in Kodi, it is normal to see missing actor artwork. These limitations are being worked on and should become available when the relevant sites update their API's. For TVDB this should become available when they finalise their v2 API. It will then be possible to link episode actors to their profile pages on IMDB. This is beyond the control of Kodi.}}

<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=300px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=300px |BluRay & DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg
|- valign="top"
| width=300px |One episode per directory in the TV Show:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg
|- valign="top"
| width=300px |All episodes in TV Show directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\TVShows\Dominion\.actors\Amy_Adams.jpg
|}
</div>

= Source Folder Artwork =
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your tv show sources in the Video menu. You will not see this artwork in the TV Show menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved the image in the correct location, it will be available to select immediately. If not, you will need to navigate to locate and select it. The image must remain in its original location once selected as it will not be cached. Deleting the image will remove it from view in the folder icon.

You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows

<pre><nowiki>
<source>
<name>tv show</name>
<path>xbms://192.168.1.100:1400/tv show/</path>
<thumbnail>F:\My TV Shows\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|bottom|#f5f5a1, #a1f5e4}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\TVShows\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\TVShows\MyMovies.jpg
|}
</div>

= Experimental TV show artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra fanart is stored in a separate Folder named "extrafanart". Create a folder named '''extrafanart''' in the folder of the TV show, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\TVShows\Angel\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\TVShows\Angel\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\TVShows\Angel\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|top|#f5f5a1, #a1f5e4}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\TVShows\Angel\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\TVShows\Angel\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\TVShows\Angel\fanart2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:Guides]]
[[Category:First time user]]
[[Category:FAQ]]
[[Category:Manual]]
[[Category:Index]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Quick Start Guide]]
[[Category:Advanced topics]]
[[User:Karellen|Karellen]] ([[User talk:Karellen|talk]]) 01:57, 29 June 2017 (EDT)

File:Artwork-EpisodeFanart01.jpg

2019-02-02T19:46:26Z

Rmrector:

Music artwork

2019-02-02T19:12:21Z

Rmrector:

{{MusicLibraryCreate}}
{{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, but this page will describe the types of artwork readily available for the Music library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
*To ensure '''local artwork''' is added when scanning new media items, the image files must be arranged in a certain folder hierarchy. See [[Music tagging#Folder_and_File_Structure| Music folder and file structure]] for a basic option and the [[Artist information folder]] for a separate directory option just for artist artwork and NFO files.
* Each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.
* Kodi 18 is required for expanded artwork type support in the music library.

= Artist artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-MusicFanart01.jpg|Artist fanart
File:Artwork-MusicArtist01.jpg|Grid of artist thumb
File:Artwork-MusicBanner01.jpg|Artist banner and clearlogo
File:Artwork-TS-clearart-AeonNox5modmaybe.jpg|Artist clearart in center right
File:Artwork-musiclandscape-EstuaryATF.jpg|Grid of artist landscape
</gallery>

== Artist "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience. The fanart displays the artist or band.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Artist "thumb" ==
Artist thumbnails display the artist or band members, and are often paired with an artist logo or title of the band.

Artist thumbnails have a '''recommended resolution of 1000x1000''', with a '''square (1:1) to somewhat portrait aspect ratio'''. They do not have transparency and preferably do not have a logo or artist name on the image.

== Artist "banner" ==
Artist banners are wide and short images that contain the artist or band members and typically includes a clearly visible logo or the name of the band.

Artist banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Artist "clearlogo" ==
Artist logos typically use the distinctive font associated with the musicians and is uncluttered by other images.

Artist logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Artist "clearart" ==
Artist clearart have a transparent background with an image of the artist or band along with their logo or name.

Artist clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Artist "landscape" ==
Landscape images are specially made 16x9 images that contain an image of the artist or band and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Artist landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Local artist artwork ==

Local artist artwork can be saved in the '''[[Artist information folder]]''' or a '''[[Music tagging#Folder and File Structure| common artist folder among your music files]]''' if Kodi can find one. The general rule for artist artwork file names is "<arttype>.<ext>" with some arttype examples listed below and extension matching the file type. Artist artwork can also be added from online services with an '''[[Scraping Music| "information provider" scraper add-on]]'''. * "folder.jpg" to "thumb" is a special case for the music library.

<div style="{{linear-gradient|top|#f5e3ff, #72d2f7}}">
'''''Example naming convention for locally saved artist artwork:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=400px |'''''Save name & location example'''''
| width=300px |'''''Recommended resolution'''''
| width=500px |'''''Aspect ratio'''''
|- valign="top"
| width=300px |fanart
| width=250px |fanart.jpg
| width=400px |f:\Music\Madonna\fanart.jpg<br>h:\centralinfo\artists\Madonna\fanart.jpg
| width=300px |1920x1080
| width=500px |16:9
|- valign="top"
| width=300px |banner
| width=250px |banner.jpg
| width=400px |f:\Music\Madonna\banner.jpg<br>h:\centralinfo\artists\Madonna\banner.jpg
| width=300px |1000x185
| width=500px |1:0.185
|- valign="top"
| width=300px |landscape
| width=250px |landscape.jpg
| width=400px |f:\Music\Madonna\landscape.jpg<br>h:\centralinfo\artists\Madonna\landscape.jpg
| width=300px |1000x562
| width=500px |16:9
|- valign="top"
| width=300px |clearlogo
| width=250px |clearlogo.png
| width=400px |f:\Music\Madonna\clearlogo.png<br>h:\centralinfo\artists\Madonna\clearlogo.png
| width=300px |800x310
| width=500px |1:0.388
|- valign="top"
| width=300px |clearart
| width=250px |clearart.png
| width=400px |f:\Music\Madonna\clearart.png<br>h:\centralinfo\artists\Madonna\clearart.png
| width=300px |1000x562
| width=500px |16:9
|- valign="top"
| width=300px |thumb
| width=250px |folder.jpg *
| width=400px |f:\Music\Madonna\folder.jpg *<br>h:\centralinfo\artists\Madonna\folder.jpg *
| width=300px |1000x1000
| width=500px |approximately 1:1
|}
</div>

= Album artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-MusicAlbum01.jpg|Grid of album "thumb"
File:Artwork-MusicBanner01.jpg|"discart" in bottom left and bottom right
</gallery>

== Album "thumb" ==
Album thumbnails are high quality images of the album front cover. The design varies widely and may or may not include the name of the album and or artist.

Album thumbnails have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. Depending on design they can be somewhat wider or somewhat taller, and many skins are designed to accommodate that. They do not have transparency.

== Album "discart" ==
Album discart replicates the picture on the physical CD or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Album discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Album "back" ==
This is the album back cover, which often includes a track listing, though the design varies. They are often used in detail views focused on a single album.

Album backs have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. Depending on design they can be somewhat wider or somewhat taller to match the album cover. They do not have transparency.

== Album "spine" ==
Album spines replicate the album spine found on standard CD cases. They typically have the name of the album and artist, but are too thin to have much of a design beyond continuing the front or back image. They are often used as thin identifiers for unfocused items in a list of albums.

Album spines have a '''recommended resolution of 50x1000''' with an '''aspect ratio of 1:20'''. They do not have transparency.

== Local album artwork ==

Local album artwork can be saved in the '''[[Music tagging#Folder and File Structure| album folder]]'''. The general rule for album artwork file names is "<arttype>.<ext>" with some arttype examples listed below and extension matching the file type. Album artwork can also be added from online services with an '''[[Scraping Music| "information provider" scraper add-on]]'''. *"folder.jpg" to "thumb" is a special case for the music library.

<div style="{{linear-gradient|top|#f5e3ff, #72d2f7}}">
'''''Example naming convention for locally saved album artwork:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=250px |'''''Recommended resolution'''''
| width=600px |'''''Aspect ratio'''''
|- valign="top"
| width=300px |thumb
| width=250px |folder.jpg *
| width=600px |f:\Music\Madonna\Like A Prayer\folder.jpg *
| width=250px |1000x1000
| width=600px |approximately 1:1
|- valign="top"
| width=300px |discart
| width=250px |discart.png
| width=600px |f:\Music\Madonna\Like A Prayer\discart.png
| width=250px |1000x1000
| width=600px |1:1
|- valign="top"
| width=300px |back
| width=250px |back.jpg
| width=600px |f:\Music\Madonna\Like A Prayer\back.jpg
| width=250px |1000x1000
| width=600px |approximately 1:1
|- valign="top"
| width=300px |spine
| width=250px |spine.jpg
| width=600px |f:\Music\Madonna\Like A Prayer\spine.jpg
| width=250px |50x1000
| width=600px |1:20
|}
</div>

= 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|#f5e3ff, #72d2f7}}">
'''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|#f5e3ff, #72d2f7}}">
'''''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:\Music\Music.jpg
|}
</div>

= Experimental music artwork =

== Artist "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard Fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the Artist, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|top|#72d2f7, #f5e3ff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- 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 |fanart0.jpg
| width=600px |f:\Music\Madonna\extrafanart\fanart0.jpg
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |fanart1.jpg
| width=600px |f:\Music\Madonna\extrafanart\fanart1.jpg
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |fanart2.jpg
| width=600px |f:\Music\Madonna\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|top|#72d2f7, #f5e3ff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Music\Madonna\fanart.jpg
h:\centralinfo\artists\Madonna\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Music\Madonna\fanart1.jpg
h:\centralinfo\artists\Madonna\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Music\Madonna\fanart2.jpg
h:\centralinfo\artists\Madonna\fanart2.jpg
|}
</div>

= 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 =

# Local artwork files
#* Local artwork files next to your media items or in the "[[Artist information folder]]". These are expected to be mid-high quality level for display in an interface like Kodi.
#* all types of artwork can be saved to local artwork files
# Artwork embedded in tracks
#* Artwork embedded in individual tracks of an album. These are expected to be lower quality to reduce the size of the image duplicated to many song files.
#* Only supports the album front cover
# Online source from "information provider"/scraper
#* only if the option in Kodi settings -> Media -> Music -> "Fetch additional information during updates" is enabled
#* will only be set if there is no local or embedded artwork unless the option in Kodi settings -> Media -> Music -> "Prefer online information" is enabled
#* all types of artwork can be added from information providers

= File Mode =
File 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 does not provide the added benefits of Extended Artwork and Album/Artist metadata that the properly scanned and scraped library provides. As a result, Music Artwork is handled differently using this mode as follows:

*The only artwork displayed in File Mode is artist thumb and album thumb.
*You must have local artwork named and saved as detailed in the sections above.
*These images are not loaded automatically. The Artist or Album must be viewed once to allow Kodi to locate and cache the image.
*When '''Enable tag reading''' is '''''Enabled''''' the song must be viewed to allow Kodi to scan for embedded images if no local image is available.

Kodi looks for and caches artwork in the following order:
*'''For Artist artwork:'''
*#Local artwork named and saved as detailed in the sections above. There is no fallback image

*'''For Album artwork:'''
*#Local artwork named and saved as detailed in the sections above. If there is no local artwork then
*#If you have '''Enable tag reading''' set as '''''Disabled''''' in Settings>Media Settings>Music then there is no fallback image
*#If you have '''Enable tag reading''' set as '''''Enabled''''' in Settings>Media Settings>Music then Kodi will search for an embedded image to cache.

Be aware that if you use File Mode, then upgrade to Library Mode at a later stage, your existing cached artwork may interfere with the correct scanning and scraping of new artwork. There is no simple fix for this. Your choices are
#Manually amend the affected artwork as described in chapter 2 above
#Perform the [[Artwork/Cache#Advanced: delete textures13.db|delete textures13.db]] procedure. This will also affect your Video Library.

= {{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:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

User:Rmrector

2019-02-02T19:11:12Z

Rmrector:

=== v18 Artwork updates ===
* ''Nothing in progress''
* But still need to update the TV shows and Music Videos pages

==== Merged ====
* [[User:Rmrector/Artwork/Accessing with skins and JSON-RPC - new]]
* [[User:Rmrector/Artwork - updates for Kodi 18]]
* [[User:Rmrector/Music artwork - for Kodi 18]]
* [[Movie artwork]] - updated directly

User:Rmrector

2019-02-02T19:10:42Z

Rmrector:

Movie artwork

2019-02-02T19:09:34Z

Rmrector:

{{Artwork_Contents}}
{{mininav|[[:Category:Video_library|Video Library Index]] |[[Artwork]]}}

<section begin="intro" />Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in {{Kodi}}'s music library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
* Each artwork type must be '''[[Advancedsettings.xml#Extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.

= Movie artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-FanartView02.jpg|Movie fanart
File:Artwork-PosterView01.jpg|Movie poster
File:Artwork-Banner02.jpg|Movie banner
File:Artwork-ClearArt01.jpg|Movie clearart
File:Artwork-ClearLogo.jpg|Movie clearlogo
File:Artwork-Thumbs01.jpg|Movie landscape
File:Artwork-DiscArt01.jpg|Movie discart
</gallery>

== Movie "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie.

Movie posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie logo or name on the image.

== Movie "banner" ==
Movie banners are wide and short images that contain recognizable characters or props from the movie and typically includes a clearly visible logo or the name of the movie.

Movie banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie "clearlogo" ==
Movie logos typically use the distinctive font associated with the movie and is uncluttered by other images.

Movie logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "clearart" ==
Movie clearart have a transparent background with recognizable characters or props from the movie along with a logo or name.

Movie clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie "discart" ==
Movie discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie "keyart" ==
Movie keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Movie "thumb" ==
Movie thumbnails are still images from the movie itself, and can be generated from the video file in your library.

Movie thumbnails have a recommended resolution that matches the resolution of the video file.

== Local movie artwork ==

Local movie artwork can be saved in the same folder the [[Naming_video_files/Movies#Movie_Folder_.26_Filename|movie file]] is saved. The general rule for movie artwork file names is "<arttype>.<ext>" or "<movie file name>-<arttype>.<ext>" - with some arttype examples listed below and extension matching the file type. Movie artwork can also be added from online services with an '''"information provider" scraper add-on'''.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved movie artwork:'''''
{|
|- valign="top"
| width=150px |'''''Artwork type'''''
| width=150px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=150px |'''''Recommended resolution'''''
| width=150px |'''''Aspect ratio'''''
|- valign="top"
| fanart
| fanart.jpg
| f:\Movies\Blade Runner 2049 (2017)\fanart.jpg<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-fanart.jpg
| 1920x1080
| 16:9
|- valign="top"
| poster
| poster.jpg
| f:\Movies\Blade Runner 2049 (2017)\poster.jpg<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-poster.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| banner
| banner.jpg
| f:\Movies\Blade Runner 2049 (2017)\banner.jpg<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-banner.jpg
| 1000x185
| 1:0.185
|- valign="top"
| landscape
| landscape.jpg
| f:\Movies\Blade Runner 2049 (2017)\landscape.jpg<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-landscape.jpg
| 1000x562
| 16:9
|- valign="top"
| clearlogo
| clearlogo.png
| f:\Movies\Blade Runner 2049 (2017)\clearlogo.png<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearlogo.png
| 800x310
| 1:0.388
|- valign="top"
| clearart
| clearart.png
| f:\Movies\Blade Runner 2049 (2017)\clearart.png<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-clearart.png
| 1000x562
| 16:9
|- valign="top"
| keyart
| keyart.jpg
| f:\Movies\Blade Runner 2049 (2017)\keyart.jpg<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-keyart.jpg
| 1000x1500
| approximately 1:1.5
|- valign="top"
| thumb
| thumb.jpg
| f:\Movies\Blade Runner 2049 (2017)\thumb.jpg<br>h:\Movies\Blade Runner 2049 (2017)\Blade Runner 2049 (2017)-thumb.jpg
| 1000x1500
| approximately 1:1.5
|}
</div>

= Movie set artwork =

Movie collections / sets have the same art types available as movies. Kodi currently does not support adding movie set artwork from the local file system, but it is supported with scrapers.
; {{see also|Movie_sets}}

== Movie set "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Movie set "poster" ==
Movie posters replicates the movie posters often seen in cinema complexes, or the front cover of home video releases, and contain a clearly visible logo or name of the movie set.

Movie set posters have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency but do have the movie set logo or name on the image.

== Movie set "banner" ==
Movie set banners are wide and short images that contain recognizable characters or props from the movie set and typically includes a clearly visible logo or the name of the movie set.

Movie set banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Movie set "clearlogo" ==
Movie set logos typically use the distinctive font associated with the movie set and is uncluttered by other images.

Movie set logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "clearart" ==
Movie set clearart have a transparent background with recognizable characters or props from the movie set along with its logo or name.

Movie set clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Movie set "landscape" ==
Landscape images are specially made 16x9 images that contain recognizable characters or props from the movie set and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Movie set landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Movie set "discart" ==
Movie set discart replicates the picture on the physical Blu-ray or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Movie set discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Movie set "keyart" ==
Movie set keyart is a poster without text or a logo. This is useful as a separate item in a skinner's toolbox as it can be paired with a clearlogo or large text title elsewhere on the window, and without text it is less distracting in the background or half-obscured, similar to fanart.

Movie set keyart have a '''recommended resolution of 1000x1500''', with an '''aspect ratio of approximately 1:1.5'''. They do not have transparency.

== Local movie set artwork ==

Local movie set artwork is not supported in Kodi, but it can be added from online services with an '''"information provider" scraper add-on'''.
The add-on [https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef] can add local movie set artwork to your library. [https://forum.kodi.tv/showthread.php?tid=153502 Movie Set Artwork Automator] hasn't been supported for some time, but it is also capable of adding local movie set artwork to your library.

== Actor Image ==
[[File:Artwork-Actors02.jpg|400px|right]]

The Actor artwork is a portrait of an actor for easy identification. The image is named as follows ''<FirstName>_<LastName>.jpg''

The image to the right is displaying the Actor images of five actors along the top row. They are portrait, medium to high quality images.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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|1:1.5}}
| width=200px | {{nowrap|1000x1500}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=250px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=250px |BluRay Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:MyMovies\Big Buck Bunny (2008)\BDMV\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |DVD Structure:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Single movie in Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\Big Buck Bunny (2008)\.actors\Amy_Adams.jpg
|- valign="top"
| width=250px |Two or more movies in single Directory:
| width=250px |<FirstName>_<LastName>.jpg
| width=600px |f:\MyMovies\.actors\Amy_Adams.jpg
|}
</div>

== Source Folder Artwork ==
[[File:Artwork-VideoFolder01.jpg|400px|right]]

The Folder Artwork, also known as Source Folder thumb, are landscape images that can be used to replace the standard folder icons when browsing your movie sources in the Video menu. You will not see this artwork in the Movies menu. This image file is saved directly within the Source directory.

To enable the image, navigate to Videos>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved in 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. 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>Movie</name>
<path>xbms://192.168.1.100:1400/Movie/</path>
<thumbnail>F:\MyMovies\folder.jpg</thumbnail>
</source>
</nowiki></pre>

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''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}}
|}
</div><br />

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Naming conventions for your own manually sourced artwork:'''''
{|
|- valign="top"
| width=200px |'''''Saved movies as'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save Location'''''
|- valign="top"
| width=200px |Folder Artwork:
| width=250px |folder.jpg
| width=600px |f:\MyMovies\folder.jpg
|- valign="top"
| width=200px |Alternative name:
| width=250px |<foldername>.jpg
| width=600px |f:\MyMovies\MyMovies.jpg
|}
</div>

= Experimental movie artwork =

== "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the movie, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\fanart2.jpg
|}
</div>

== "extrathumbs" folder ==
{{anchor|Extra Thumbs}}

It is possible to download and save additional thumbnails which the skin can display. Extra thumbs are reliant on a supporting skin and the images have exactly the same properties as the standard thumb described above.

Extra Thumbs are stored in a separate Folder named "extrathumbs". Create a Folder named '''extrathumbs''' in the folder of the Movie. Each Extra Thumb must be named ''thumbX.jpg'' where ''X'' is a sequential number starting with 0 ''(thumb0.jpg, thumb1.jpg, thumb2.jpg, etc)''. There is a limit of 10 thumb images allowable. Be aware that some skins utilise less than 10 of the images. The location of the extrathumbs Folder is as follows.

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">
'''''Example naming convention for locally saved extrathumbs::'''''
{|
|- valign="top"
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=250px |fanart0.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb0.jpg
|- valign="top"
| width=250px |fanart1.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb1.jpg
|- valign="top"
| width=250px |fanart2.jpg
| width=600px |f:\Movies\Blade Runner 2049 (2017)\extrathumbs\thumb2.jpg
|}
</div>

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Music artwork

2019-02-02T17:51:19Z

Rmrector:

{{MusicLibraryCreate}}
{{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, but this page will describe the types of artwork readily available for the Music library 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 many different artwork types.
* The default skin, Estuary, displays only a limited selection of artwork. Another skin must be used to see other artwork.
*To ensure '''local artwork''' is added when scanning new media items, the image files must be arranged in a certain folder hierarchy. See [[Music tagging#Folder_and_File_Structure| Music folder and file structure]] for a basic option and the [[Artist information folder]] for a separate directory option just for artist artwork and NFO files.
* Each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping.
* Kodi 18 is required for expanded artwork type support in the music library.
; {{see also|Music_library}}

= Artist artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-MusicFanart01.jpg|Artist fanart
File:Artwork-MusicArtist01.jpg|Grid of artist thumb
File:Artwork-MusicBanner01.jpg|Artist banner and clearlogo
File:Artwork-TS-clearart-AeonNox5modmaybe.jpg|Artist clearart in center right
File:Artwork-musiclandscape-EstuaryATF.jpg|Grid of artist landscape
</gallery>

== Artist "fanart" ==
Fanart is also known as wallpapers, backdrops, or backgrounds.
;{{See also|wikipedia:Fanart|l1=Fanart on Wikipedia}}

For Kodi they are used as full screen displays to enhance the user experience. The fanart displays the artist or band.

Fanart have a '''recommended resolution of 1920x1080''' the display, with a specific '''aspect ratio of 16:9''' to match the ratio of current generation televisions and monitors, which allows the screen to be completely filled by the image. Fanart also does not have transparency and preferably does not have a logo or title on the image.

== Artist "thumb" ==
Artist thumbnails display the artist or band members, and are often paired with an artist logo or title of the band.

Artist thumbnails have a '''recommended resolution of 1000x1000''', with a '''square (1:1) to somewhat portrait aspect ratio'''. They do not have transparency and preferably do not have a logo or artist name on the image.

== Artist "banner" ==
Artist banners display the artist or band members and typically includes a clearly visible logo or the name of the band.

Artist banners have a '''recommended resolution of 1000x185''' with an '''aspect ratio of 1:0.185'''. They do not have transparency.

== Artist "clearlogo" ==
Artist logos typically use the distinctive font associated with the musicians and is uncluttered by other images.

Artist logos have a '''recommended resolution of 800x310''' with an '''aspect ratio of 1:0.388'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Artist "clearart" ==
Artist clearart have a transparent background with an image of the artist or band along with their logo or name.

Artist clearart have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. The transparent background allows it to be overlaid on other images or video with minimal impact.

== Artist "landscape" ==
Landscape images are specially made 16x9 images that contain an image of the artist or band and a logo. They are used in certain page layouts for browsing. Skins can make passable replacements for media items without one with fanart and the clearlogo.

Artist landscape have a '''recommended resolution of 1000x562''' with an '''aspect ratio of 16:9'''. They have no transparency.

== Local artist artwork ==

Local artist artwork can be saved in the '''[[Artist information folder]]''' or a '''[[Music tagging#Folder and File Structure| common artist folder among your music files]]''' if Kodi can find one. The general rule for artist artwork file names is "<arttype>.<ext>" with some arttype examples listed below and extension matching the file type. Artist artwork can also be added from online services with an '''[[Scraping Music| "information provider" scraper add-on]]'''. * "folder.jpg" to "thumb" is a special case for the music library.

<div style="{{linear-gradient|top|#f5e3ff, #72d2f7}}">
'''''Example naming convention for locally saved artist artwork:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=400px |'''''Save name & location example'''''
| width=300px |'''''Recommended resolution'''''
| width=500px |'''''Aspect ratio'''''
|- valign="top"
| width=300px |fanart
| width=250px |fanart.jpg
| width=400px |f:\Music\Madonna\fanart.jpg<br>h:\centralinfo\artists\Madonna\fanart.jpg
| width=300px |1920x1080
| width=500px |16:9
|- valign="top"
| width=300px |banner
| width=250px |banner.jpg
| width=400px |f:\Music\Madonna\banner.jpg<br>h:\centralinfo\artists\Madonna\banner.jpg
| width=300px |1000x185
| width=500px |1:0.185
|- valign="top"
| width=300px |landscape
| width=250px |landscape.jpg
| width=400px |f:\Music\Madonna\landscape.jpg<br>h:\centralinfo\artists\Madonna\landscape.jpg
| width=300px |1000x562
| width=500px |16:9
|- valign="top"
| width=300px |clearlogo
| width=250px |clearlogo.png
| width=400px |f:\Music\Madonna\clearlogo.png<br>h:\centralinfo\artists\Madonna\clearlogo.png
| width=300px |800x310
| width=500px |1:0.388
|- valign="top"
| width=300px |clearart
| width=250px |clearart.png
| width=400px |f:\Music\Madonna\clearart.png<br>h:\centralinfo\artists\Madonna\clearart.png
| width=300px |1000x562
| width=500px |16:9
|- valign="top"
| width=300px |thumb
| width=250px |folder.jpg *
| width=400px |f:\Music\Madonna\folder.jpg *<br>h:\centralinfo\artists\Madonna\folder.jpg *
| width=300px |1000x1000
| width=500px |approximately 1:1
|}
</div>

= Album artwork =

<gallery mode="packed" widths="350px" heights="200px">
File:Artwork-MusicAlbum01.jpg|Grid of album "thumb"
File:Artwork-MusicBanner01.jpg|"discart" in bottom left and bottom right
</gallery>

== Album "thumb" ==
Album thumbnails are high quality images of the album front cover. The design varies widely and may or may not include the name of the album and or artist.

Album thumbnails have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. Depending on design they can be somewhat wider or somewhat taller, and many skins are designed to accommodate that. They do not have transparency.

== Album "discart" ==
Album discart replicates the picture on the physical CD or other disc. Although the disc artwork is round, the image itself is square and the disc image is placed in the center on a transparent background.

Album discart have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. They have a transparent background.

== Album "back" ==
This is the album back cover, which often includes a track listing, though the design varies. They are often used in detail views focused on a single album.

Album backs have a '''recommended resolution of 1000x1000''' with an '''aspect ratio of 1:1 (square)'''. Depending on design they can be somewhat wider or somewhat taller to match the album cover. They do not have transparency.

== Album "spine" ==
Album spines replicate the album spine found on standard CD cases. They typically have the name of the album and artist, but are too thin to have much of a design beyond continuing the front or back image. They are often used as thin identifiers for unfocused items in a list of albums.

Album spines have a '''recommended resolution of 50x1000''' with an '''aspect ratio of 1:20'''. They do not have transparency.

== Local album artwork ==

Local album artwork can be saved in the '''[[Music tagging#Folder and File Structure| album folder]]'''. The general rule for album artwork file names is "<arttype>.<ext>" with some arttype examples listed below and extension matching the file type. Album artwork can also be added from online services with an '''[[Scraping Music| "information provider" scraper add-on]]'''. *"folder.jpg" to "thumb" is a special case for the music library.

<div style="{{linear-gradient|top|#f5e3ff, #72d2f7}}">
'''''Example naming convention for locally saved album artwork:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
| width=250px |'''''Recommended resolution'''''
| width=600px |'''''Aspect ratio'''''
|- valign="top"
| width=300px |thumb
| width=250px |folder.jpg *
| width=600px |f:\Music\Madonna\Like A Prayer\folder.jpg *
| width=250px |1000x1000
| width=600px |approximately 1:1
|- valign="top"
| width=300px |discart
| width=250px |discart.png
| width=600px |f:\Music\Madonna\Like A Prayer\discart.png
| width=250px |1000x1000
| width=600px |1:1
|- valign="top"
| width=300px |back
| width=250px |back.jpg
| width=600px |f:\Music\Madonna\Like A Prayer\back.jpg
| width=250px |1000x1000
| width=600px |approximately 1:1
|- valign="top"
| width=300px |spine
| width=250px |spine.jpg
| width=600px |f:\Music\Madonna\Like A Prayer\spine.jpg
| width=250px |50x1000
| width=600px |1:20
|}
</div>

= 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|#f5e3ff, #72d2f7}}">
'''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|#f5e3ff, #72d2f7}}">
'''''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:\Music\Music.jpg
|}
</div>

= Experimental music artwork =

== Artist "extrafanart" folder ==
{{anchor|Extra Fanart}}

It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow. Extra fanart is reliant on a supporting skin and the images have exactly the same properties as the standard Fanart described above. This is older and more widely supported in skins.

Extra Fanart is stored in a separate Folder named "extrafanart". Create a Folder named '''extrafanart''' in the folder of the Artist, and place each extra fanart image in it. This artwork is not added to the Kodi library, instead skins list the folder directly; this can wake hard drives while browsing the library. The filename is mostly not important.

<div style="{{linear-gradient|top|#72d2f7, #f5e3ff}}">
'''''Example naming convention for locally saved extrafanart::'''''
{|
|- 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 |fanart0.jpg
| width=600px |f:\Music\Madonna\extrafanart\fanart0.jpg
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |fanart1.jpg
| width=600px |f:\Music\Madonna\extrafanart\fanart1.jpg
|- valign="top"
| width=300px |Artist\Album\Songs
| width=250px |fanart2.jpg
| width=600px |f:\Music\Madonna\extrafanart\fanart2.jpg
|}
</div>

== Multiple fanart ==

Multiple fanart is an alternative to "extrafanart" that adds all of the fanart images to the Kodi library, and they are treated just like any other artwork type. This is newer and not supported in as many skins as extrafanart.

Multiple additional fanart is named "fanart1", "fanart2", and so on with the number increasing for each artwork. The number can increase to 10 and beyond, but numbers cannot be zero-padded. This currently requires more work from skins to display than "extrafanart" and can be awkward to configure because each numbered fanart needs to be added to the artwork whitelist, but the improved performance and behavior that matches other artwork is worth it.

<div style="{{linear-gradient|top|#72d2f7, #f5e3ff}}">
'''''Example naming convention for locally saved multiple fanart:'''''
{|
|- valign="top"
| width=300px |'''''Artwork type'''''
| width=250px |'''''File Name'''''
| width=600px |'''''Save name & location example'''''
|- valign="top"
| width=300px |fanart (standard fanart)
| width=250px |fanart.jpg
| width=600px |f:\Music\Madonna\fanart.jpg
h:\centralinfo\artists\Madonna\fanart.jpg
|- valign="top"
| width=300px |fanart1
| width=250px |fanart1.jpg
| width=600px |f:\Music\Madonna\fanart1.jpg
h:\centralinfo\artists\Madonna\fanart1.jpg
|- valign="top"
| width=300px |fanart2
| width=250px |fanart2.jpg
| width=600px |f:\Music\Madonna\fanart2.jpg
h:\centralinfo\artists\Madonna\fanart2.jpg
|}
</div>

= 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 =

# Local artwork files
#* Local artwork files next to your media items or in the "[[Artist information folder]]". These are expected to be mid-high quality level for display in an interface like Kodi.
#* all types of artwork can be saved to local artwork files
# Artwork embedded in tracks
#* Artwork embedded in individual tracks of an album. These are expected to be lower quality to reduce the size of the image duplicated to many song files.
#* Only supports the album front cover
# Online source from "information provider"/scraper
#* only if the option in Kodi settings -> Media -> Music -> "Fetch additional information during updates" is enabled
#* will only be set if there is no local or embedded artwork unless the option in Kodi settings -> Media -> Music -> "Prefer online information" is enabled
#* all types of artwork can be added from information providers

= File Mode =
File 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 does not provide the added benefits of Extended Artwork and Album/Artist metadata that the properly scanned and scraped library provides. As a result, Music Artwork is handled differently using this mode as follows:

*The only artwork displayed in File Mode is artist thumb and album thumb.
*You must have local artwork named and saved as detailed in the sections above.
*These images are not loaded automatically. The Artist or Album must be viewed once to allow Kodi to locate and cache the image.
*When '''Enable tag reading''' is '''''Enabled''''' the song must be viewed to allow Kodi to scan for embedded images if no local image is available.

Kodi looks for and caches artwork in the following order:
*'''For Artist artwork:'''
*#Local artwork named and saved as detailed in the sections above. There is no fallback image

*'''For Album artwork:'''
*#Local artwork named and saved as detailed in the sections above. If there is no local artwork then
*#If you have '''Enable tag reading''' set as '''''Disabled''''' in Settings>Media Settings>Music then there is no fallback image
*#If you have '''Enable tag reading''' set as '''''Enabled''''' in Settings>Media Settings>Music then Kodi will search for an embedded image to cache.

Be aware that if you use File Mode, then upgrade to Library Mode at a later stage, your existing cached artwork may interfere with the correct scanning and scraping of new artwork. There is no simple fix for this. Your choices are
#Manually amend the affected artwork as described in chapter 2 above
#Perform the [[Artwork/Cache#Advanced: delete textures13.db|delete textures13.db]] procedure. This will also affect your Video Library.

= {{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:First time user]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Artwork/Accessing with skins and JSON-RPC

2019-02-02T17:33:22Z

Rmrector: /* {{Kodi}} version updates */

{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =

Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are {{code|Player.Art(poster)}}, {{code|Player.Art(fanart)}}, {{code|ListItem.Art(banner)}}, and {{code|ListItem.Art(tvshow.clearlogo)}}.

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==

There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =

Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==

example request:
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}

and a possible response:
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}

== Kodi-encoded URL ==

The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "images/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/images/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/images/image%3A%2F%2Fnfs%253a%252f%252fCUBER%252fmedia%252fpreserved%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =

For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|- valign="top"
| album.thumb
| ListItem.Art(thumb)
| Thumb of the currently focused media item. This has some notable fallback behavior in the video library. It will be the artwork type named exactly "thumb" if it exists for the current item, but will fall back to "poster" then "banner" if not.
|}

= {{Kodi}} version updates =

* The '''music library''' in {{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. The video library has had this level of support for some time now.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.

{{Top}}

{{updated|18}}
[[Category:Development]]

InfoLabels

2019-02-02T17:14:22Z

Rmrector: /* Images Available in Kodi */

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

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

=== Container ===

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

=== Control ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Control.GetLabel(id)[.index()]
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.
|
|}

=== Fanart ===

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

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== ListItem ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ListItem.Label
| Shows the left label of the currently selected item in a container
|
|-
| ListItem.Label2
| Shows the right label of the currently selected item in a container
|
|-
| ListItem.Title
| Shows the title of the currently selected song or movie in a container
|
|-
| ListItem.OriginalTitle
| Shows the original title of the currently selected movie in a container
|
|-
| ListItem.SortLetter
| Shows the first letter of the current file in a container
|
|-
| ListItem.TrackNumber
| Shows the track number of the currently selected song in a container
|
|-
| ListItem.Artist
| Shows the artist of the currently selected song in a container
|
|-
| ListItem.AlbumArtist
| Shows the artist of the currently selected album in a list
|
|-
| ListItem.Property(Artist_Born)
| Date of Birth of the currently selected Artist
|
|-
| ListItem.Property(Artist_Died)
| Date of Death of the currently selected Artist
|
|-
| ListItem.Property(Artist_Formed)
| Formation date of the currently selected Band
|
|-
| ListItem.Property(Artist_Disbanded)
| Disbanding date of the currently selected Band
|
|-
| ListItem.Property(Artist_YearsActive)
| Years the currently selected artist has been active
|
|-
| ListItem.Property(Artist_Instrument)
| Instruments played by the currently selected artist
|
|-
| ListItem.Property(Artist_Description)
| Shows a biography of the currently selected artist
|
|-
| ListItem.Property(Artist_Mood)
| Shows the moods of the currently selected artist
|
|-
| ListItem.Property(Artist_Style)
| Shows the styles of the currently selected artist
|
|-
| ListItem.Property(Artist_Genre)
| Shows the genre of the currently selected artist
|
|-
| Listitem.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| ListItem.Album
| Shows the album of the currently selected song in a container
|
|-
| ListItem.Property(Album_Mood)
| Shows the moods of the currently selected Album
|
|-
| ListItem.Property(Album_Style)
| Shows the styles of the currently selected Album
|
|-
| ListItem.Property(Album_Theme)
| Shows the themes of the currently selected Album
|
|-
| ListItem.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
|
|-
| ListItem.Property(Album_Label)
| Shows the record label of the currently selected Album
|
|-
| ListItem.Property(Album_Description)
| Shows a review of the currently selected Album
|
|-
| ListItem.DiscNumber
| Shows the disc number of the currently selected song in a container
|
|-
| ListItem.Year
| Shows the year of the currently selected song, album or movie in a container
|
|-
| ListItem.Premiered
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container
|
|-
| ListItem.Genre
| Shows the genre of the currently selected song, album or movie in a container
|
|-
| ListItem.Director
| Shows the director of the currently selected movie in a container
|
|-
| ListItem.Country
| Shows the production country of the currently selected movie in a container
|
|-
| ListItem.Episode
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.Season
| Shows the season value for the currently selected tvshow
|
|-
| ListItem.TVShowTitle
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library
|
|-
| ListItem.Property(TotalSeasons)
| Shows the total number of seasons for the currently selected tvshow
|
|-
| ListItem.Property(TotalEpisodes)
| Shows the total number of episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(WatchedEpisodes)
| Shows the number of watched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(UnWatchedEpisodes)
| Shows the number of unwatched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(NumEpisodes)
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.PictureAperture
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| ListItem.PictureAuthor
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| ListItem.PictureByline
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| ListItem.PictureBylineTitle
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| ListItem.PictureCamMake
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| ListItem.PictureCamModel
| Shows the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| ListItem.PictureCaption
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| ListItem.PictureCategory
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| ListItem.PictureCCDWidth
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| ListItem.PictureCity
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| ListItem.PictureColour
| Shows whether the selected picture is "Colour" or "Black and White".
|
|-
| ListItem.PictureComment
| Shows a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| ListItem.PictureCopyrightNotice
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| ListItem.PictureCountry
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| ListItem.PictureCountryCode
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| ListItem.PictureCredit
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| ListItem.PictureDate
| Shows the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDatetime
| Shows the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDesc
| Shows a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| ListItem.PictureDigitalZoom
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| ListItem.PictureExpMode
| Shows the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| ListItem.PictureExposure
| Shows the class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| ListItem.PictureExposureBias
| Shows the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| ListItem.PictureExpTime
| Shows the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| ListItem.PictureFlashUsed
| Shows the status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| ListItem.PictureFocalLen
| Shows the lens focal length of the selected picture
|
|-
| ListItem.PictureFocusDist
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| ListItem.PictureGPSLat
| Shows the latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| ListItem.PictureGPSLon
| Shows the longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| ListItem.PictureGPSAlt
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| ListItem.PictureHeadline
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| ListItem.PictureImageType
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| ListItem.PictureIPTCDate
| Shows the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| ListItem.PictureIPTCTime
| Shows the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| ListItem.PictureISO
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| ListItem.PictureKeywords
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| ListItem.PictureLightSource
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| ListItem.PictureLongDate
| Shows only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureLongDatetime
| Shows the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureMeteringMode
| Shows the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| ListItem.PictureObjectName
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| ListItem.PictureOrientation
| Shows the orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| ListItem.PicturePath
| Shows the filename and path of the selected picture
|
|-
| ListItem.PictureProcess
| Shows the process used to compress the selected picture
|
|-
| ListItem.PictureReferenceService
| Shows the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| ListItem.PictureResolution
| Shows the dimensions of the selected picture
|
|-
| ListItem.PictureSource
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| ListItem.PictureSpecialInstructions
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| ListItem.PictureState
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| ListItem.PictureSublocation
| Shows the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| ListItem.PictureSupplementalCategories
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| ListItem.PictureTransmissionReference
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| ListItem.PictureUrgency
| Shows the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| ListItem.PictureWhiteBalance
| Shows the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| ListItem.FileName
| Shows the filename of the currently selected song or movie in a container
|
|-
| ListItem.Path
| Shows the complete path of the currently selected song or movie in a container
|
|-
| ListItem.FolderName
| Shows top most folder of the path of the currently selected song or movie in a container
|
|-
| ListItem.FolderPath
| Shows the complete path of the currently selected song or movie in a container (without user details).
|
|-
| ListItem.FileNameAndPath
| Shows the full path with filename of the currently selected song or movie in a container
|
|-
| ListItem.FileExtension
| Shows the file extension (without leading dot) of the currently selected item in a container
|
|-
| ListItem.Date
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)
|
|-
| ListItem.DateAdded
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
|
|-
| ListItem.Size
| Shows the file size of the currently selected song or movie in a container
|
|-
| ListItem.Rating[(name)]
| Shows the scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Set
| Shows the name of the set the movie is part of
|
|-
| ListItem.SetId
| Shows the id of the set the movie is part of
|
|-
| ListItem.UserRating
| Shows the user rating of the currently selected item in a container
|
|-
| ListItem.Votes[(name)]
| Shows the IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.RatingAndVotes[(name)]
| Shows the IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Mpaa
| Show the MPAA rating of the currently selected movie in a container
|
|-
| ListItem.ProgramCount
| Shows the number of times an xbe has been run from "my programs"
|
|-
| ListItem.Duration[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| ListItem.DBTYPE
| Shows the database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist). Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.
|
|-
| ListItem.DBID
| Shows the database id of the currently selected listitem in a container
|
|-
| ListItem.Cast
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.CastAndRole
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.Studio
| Studio of current selected Music Video in a container
|
|-
| ListItem.Top250
| Shows the IMDb top250 position of the currently selected listitem in a container.
|
|-
| ListItem.Trailer
| Shows the full trailer path with filename of the currently selected movie in a container
|
|-
| ListItem.Writer
| Name of Writer of current Video in a container
|
|-
| ListItem.Tagline
| Small Summary of current Video in a container
|
|-
| ListItem.PlotOutline
| Small Summary of current Video in a container
|
|-
| ListItem.Plot
| Complete Text Summary of Video in a container
|
|-
| ListItem.IMDBNumber
| The IMDB iD of the selected Video in a container
|
|-
| ListItem.EpisodeName
| (PVR only) The name of the episode if the selected EPG item is a TV Show
|
|-
| ListItem.PercentPlayed
| Returns percentage value [0-100] of how far the selected video has been played
|
|-
| ListItem.LastPlayed
| Last play date of Video in a container
|
|-
| ListItem.PlayCount
| Playcount of Video in a container
|
|-
| ListItem.StartTime
| Start time of current selected TV programme in a container
|
|-
| ListItem.EndTime
| End time of current selected TV programme in a container
|
|-
| ListItem.StartDate
| Start date of current selected TV programme in a container
|
|-
| ListItem.ChannelName
| Name of current selected TV channel in a container
|
|-
| ListItem.VideoCodec
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)
|
|-
| ListItem.VideoResolution
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K, 8K [Note: v18 addition]). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.
| v18
|-
| ListItem.VideoAspect
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)
|
|-
| ListItem.AudioCodec
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)
|
|-
| ListItem.AudioChannels
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 7, 8, 10)
|
|-
| ListItem.AudioLanguage
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.SubtitleLanguage
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.Property(AudioCodec.[n])
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
|
|-
| ListItem.Property(AudioChannels.[n])
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
|
|-
| ListItem.Property(AudioLanguage.[n])
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
|
|-
| ListItem.Property(SubtitleLanguage.[n])
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
|
|-
| ListItem.AddonName
| Shows the name of the currently selected addon
|
|-
| ListItem.AddonVersion
| Shows the version of the currently selected addon
|
|-
| ListItem.AddonSummary
| Shows a short description of the currently selected addon
|
|-
| ListItem.AddonDescription
| Shows the full description of the currently selected addon
|
|-
| ListItem.AddonType
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon
|
|-
| ListItem.AddonCreator
| Shows the name of the author the currently selected addon
|
|-
| ListItem.AddonDisclaimer
| Shows the disclaimer of the currently selected addon
|
|-
| ListItem.AddonBroken
| Shows a message when the addon is marked as broken in the repo
|
|-
| ListItem.Property(Addon.Changelog)
| Shows the changelog of the currently selected addon
|
|-
| ListItem.Property(Addon.ID)
| Shows the identifier of the currently selected addon
|
|-
| ListItem.Property(Addon.Status)
| Shows the status of the currently selected addon
|
|-
| ListItem.Property(Addon.Path)
| Shows the path of the currently selected addon
|
|-
| ListItem.StartTime
| Start time of the selected item (PVR).
|
|-
| ListItem.EndTime
| End time of the selected item (PVR).
|
|-
| ListItem.StartDate
| Start date of the selected item (PVR).
|
|-
| ListItem.EndDate
| End date of the selected item (PVR).
|
|-
| ListItem.NextTitle
| Title of the next item (PVR).
|
|-
| ListItem.NextGenre
| Genre of the next item (PVR).
|
|-
| ListItem.NextPlot
| Plot of the next item (PVR).
|
|-
| ListItem.NextPlotOutline
| Plot outline of the next item (PVR).
|
|-
| ListItem.NextStartTime
| Start time of the next item (PVR).
|
|-
| ListItem.NextEndTime
| End of the next item (PVR).
|
|-
| ListItem.NextStartDate
| Start date of the next item (PVR).
|
|-
| ListItem.NextEndDate
| End date of the next item (PVR).
|
|-
| Listitem.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (PVR).
|
|-
| ListItem.ChannelNumberLabel
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.Progress
| Part of the programme that's been played (PVR).
|
|-
| ListItem.StereoscopicMode
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
|
|-
| ListItem.Comment
| Comment assigned to the item (PVR/MUSIC).
|
|-
| ListItem.AddonInstallDate
| Date the addon was installed
|
|-
| ListItem.AddonLastUpdated
| Date the addon was last updated
|
|-
| ListItem.AddonLastUsed
| Date the addon was used last
|
|-
| ListItem.AddonNews
| Returns a brief changelog, taken from the addons' addon.xml file
|
|-
| ListItem.AddonSize
| Filesize of the addon
|
|-
| ListItem.Contributors
| List of all people who've contributed to the selected song
|
|-
| ListItem.ContributorAndRole
| List of all people and their role who've contributed to the selected song
|
|-
| ListItem.EndTimeResume
| Returns the time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| ListItem.Mood
| Mood of the selected song
|
|-
| ListItem.Status
| For use with tv shows. It can return one of the following: 'returning series','in production','planned','cancelled' or 'ended'
|
|-
| ListItem.Tag
| Will return the name of the 'tag' this movie is part of.
|
|-
| ListItem.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| ListItem.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| ListItem.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| ListItem.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| ListItem.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| ListItem.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| ListItem.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| ListItem.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| ListItem.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| ListItem.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| ListItem.Appearances
| Returns the number of movies featuring the selected actor / directed by the selected director
| v17 addition
|-
| ListItem.PrivacyPolicy
| Returns the official Kodi privacy-policy
| v17 addition
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|}

=== Musicpartymode labels ===

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

=== Network labels ===

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

=== Player labels ===

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

==== Music player ====

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

==== Video player ====

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

=== Playlist ===

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

=== PVR ===

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

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

=== Skin ===

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

=== Slideshow ===

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

=== System ===

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

=== Visualisation ===

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

=== Weather labels ===

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

=== Window ===

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

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

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

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

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

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

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

=== Images Available in Kodi ===

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

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

<section end="main content" />

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

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

InfoLabels

2019-02-02T17:12:06Z

Rmrector: /* Images Available in Kodi */

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

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

=== Container ===

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

=== Control ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Control.GetLabel(id)[.index()]
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.
|
|}

=== Fanart ===

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

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== ListItem ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ListItem.Label
| Shows the left label of the currently selected item in a container
|
|-
| ListItem.Label2
| Shows the right label of the currently selected item in a container
|
|-
| ListItem.Title
| Shows the title of the currently selected song or movie in a container
|
|-
| ListItem.OriginalTitle
| Shows the original title of the currently selected movie in a container
|
|-
| ListItem.SortLetter
| Shows the first letter of the current file in a container
|
|-
| ListItem.TrackNumber
| Shows the track number of the currently selected song in a container
|
|-
| ListItem.Artist
| Shows the artist of the currently selected song in a container
|
|-
| ListItem.AlbumArtist
| Shows the artist of the currently selected album in a list
|
|-
| ListItem.Property(Artist_Born)
| Date of Birth of the currently selected Artist
|
|-
| ListItem.Property(Artist_Died)
| Date of Death of the currently selected Artist
|
|-
| ListItem.Property(Artist_Formed)
| Formation date of the currently selected Band
|
|-
| ListItem.Property(Artist_Disbanded)
| Disbanding date of the currently selected Band
|
|-
| ListItem.Property(Artist_YearsActive)
| Years the currently selected artist has been active
|
|-
| ListItem.Property(Artist_Instrument)
| Instruments played by the currently selected artist
|
|-
| ListItem.Property(Artist_Description)
| Shows a biography of the currently selected artist
|
|-
| ListItem.Property(Artist_Mood)
| Shows the moods of the currently selected artist
|
|-
| ListItem.Property(Artist_Style)
| Shows the styles of the currently selected artist
|
|-
| ListItem.Property(Artist_Genre)
| Shows the genre of the currently selected artist
|
|-
| Listitem.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| ListItem.Album
| Shows the album of the currently selected song in a container
|
|-
| ListItem.Property(Album_Mood)
| Shows the moods of the currently selected Album
|
|-
| ListItem.Property(Album_Style)
| Shows the styles of the currently selected Album
|
|-
| ListItem.Property(Album_Theme)
| Shows the themes of the currently selected Album
|
|-
| ListItem.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
|
|-
| ListItem.Property(Album_Label)
| Shows the record label of the currently selected Album
|
|-
| ListItem.Property(Album_Description)
| Shows a review of the currently selected Album
|
|-
| ListItem.DiscNumber
| Shows the disc number of the currently selected song in a container
|
|-
| ListItem.Year
| Shows the year of the currently selected song, album or movie in a container
|
|-
| ListItem.Premiered
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container
|
|-
| ListItem.Genre
| Shows the genre of the currently selected song, album or movie in a container
|
|-
| ListItem.Director
| Shows the director of the currently selected movie in a container
|
|-
| ListItem.Country
| Shows the production country of the currently selected movie in a container
|
|-
| ListItem.Episode
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.Season
| Shows the season value for the currently selected tvshow
|
|-
| ListItem.TVShowTitle
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library
|
|-
| ListItem.Property(TotalSeasons)
| Shows the total number of seasons for the currently selected tvshow
|
|-
| ListItem.Property(TotalEpisodes)
| Shows the total number of episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(WatchedEpisodes)
| Shows the number of watched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(UnWatchedEpisodes)
| Shows the number of unwatched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(NumEpisodes)
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.PictureAperture
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| ListItem.PictureAuthor
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| ListItem.PictureByline
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| ListItem.PictureBylineTitle
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| ListItem.PictureCamMake
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| ListItem.PictureCamModel
| Shows the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| ListItem.PictureCaption
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| ListItem.PictureCategory
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| ListItem.PictureCCDWidth
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| ListItem.PictureCity
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| ListItem.PictureColour
| Shows whether the selected picture is "Colour" or "Black and White".
|
|-
| ListItem.PictureComment
| Shows a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| ListItem.PictureCopyrightNotice
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| ListItem.PictureCountry
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| ListItem.PictureCountryCode
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| ListItem.PictureCredit
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| ListItem.PictureDate
| Shows the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDatetime
| Shows the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDesc
| Shows a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| ListItem.PictureDigitalZoom
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| ListItem.PictureExpMode
| Shows the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| ListItem.PictureExposure
| Shows the class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| ListItem.PictureExposureBias
| Shows the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| ListItem.PictureExpTime
| Shows the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| ListItem.PictureFlashUsed
| Shows the status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| ListItem.PictureFocalLen
| Shows the lens focal length of the selected picture
|
|-
| ListItem.PictureFocusDist
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| ListItem.PictureGPSLat
| Shows the latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| ListItem.PictureGPSLon
| Shows the longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| ListItem.PictureGPSAlt
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| ListItem.PictureHeadline
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| ListItem.PictureImageType
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| ListItem.PictureIPTCDate
| Shows the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| ListItem.PictureIPTCTime
| Shows the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| ListItem.PictureISO
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| ListItem.PictureKeywords
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| ListItem.PictureLightSource
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| ListItem.PictureLongDate
| Shows only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureLongDatetime
| Shows the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureMeteringMode
| Shows the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| ListItem.PictureObjectName
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| ListItem.PictureOrientation
| Shows the orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| ListItem.PicturePath
| Shows the filename and path of the selected picture
|
|-
| ListItem.PictureProcess
| Shows the process used to compress the selected picture
|
|-
| ListItem.PictureReferenceService
| Shows the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| ListItem.PictureResolution
| Shows the dimensions of the selected picture
|
|-
| ListItem.PictureSource
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| ListItem.PictureSpecialInstructions
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| ListItem.PictureState
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| ListItem.PictureSublocation
| Shows the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| ListItem.PictureSupplementalCategories
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| ListItem.PictureTransmissionReference
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| ListItem.PictureUrgency
| Shows the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| ListItem.PictureWhiteBalance
| Shows the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| ListItem.FileName
| Shows the filename of the currently selected song or movie in a container
|
|-
| ListItem.Path
| Shows the complete path of the currently selected song or movie in a container
|
|-
| ListItem.FolderName
| Shows top most folder of the path of the currently selected song or movie in a container
|
|-
| ListItem.FolderPath
| Shows the complete path of the currently selected song or movie in a container (without user details).
|
|-
| ListItem.FileNameAndPath
| Shows the full path with filename of the currently selected song or movie in a container
|
|-
| ListItem.FileExtension
| Shows the file extension (without leading dot) of the currently selected item in a container
|
|-
| ListItem.Date
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)
|
|-
| ListItem.DateAdded
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
|
|-
| ListItem.Size
| Shows the file size of the currently selected song or movie in a container
|
|-
| ListItem.Rating[(name)]
| Shows the scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Set
| Shows the name of the set the movie is part of
|
|-
| ListItem.SetId
| Shows the id of the set the movie is part of
|
|-
| ListItem.UserRating
| Shows the user rating of the currently selected item in a container
|
|-
| ListItem.Votes[(name)]
| Shows the IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.RatingAndVotes[(name)]
| Shows the IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Mpaa
| Show the MPAA rating of the currently selected movie in a container
|
|-
| ListItem.ProgramCount
| Shows the number of times an xbe has been run from "my programs"
|
|-
| ListItem.Duration[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| ListItem.DBTYPE
| Shows the database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist). Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.
|
|-
| ListItem.DBID
| Shows the database id of the currently selected listitem in a container
|
|-
| ListItem.Cast
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.CastAndRole
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.Studio
| Studio of current selected Music Video in a container
|
|-
| ListItem.Top250
| Shows the IMDb top250 position of the currently selected listitem in a container.
|
|-
| ListItem.Trailer
| Shows the full trailer path with filename of the currently selected movie in a container
|
|-
| ListItem.Writer
| Name of Writer of current Video in a container
|
|-
| ListItem.Tagline
| Small Summary of current Video in a container
|
|-
| ListItem.PlotOutline
| Small Summary of current Video in a container
|
|-
| ListItem.Plot
| Complete Text Summary of Video in a container
|
|-
| ListItem.IMDBNumber
| The IMDB iD of the selected Video in a container
|
|-
| ListItem.EpisodeName
| (PVR only) The name of the episode if the selected EPG item is a TV Show
|
|-
| ListItem.PercentPlayed
| Returns percentage value [0-100] of how far the selected video has been played
|
|-
| ListItem.LastPlayed
| Last play date of Video in a container
|
|-
| ListItem.PlayCount
| Playcount of Video in a container
|
|-
| ListItem.StartTime
| Start time of current selected TV programme in a container
|
|-
| ListItem.EndTime
| End time of current selected TV programme in a container
|
|-
| ListItem.StartDate
| Start date of current selected TV programme in a container
|
|-
| ListItem.ChannelName
| Name of current selected TV channel in a container
|
|-
| ListItem.VideoCodec
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)
|
|-
| ListItem.VideoResolution
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K, 8K [Note: v18 addition]). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.
| v18
|-
| ListItem.VideoAspect
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)
|
|-
| ListItem.AudioCodec
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)
|
|-
| ListItem.AudioChannels
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 7, 8, 10)
|
|-
| ListItem.AudioLanguage
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.SubtitleLanguage
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.Property(AudioCodec.[n])
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
|
|-
| ListItem.Property(AudioChannels.[n])
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
|
|-
| ListItem.Property(AudioLanguage.[n])
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
|
|-
| ListItem.Property(SubtitleLanguage.[n])
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
|
|-
| ListItem.AddonName
| Shows the name of the currently selected addon
|
|-
| ListItem.AddonVersion
| Shows the version of the currently selected addon
|
|-
| ListItem.AddonSummary
| Shows a short description of the currently selected addon
|
|-
| ListItem.AddonDescription
| Shows the full description of the currently selected addon
|
|-
| ListItem.AddonType
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon
|
|-
| ListItem.AddonCreator
| Shows the name of the author the currently selected addon
|
|-
| ListItem.AddonDisclaimer
| Shows the disclaimer of the currently selected addon
|
|-
| ListItem.AddonBroken
| Shows a message when the addon is marked as broken in the repo
|
|-
| ListItem.Property(Addon.Changelog)
| Shows the changelog of the currently selected addon
|
|-
| ListItem.Property(Addon.ID)
| Shows the identifier of the currently selected addon
|
|-
| ListItem.Property(Addon.Status)
| Shows the status of the currently selected addon
|
|-
| ListItem.Property(Addon.Path)
| Shows the path of the currently selected addon
|
|-
| ListItem.StartTime
| Start time of the selected item (PVR).
|
|-
| ListItem.EndTime
| End time of the selected item (PVR).
|
|-
| ListItem.StartDate
| Start date of the selected item (PVR).
|
|-
| ListItem.EndDate
| End date of the selected item (PVR).
|
|-
| ListItem.NextTitle
| Title of the next item (PVR).
|
|-
| ListItem.NextGenre
| Genre of the next item (PVR).
|
|-
| ListItem.NextPlot
| Plot of the next item (PVR).
|
|-
| ListItem.NextPlotOutline
| Plot outline of the next item (PVR).
|
|-
| ListItem.NextStartTime
| Start time of the next item (PVR).
|
|-
| ListItem.NextEndTime
| End of the next item (PVR).
|
|-
| ListItem.NextStartDate
| Start date of the next item (PVR).
|
|-
| ListItem.NextEndDate
| End date of the next item (PVR).
|
|-
| Listitem.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (PVR).
|
|-
| ListItem.ChannelNumberLabel
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.Progress
| Part of the programme that's been played (PVR).
|
|-
| ListItem.StereoscopicMode
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
|
|-
| ListItem.Comment
| Comment assigned to the item (PVR/MUSIC).
|
|-
| ListItem.AddonInstallDate
| Date the addon was installed
|
|-
| ListItem.AddonLastUpdated
| Date the addon was last updated
|
|-
| ListItem.AddonLastUsed
| Date the addon was used last
|
|-
| ListItem.AddonNews
| Returns a brief changelog, taken from the addons' addon.xml file
|
|-
| ListItem.AddonSize
| Filesize of the addon
|
|-
| ListItem.Contributors
| List of all people who've contributed to the selected song
|
|-
| ListItem.ContributorAndRole
| List of all people and their role who've contributed to the selected song
|
|-
| ListItem.EndTimeResume
| Returns the time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| ListItem.Mood
| Mood of the selected song
|
|-
| ListItem.Status
| For use with tv shows. It can return one of the following: 'returning series','in production','planned','cancelled' or 'ended'
|
|-
| ListItem.Tag
| Will return the name of the 'tag' this movie is part of.
|
|-
| ListItem.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| ListItem.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| ListItem.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| ListItem.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| ListItem.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| ListItem.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| ListItem.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| ListItem.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| ListItem.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| ListItem.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| ListItem.Appearances
| Returns the number of movies featuring the selected actor / directed by the selected director
| v17 addition
|-
| ListItem.PrivacyPolicy
| Returns the official Kodi privacy-policy
| v17 addition
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|}

=== Musicpartymode labels ===

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

=== Network labels ===

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

=== Player labels ===

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

==== Music player ====

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

==== Video player ====

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

=== Playlist ===

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

=== PVR ===

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

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

=== Skin ===

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

=== Slideshow ===

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

=== System ===

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

=== Visualisation ===

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

=== Weather labels ===

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

=== Window ===

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

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

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

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

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

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

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

=== Images Available in Kodi ===

See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items.

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

<section end="main content" />

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

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

InfoLabels

2019-02-02T17:11:55Z

Rmrector: /* Images Available in Kodi */

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

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

=== Container ===

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

=== Control ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Control.GetLabel(id)[.index()]
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.
|
|}

=== Fanart ===

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

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== ListItem ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ListItem.Label
| Shows the left label of the currently selected item in a container
|
|-
| ListItem.Label2
| Shows the right label of the currently selected item in a container
|
|-
| ListItem.Title
| Shows the title of the currently selected song or movie in a container
|
|-
| ListItem.OriginalTitle
| Shows the original title of the currently selected movie in a container
|
|-
| ListItem.SortLetter
| Shows the first letter of the current file in a container
|
|-
| ListItem.TrackNumber
| Shows the track number of the currently selected song in a container
|
|-
| ListItem.Artist
| Shows the artist of the currently selected song in a container
|
|-
| ListItem.AlbumArtist
| Shows the artist of the currently selected album in a list
|
|-
| ListItem.Property(Artist_Born)
| Date of Birth of the currently selected Artist
|
|-
| ListItem.Property(Artist_Died)
| Date of Death of the currently selected Artist
|
|-
| ListItem.Property(Artist_Formed)
| Formation date of the currently selected Band
|
|-
| ListItem.Property(Artist_Disbanded)
| Disbanding date of the currently selected Band
|
|-
| ListItem.Property(Artist_YearsActive)
| Years the currently selected artist has been active
|
|-
| ListItem.Property(Artist_Instrument)
| Instruments played by the currently selected artist
|
|-
| ListItem.Property(Artist_Description)
| Shows a biography of the currently selected artist
|
|-
| ListItem.Property(Artist_Mood)
| Shows the moods of the currently selected artist
|
|-
| ListItem.Property(Artist_Style)
| Shows the styles of the currently selected artist
|
|-
| ListItem.Property(Artist_Genre)
| Shows the genre of the currently selected artist
|
|-
| Listitem.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| ListItem.Album
| Shows the album of the currently selected song in a container
|
|-
| ListItem.Property(Album_Mood)
| Shows the moods of the currently selected Album
|
|-
| ListItem.Property(Album_Style)
| Shows the styles of the currently selected Album
|
|-
| ListItem.Property(Album_Theme)
| Shows the themes of the currently selected Album
|
|-
| ListItem.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
|
|-
| ListItem.Property(Album_Label)
| Shows the record label of the currently selected Album
|
|-
| ListItem.Property(Album_Description)
| Shows a review of the currently selected Album
|
|-
| ListItem.DiscNumber
| Shows the disc number of the currently selected song in a container
|
|-
| ListItem.Year
| Shows the year of the currently selected song, album or movie in a container
|
|-
| ListItem.Premiered
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container
|
|-
| ListItem.Genre
| Shows the genre of the currently selected song, album or movie in a container
|
|-
| ListItem.Director
| Shows the director of the currently selected movie in a container
|
|-
| ListItem.Country
| Shows the production country of the currently selected movie in a container
|
|-
| ListItem.Episode
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.Season
| Shows the season value for the currently selected tvshow
|
|-
| ListItem.TVShowTitle
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library
|
|-
| ListItem.Property(TotalSeasons)
| Shows the total number of seasons for the currently selected tvshow
|
|-
| ListItem.Property(TotalEpisodes)
| Shows the total number of episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(WatchedEpisodes)
| Shows the number of watched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(UnWatchedEpisodes)
| Shows the number of unwatched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(NumEpisodes)
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.PictureAperture
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| ListItem.PictureAuthor
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| ListItem.PictureByline
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| ListItem.PictureBylineTitle
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| ListItem.PictureCamMake
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| ListItem.PictureCamModel
| Shows the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| ListItem.PictureCaption
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| ListItem.PictureCategory
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| ListItem.PictureCCDWidth
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| ListItem.PictureCity
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| ListItem.PictureColour
| Shows whether the selected picture is "Colour" or "Black and White".
|
|-
| ListItem.PictureComment
| Shows a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| ListItem.PictureCopyrightNotice
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| ListItem.PictureCountry
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| ListItem.PictureCountryCode
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| ListItem.PictureCredit
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| ListItem.PictureDate
| Shows the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDatetime
| Shows the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDesc
| Shows a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| ListItem.PictureDigitalZoom
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| ListItem.PictureExpMode
| Shows the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| ListItem.PictureExposure
| Shows the class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| ListItem.PictureExposureBias
| Shows the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| ListItem.PictureExpTime
| Shows the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| ListItem.PictureFlashUsed
| Shows the status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| ListItem.PictureFocalLen
| Shows the lens focal length of the selected picture
|
|-
| ListItem.PictureFocusDist
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| ListItem.PictureGPSLat
| Shows the latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| ListItem.PictureGPSLon
| Shows the longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| ListItem.PictureGPSAlt
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| ListItem.PictureHeadline
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| ListItem.PictureImageType
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| ListItem.PictureIPTCDate
| Shows the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| ListItem.PictureIPTCTime
| Shows the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| ListItem.PictureISO
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| ListItem.PictureKeywords
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| ListItem.PictureLightSource
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| ListItem.PictureLongDate
| Shows only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureLongDatetime
| Shows the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureMeteringMode
| Shows the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| ListItem.PictureObjectName
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| ListItem.PictureOrientation
| Shows the orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| ListItem.PicturePath
| Shows the filename and path of the selected picture
|
|-
| ListItem.PictureProcess
| Shows the process used to compress the selected picture
|
|-
| ListItem.PictureReferenceService
| Shows the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| ListItem.PictureResolution
| Shows the dimensions of the selected picture
|
|-
| ListItem.PictureSource
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| ListItem.PictureSpecialInstructions
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| ListItem.PictureState
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| ListItem.PictureSublocation
| Shows the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| ListItem.PictureSupplementalCategories
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| ListItem.PictureTransmissionReference
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| ListItem.PictureUrgency
| Shows the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| ListItem.PictureWhiteBalance
| Shows the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| ListItem.FileName
| Shows the filename of the currently selected song or movie in a container
|
|-
| ListItem.Path
| Shows the complete path of the currently selected song or movie in a container
|
|-
| ListItem.FolderName
| Shows top most folder of the path of the currently selected song or movie in a container
|
|-
| ListItem.FolderPath
| Shows the complete path of the currently selected song or movie in a container (without user details).
|
|-
| ListItem.FileNameAndPath
| Shows the full path with filename of the currently selected song or movie in a container
|
|-
| ListItem.FileExtension
| Shows the file extension (without leading dot) of the currently selected item in a container
|
|-
| ListItem.Date
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)
|
|-
| ListItem.DateAdded
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
|
|-
| ListItem.Size
| Shows the file size of the currently selected song or movie in a container
|
|-
| ListItem.Rating[(name)]
| Shows the scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Set
| Shows the name of the set the movie is part of
|
|-
| ListItem.SetId
| Shows the id of the set the movie is part of
|
|-
| ListItem.UserRating
| Shows the user rating of the currently selected item in a container
|
|-
| ListItem.Votes[(name)]
| Shows the IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.RatingAndVotes[(name)]
| Shows the IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Mpaa
| Show the MPAA rating of the currently selected movie in a container
|
|-
| ListItem.ProgramCount
| Shows the number of times an xbe has been run from "my programs"
|
|-
| ListItem.Duration[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| ListItem.DBTYPE
| Shows the database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist). Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.
|
|-
| ListItem.DBID
| Shows the database id of the currently selected listitem in a container
|
|-
| ListItem.Cast
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.CastAndRole
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.Studio
| Studio of current selected Music Video in a container
|
|-
| ListItem.Top250
| Shows the IMDb top250 position of the currently selected listitem in a container.
|
|-
| ListItem.Trailer
| Shows the full trailer path with filename of the currently selected movie in a container
|
|-
| ListItem.Writer
| Name of Writer of current Video in a container
|
|-
| ListItem.Tagline
| Small Summary of current Video in a container
|
|-
| ListItem.PlotOutline
| Small Summary of current Video in a container
|
|-
| ListItem.Plot
| Complete Text Summary of Video in a container
|
|-
| ListItem.IMDBNumber
| The IMDB iD of the selected Video in a container
|
|-
| ListItem.EpisodeName
| (PVR only) The name of the episode if the selected EPG item is a TV Show
|
|-
| ListItem.PercentPlayed
| Returns percentage value [0-100] of how far the selected video has been played
|
|-
| ListItem.LastPlayed
| Last play date of Video in a container
|
|-
| ListItem.PlayCount
| Playcount of Video in a container
|
|-
| ListItem.StartTime
| Start time of current selected TV programme in a container
|
|-
| ListItem.EndTime
| End time of current selected TV programme in a container
|
|-
| ListItem.StartDate
| Start date of current selected TV programme in a container
|
|-
| ListItem.ChannelName
| Name of current selected TV channel in a container
|
|-
| ListItem.VideoCodec
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)
|
|-
| ListItem.VideoResolution
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K, 8K [Note: v18 addition]). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.
| v18
|-
| ListItem.VideoAspect
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)
|
|-
| ListItem.AudioCodec
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)
|
|-
| ListItem.AudioChannels
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 7, 8, 10)
|
|-
| ListItem.AudioLanguage
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.SubtitleLanguage
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.Property(AudioCodec.[n])
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
|
|-
| ListItem.Property(AudioChannels.[n])
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
|
|-
| ListItem.Property(AudioLanguage.[n])
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
|
|-
| ListItem.Property(SubtitleLanguage.[n])
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
|
|-
| ListItem.AddonName
| Shows the name of the currently selected addon
|
|-
| ListItem.AddonVersion
| Shows the version of the currently selected addon
|
|-
| ListItem.AddonSummary
| Shows a short description of the currently selected addon
|
|-
| ListItem.AddonDescription
| Shows the full description of the currently selected addon
|
|-
| ListItem.AddonType
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon
|
|-
| ListItem.AddonCreator
| Shows the name of the author the currently selected addon
|
|-
| ListItem.AddonDisclaimer
| Shows the disclaimer of the currently selected addon
|
|-
| ListItem.AddonBroken
| Shows a message when the addon is marked as broken in the repo
|
|-
| ListItem.Property(Addon.Changelog)
| Shows the changelog of the currently selected addon
|
|-
| ListItem.Property(Addon.ID)
| Shows the identifier of the currently selected addon
|
|-
| ListItem.Property(Addon.Status)
| Shows the status of the currently selected addon
|
|-
| ListItem.Property(Addon.Path)
| Shows the path of the currently selected addon
|
|-
| ListItem.StartTime
| Start time of the selected item (PVR).
|
|-
| ListItem.EndTime
| End time of the selected item (PVR).
|
|-
| ListItem.StartDate
| Start date of the selected item (PVR).
|
|-
| ListItem.EndDate
| End date of the selected item (PVR).
|
|-
| ListItem.NextTitle
| Title of the next item (PVR).
|
|-
| ListItem.NextGenre
| Genre of the next item (PVR).
|
|-
| ListItem.NextPlot
| Plot of the next item (PVR).
|
|-
| ListItem.NextPlotOutline
| Plot outline of the next item (PVR).
|
|-
| ListItem.NextStartTime
| Start time of the next item (PVR).
|
|-
| ListItem.NextEndTime
| End of the next item (PVR).
|
|-
| ListItem.NextStartDate
| Start date of the next item (PVR).
|
|-
| ListItem.NextEndDate
| End date of the next item (PVR).
|
|-
| Listitem.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (PVR).
|
|-
| ListItem.ChannelNumberLabel
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.Progress
| Part of the programme that's been played (PVR).
|
|-
| ListItem.StereoscopicMode
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
|
|-
| ListItem.Comment
| Comment assigned to the item (PVR/MUSIC).
|
|-
| ListItem.AddonInstallDate
| Date the addon was installed
|
|-
| ListItem.AddonLastUpdated
| Date the addon was last updated
|
|-
| ListItem.AddonLastUsed
| Date the addon was used last
|
|-
| ListItem.AddonNews
| Returns a brief changelog, taken from the addons' addon.xml file
|
|-
| ListItem.AddonSize
| Filesize of the addon
|
|-
| ListItem.Contributors
| List of all people who've contributed to the selected song
|
|-
| ListItem.ContributorAndRole
| List of all people and their role who've contributed to the selected song
|
|-
| ListItem.EndTimeResume
| Returns the time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| ListItem.Mood
| Mood of the selected song
|
|-
| ListItem.Status
| For use with tv shows. It can return one of the following: 'returning series','in production','planned','cancelled' or 'ended'
|
|-
| ListItem.Tag
| Will return the name of the 'tag' this movie is part of.
|
|-
| ListItem.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| ListItem.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| ListItem.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| ListItem.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| ListItem.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| ListItem.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| ListItem.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| ListItem.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| ListItem.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| ListItem.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| ListItem.Appearances
| Returns the number of movies featuring the selected actor / directed by the selected director
| v17 addition
|-
| ListItem.PrivacyPolicy
| Returns the official Kodi privacy-policy
| v17 addition
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|}

=== Musicpartymode labels ===

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

=== Network labels ===

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

=== Player labels ===

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

==== Music player ====

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

==== Video player ====

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

=== Playlist ===

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

=== PVR ===

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

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

=== Skin ===

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

=== Slideshow ===

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

=== System ===

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

=== Visualisation ===

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

=== Weather labels ===

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

=== Window ===

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

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

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

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

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

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

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

=== Images Available in Kodi ===

See [[Artwork/Accessing with skins and JSON-RPC]] for the general pattern of accessing artwork for media items.

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

<section end="main content" />

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

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

InfoLabels

2019-02-02T17:11:42Z

Rmrector: /* Images Available in Kodi */

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

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

=== Container ===

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

=== Control ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Control.GetLabel(id)[.index()]
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.
|
|}

=== Fanart ===

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

=== Game ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Game.Title
| Name of the game
| v18
|-
| Game.Platform
| Platform the game runs on (eg. Atari 2600)
| v18
|-
| Game.Genres
| Gerne of the game (eg. Action)
| v18
|-
| Game.Publisher
| Publishing company of the game (eg. Nintendo)
| v18
|-
| Game.Developer
| Developer of the game
| v18
|-
| Game.Overview
| Game description
| v18
|-
| Game.Year
| Year the game was released
| v18
|-
| Game.GameClient
| Name of the used emulator
| v18
|}

=== ListItem ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ListItem.Label
| Shows the left label of the currently selected item in a container
|
|-
| ListItem.Label2
| Shows the right label of the currently selected item in a container
|
|-
| ListItem.Title
| Shows the title of the currently selected song or movie in a container
|
|-
| ListItem.OriginalTitle
| Shows the original title of the currently selected movie in a container
|
|-
| ListItem.SortLetter
| Shows the first letter of the current file in a container
|
|-
| ListItem.TrackNumber
| Shows the track number of the currently selected song in a container
|
|-
| ListItem.Artist
| Shows the artist of the currently selected song in a container
|
|-
| ListItem.AlbumArtist
| Shows the artist of the currently selected album in a list
|
|-
| ListItem.Property(Artist_Born)
| Date of Birth of the currently selected Artist
|
|-
| ListItem.Property(Artist_Died)
| Date of Death of the currently selected Artist
|
|-
| ListItem.Property(Artist_Formed)
| Formation date of the currently selected Band
|
|-
| ListItem.Property(Artist_Disbanded)
| Disbanding date of the currently selected Band
|
|-
| ListItem.Property(Artist_YearsActive)
| Years the currently selected artist has been active
|
|-
| ListItem.Property(Artist_Instrument)
| Instruments played by the currently selected artist
|
|-
| ListItem.Property(Artist_Description)
| Shows a biography of the currently selected artist
|
|-
| ListItem.Property(Artist_Mood)
| Shows the moods of the currently selected artist
|
|-
| ListItem.Property(Artist_Style)
| Shows the styles of the currently selected artist
|
|-
| ListItem.Property(Artist_Genre)
| Shows the genre of the currently selected artist
|
|-
| Listitem.Property(Artist_Sortname)
| Sortname of the currently selected Artist
| v18
|-
| Listitem.Property(Artist_Type)
| Type of the currently selected Artist - person, group, orchestra, choir etc.
| v18
|-
| Listitem.Property(Artist_Gender)
| Gender of the currently selected Artist - male, female, other
| v18
|-
| Listitem.Property(Artist_Disambiguation)
| Brief description of the currently selected Artist that differentiates them from others with the same name
| v18
|-
| ListItem.Album
| Shows the album of the currently selected song in a container
|
|-
| ListItem.Property(Album_Mood)
| Shows the moods of the currently selected Album
|
|-
| ListItem.Property(Album_Style)
| Shows the styles of the currently selected Album
|
|-
| ListItem.Property(Album_Theme)
| Shows the themes of the currently selected Album
|
|-
| ListItem.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
|
|-
| ListItem.Property(Album_Label)
| Shows the record label of the currently selected Album
|
|-
| ListItem.Property(Album_Description)
| Shows a review of the currently selected Album
|
|-
| ListItem.DiscNumber
| Shows the disc number of the currently selected song in a container
|
|-
| ListItem.Year
| Shows the year of the currently selected song, album or movie in a container
|
|-
| ListItem.Premiered
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container
|
|-
| ListItem.Genre
| Shows the genre of the currently selected song, album or movie in a container
|
|-
| ListItem.Director
| Shows the director of the currently selected movie in a container
|
|-
| ListItem.Country
| Shows the production country of the currently selected movie in a container
|
|-
| ListItem.Episode
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.Season
| Shows the season value for the currently selected tvshow
|
|-
| ListItem.TVShowTitle
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library
|
|-
| ListItem.Property(TotalSeasons)
| Shows the total number of seasons for the currently selected tvshow
|
|-
| ListItem.Property(TotalEpisodes)
| Shows the total number of episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(WatchedEpisodes)
| Shows the number of watched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(UnWatchedEpisodes)
| Shows the number of unwatched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(NumEpisodes)
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.PictureAperture
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| ListItem.PictureAuthor
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| ListItem.PictureByline
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| ListItem.PictureBylineTitle
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| ListItem.PictureCamMake
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| ListItem.PictureCamModel
| Shows the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| ListItem.PictureCaption
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| ListItem.PictureCategory
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| ListItem.PictureCCDWidth
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| ListItem.PictureCity
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| ListItem.PictureColour
| Shows whether the selected picture is "Colour" or "Black and White".
|
|-
| ListItem.PictureComment
| Shows a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| ListItem.PictureCopyrightNotice
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| ListItem.PictureCountry
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| ListItem.PictureCountryCode
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| ListItem.PictureCredit
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| ListItem.PictureDate
| Shows the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDatetime
| Shows the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDesc
| Shows a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| ListItem.PictureDigitalZoom
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| ListItem.PictureExpMode
| Shows the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| ListItem.PictureExposure
| Shows the class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| ListItem.PictureExposureBias
| Shows the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| ListItem.PictureExpTime
| Shows the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| ListItem.PictureFlashUsed
| Shows the status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| ListItem.PictureFocalLen
| Shows the lens focal length of the selected picture
|
|-
| ListItem.PictureFocusDist
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| ListItem.PictureGPSLat
| Shows the latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| ListItem.PictureGPSLon
| Shows the longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| ListItem.PictureGPSAlt
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| ListItem.PictureHeadline
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| ListItem.PictureImageType
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| ListItem.PictureIPTCDate
| Shows the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| ListItem.PictureIPTCTime
| Shows the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| ListItem.PictureISO
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| ListItem.PictureKeywords
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| ListItem.PictureLightSource
| Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
| ListItem.PictureLongDate
| Shows only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureLongDatetime
| Shows the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureMeteringMode
| Shows the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| ListItem.PictureObjectName
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| ListItem.PictureOrientation
| Shows the orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| ListItem.PicturePath
| Shows the filename and path of the selected picture
|
|-
| ListItem.PictureProcess
| Shows the process used to compress the selected picture
|
|-
| ListItem.PictureReferenceService
| Shows the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| ListItem.PictureResolution
| Shows the dimensions of the selected picture
|
|-
| ListItem.PictureSource
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| ListItem.PictureSpecialInstructions
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| ListItem.PictureState
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| ListItem.PictureSublocation
| Shows the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| ListItem.PictureSupplementalCategories
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| ListItem.PictureTransmissionReference
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| ListItem.PictureUrgency
| Shows the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| ListItem.PictureWhiteBalance
| Shows the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| ListItem.FileName
| Shows the filename of the currently selected song or movie in a container
|
|-
| ListItem.Path
| Shows the complete path of the currently selected song or movie in a container
|
|-
| ListItem.FolderName
| Shows top most folder of the path of the currently selected song or movie in a container
|
|-
| ListItem.FolderPath
| Shows the complete path of the currently selected song or movie in a container (without user details).
|
|-
| ListItem.FileNameAndPath
| Shows the full path with filename of the currently selected song or movie in a container
|
|-
| ListItem.FileExtension
| Shows the file extension (without leading dot) of the currently selected item in a container
|
|-
| ListItem.Date
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)
|
|-
| ListItem.DateAdded
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
|
|-
| ListItem.Size
| Shows the file size of the currently selected song or movie in a container
|
|-
| ListItem.Rating[(name)]
| Shows the scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Set
| Shows the name of the set the movie is part of
|
|-
| ListItem.SetId
| Shows the id of the set the movie is part of
|
|-
| ListItem.UserRating
| Shows the user rating of the currently selected item in a container
|
|-
| ListItem.Votes[(name)]
| Shows the IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.RatingAndVotes[(name)]
| Shows the IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
|
|-
| ListItem.Mpaa
| Show the MPAA rating of the currently selected movie in a container
|
|-
| ListItem.ProgramCount
| Shows the number of times an xbe has been run from "my programs"
|
|-
| ListItem.Duration[(format)]
| Shows the song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
| ListItem.DBTYPE
| Shows the database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist). Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.
|
|-
| ListItem.DBID
| Shows the database id of the currently selected listitem in a container
|
|-
| ListItem.Cast
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.CastAndRole
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.Studio
| Studio of current selected Music Video in a container
|
|-
| ListItem.Top250
| Shows the IMDb top250 position of the currently selected listitem in a container.
|
|-
| ListItem.Trailer
| Shows the full trailer path with filename of the currently selected movie in a container
|
|-
| ListItem.Writer
| Name of Writer of current Video in a container
|
|-
| ListItem.Tagline
| Small Summary of current Video in a container
|
|-
| ListItem.PlotOutline
| Small Summary of current Video in a container
|
|-
| ListItem.Plot
| Complete Text Summary of Video in a container
|
|-
| ListItem.IMDBNumber
| The IMDB iD of the selected Video in a container
|
|-
| ListItem.EpisodeName
| (PVR only) The name of the episode if the selected EPG item is a TV Show
|
|-
| ListItem.PercentPlayed
| Returns percentage value [0-100] of how far the selected video has been played
|
|-
| ListItem.LastPlayed
| Last play date of Video in a container
|
|-
| ListItem.PlayCount
| Playcount of Video in a container
|
|-
| ListItem.StartTime
| Start time of current selected TV programme in a container
|
|-
| ListItem.EndTime
| End time of current selected TV programme in a container
|
|-
| ListItem.StartDate
| Start date of current selected TV programme in a container
|
|-
| ListItem.ChannelName
| Name of current selected TV channel in a container
|
|-
| ListItem.VideoCodec
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)
|
|-
| ListItem.VideoResolution
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K, 8K [Note: v18 addition]). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.
| v18
|-
| ListItem.VideoAspect
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)
|
|-
| ListItem.AudioCodec
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)
|
|-
| ListItem.AudioChannels
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 7, 8, 10)
|
|-
| ListItem.AudioLanguage
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.SubtitleLanguage
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.Property(AudioCodec.[n])
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
|
|-
| ListItem.Property(AudioChannels.[n])
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
|
|-
| ListItem.Property(AudioLanguage.[n])
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
|
|-
| ListItem.Property(SubtitleLanguage.[n])
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
|
|-
| ListItem.AddonName
| Shows the name of the currently selected addon
|
|-
| ListItem.AddonVersion
| Shows the version of the currently selected addon
|
|-
| ListItem.AddonSummary
| Shows a short description of the currently selected addon
|
|-
| ListItem.AddonDescription
| Shows the full description of the currently selected addon
|
|-
| ListItem.AddonType
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon
|
|-
| ListItem.AddonCreator
| Shows the name of the author the currently selected addon
|
|-
| ListItem.AddonDisclaimer
| Shows the disclaimer of the currently selected addon
|
|-
| ListItem.AddonBroken
| Shows a message when the addon is marked as broken in the repo
|
|-
| ListItem.Property(Addon.Changelog)
| Shows the changelog of the currently selected addon
|
|-
| ListItem.Property(Addon.ID)
| Shows the identifier of the currently selected addon
|
|-
| ListItem.Property(Addon.Status)
| Shows the status of the currently selected addon
|
|-
| ListItem.Property(Addon.Path)
| Shows the path of the currently selected addon
|
|-
| ListItem.StartTime
| Start time of the selected item (PVR).
|
|-
| ListItem.EndTime
| End time of the selected item (PVR).
|
|-
| ListItem.StartDate
| Start date of the selected item (PVR).
|
|-
| ListItem.EndDate
| End date of the selected item (PVR).
|
|-
| ListItem.NextTitle
| Title of the next item (PVR).
|
|-
| ListItem.NextGenre
| Genre of the next item (PVR).
|
|-
| ListItem.NextPlot
| Plot of the next item (PVR).
|
|-
| ListItem.NextPlotOutline
| Plot outline of the next item (PVR).
|
|-
| ListItem.NextStartTime
| Start time of the next item (PVR).
|
|-
| ListItem.NextEndTime
| End of the next item (PVR).
|
|-
| ListItem.NextStartDate
| Start date of the next item (PVR).
|
|-
| ListItem.NextEndDate
| End date of the next item (PVR).
|
|-
| Listitem.NextDuration
| Duration of the next item (PVR).
| v18
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (PVR).
|
|-
| ListItem.ChannelNumberLabel
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.Progress
| Part of the programme that's been played (PVR).
|
|-
| ListItem.StereoscopicMode
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
|
|-
| ListItem.Comment
| Comment assigned to the item (PVR/MUSIC).
|
|-
| ListItem.AddonInstallDate
| Date the addon was installed
|
|-
| ListItem.AddonLastUpdated
| Date the addon was last updated
|
|-
| ListItem.AddonLastUsed
| Date the addon was used last
|
|-
| ListItem.AddonNews
| Returns a brief changelog, taken from the addons' addon.xml file
|
|-
| ListItem.AddonSize
| Filesize of the addon
|
|-
| ListItem.Contributors
| List of all people who've contributed to the selected song
|
|-
| ListItem.ContributorAndRole
| List of all people and their role who've contributed to the selected song
|
|-
| ListItem.EndTimeResume
| Returns the time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| ListItem.Mood
| Mood of the selected song
|
|-
| ListItem.Status
| For use with tv shows. It can return one of the following: 'returning series','in production','planned','cancelled' or 'ended'
|
|-
| ListItem.Tag
| Will return the name of the 'tag' this movie is part of.
|
|-
| ListItem.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| ListItem.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| ListItem.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| ListItem.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| ListItem.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| ListItem.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| ListItem.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| ListItem.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| ListItem.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| ListItem.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| ListItem.Appearances
| Returns the number of movies featuring the selected actor / directed by the selected director
| v17 addition
|-
| ListItem.PrivacyPolicy
| Returns the official Kodi privacy-policy
| v17 addition
|-
| Listitem.Property(game.videofilter)
| Name of the video filter (eg. Bilinear)
| v18
|-
| Listitem.Property(game.stretchmode)
| Name of the stretch mode (eg. Stretch 4:3)
| v18
|-
| Listitem.Property(game.videorotation)
| Angle of the rotation
| v18
|}

=== Musicpartymode labels ===

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

=== Network labels ===

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

=== Player labels ===

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

==== Music player ====

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

==== Video player ====

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

=== Playlist ===

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

=== PVR ===

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

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

=== Skin ===

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

=== Slideshow ===

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

=== System ===

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

=== Visualisation ===

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

=== Weather labels ===

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

=== Window ===

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

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

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

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

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

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

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

=== Images Available in Kodi ===

See [[Artwork/Accessing with skins and JSON-RPC] for the general pattern of accessing artwork for media items.

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

<section end="main content" />

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

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

Artwork/Accessing with skins and JSON-RPC

2019-02-02T17:11:12Z

Rmrector: /* Example artwork types */

{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =

Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are {{code|Player.Art(poster)}}, {{code|Player.Art(fanart)}}, {{code|ListItem.Art(banner)}}, and {{code|ListItem.Art(tvshow.clearlogo)}}.

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==

There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =

Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==

example request:
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}

and a possible response:
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}

== Kodi-encoded URL ==

The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "images/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/images/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/images/image%3A%2F%2Fnfs%253a%252f%252fCUBER%252fmedia%252fpreserved%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =

For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|- valign="top"
| album.thumb
| ListItem.Art(thumb)
| Thumb of the currently focused media item. This has some notable fallback behavior in the video library. It will be the artwork type named exactly "thumb" if it exists for the current item, but will fall back to "poster" then "banner" if not.
|}

= {{Kodi}} version updates =

* The music library in {{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. The video library has had this level of support for some time now.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.

{{Top}}

{{updated|18}}
[[Category:Development]]

Artwork/Accessing with skins and JSON-RPC

2019-02-02T17:10:36Z

Rmrector: /* Example artwork types */

{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =

Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are {{code|Player.Art(poster)}}, {{code|Player.Art(fanart)}}, {{code|ListItem.Art(banner)}}, and {{code|ListItem.Art(tvshow.clearlogo)}}.

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==

There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =

Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==

example request:
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}

and a possible response:
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}

== Kodi-encoded URL ==

The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "images/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/images/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/images/image%3A%2F%2Fnfs%253a%252f%252fCUBER%252fmedia%252fpreserved%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =

For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|- valign="top"
| album.thumb
| List.Art(thumb)
| Thumb of the currently focused media item. This has some notable fallback behavior in the video library. It will be the artwork type named exactly "thumb" if it exists for the current item, but will fall back to "poster" then "banner" if not.
|}

= {{Kodi}} version updates =

* The music library in {{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. The video library has had this level of support for some time now.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.

{{Top}}

{{updated|18}}
[[Category:Development]]

Artwork/Accessing with skins and JSON-RPC

2019-02-02T17:03:45Z

Rmrector: /* From skins */

{{mininav|[[Development]]|[[Artwork]]}}

<section begin="intro" />The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.<section end="intro" />

Media items with a "parent" media type, such as episodes to their TV show, can also access their parent's artwork with certain prefixes, like "tvshow.poster".

= From skins =

Skins can access library artwork for media items in a list with "ListItem.Art(<arttype>)" and artwork for the currently playing item with "Player.Art(<arttype>)". "Container.Art(<arttype>)" can also be filled in some instances. Some examples are {{code|Player.Art(poster)}}, {{code|Player.Art(fanart)}}, {{code|ListItem.Art(banner)}}, and {{code|ListItem.Art(tvshow.clearlogo)}}.

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:80%" | Description
|- valign="top"
| ListItem.Art(poster)
| Artwork for the currently focused ListItem.
|- valign="top"
| Player.Art(poster)
| Artwork for the currently playing item.
|- valign="top"
| Container.Art(poster)
| Artwork for the currently focused Container. Container artwork may be filled with "parent" type media item artwork if navigating a single item, like a list of episodes from a single TV show.
|- valign="top"
| Container(555).ListItem.Art(poster)
| Artwork for the currently focused ListItem in a specific container.
|}

== Additional InfoLabels for artwork ==

There are other InfoLabels for artwork that don't match the above pattern, but many of them are deprecated. A set of them that can still be useful are

{| class="prettytable" width="100%"
|+ Additional InfoLabels
! Skin InfoLabel
! style="width:30%" | Description
! Examples
|- valign="top"
| MusicPlayer.offset(number).Cover
| Cover of the item offset by ''number'' from the currently playing item in the currently playing music player queue.
| {{code|MusicPlayer.offset(1).Cover}} - next item in queue
{{code|MusicPlayer.offset(-1).Cover}} - previous item in queue
|- valign="top"
| MusicPlayer.Position(number).Cover
| Cover of the item in position ''number'' of currently playing music player queue.
| {{code|MusicPlayer.Position(1).Cover}} - first item in queue
{{code|MusicPlayer.Position(2).Cover}} - second item in queue
|- valign="top"
| MusicPlayer.Position(number).Property(Fanart_Image)
| Fanart of the item in position ''number'' of the currently playing music player queue.
| {{code|MusicPlayer.Position(1).Property(Fanart_Image)}} - first item in queue
{{code|MusicPlayer.Position(2).Property(Fanart_Image)}} - second item in queue
|}

= From JSON-RPC =

Several JSON-RPC methods (like "VideoLibrary.GetMovies", "AudioLibrary.GetAlbumDetails", and "Playlist.GetItems") return info for media items in the library, and requesting the "art" property will return an "art" dictionary that maps all available artwork for the media item. The key is the artwork type and the value is a Kodi-encoded URL or path to the assigned artwork.

== Example ==

example request:
{"jsonrpc":"2.0","id":11,"method":"VideoLibrary.GetEpisodes","params":{"properties":["art"],"limits":{"end":1},"sort":{"method":"random"}}}

and a possible response:
{
"id": 11,
"jsonrpc": "2.0",
"result": {
"episodes": [
{
"art": {
"season.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-banner.jpg/",
"season.landscape": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-landscape.jpg/",
"season.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fseason02-poster.jpg/",
"thumb": "image://video@nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fV%20(2009)%20-%2002x05%20-%20Concordia%20-%20720p%20WEB-DL.mkv/",
"tvshow.banner": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fbanner.jpg/",
"tvshow.clearlogo": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fclearlogo.png/",
"tvshow.fanart": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2ffanart.jpg/",
"tvshow.poster": "image://nfs%3a%2f%2fCUBER%2fmedia%2fpreserved%2fTVShows%2fV%20(2009)%2fposter.jpg/"
},
"episodeid": 2196,
"label": "2x05. Concordia"
}
],
"limits": {
"end": 1,
"start": 0,
"total": 3352
}
}
}

== Kodi-encoded URL ==

The image paths returned by JSON-RPC are the path or URL to the image encoded as Kodi's internal "image://" path.

To turn that path into a URL that can actually be displayed in another application, you will need to encode it as a URI component (examples are [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeURIComponent] in JS and [https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote urllib.parse.quote] in Python 3), then add that to the end of the "images/" path of the Kodi HTTP server (like <nowiki>http://kodihost:8080/images/</nowiki>). With these URLs you can display images wherever they happen to be stored; Kodi will handle opening a file over SMB or NFS if they are stored on a NAS next to the media items, for instance.

The final URL will look like

<nowiki>http://kodihost:8080/images/image%3A%2F%2Fnfs%253a%252f%252fCUBER%252fmedia%252fpreserved%252fTVShows%252fV%2520(2009)%252fposter.jpg%2F</nowiki>

You can also turn the "image://" URL into a more traditional looking path/URL (https:// or smb:// or H:\) by chopping off the "image://" up front and the slash at the end, then decoding the rest as a URI component.

= Access "parent" artwork =

For several media types, it is possible to access artwork for the "parent" media item as well as the item's own artwork. This works for skins and JSON-RPC. For instance, TV episodes can access the artwork for the containing season and TV show. Use "<parenttype>.<arttype>" as the art type.

{| class="prettytable" width="100%"
|+ Media types and their parent types
! style="width:8%" | Media type
! Parent type
! style="width:40%" | Description
! style="width:30%" | Skin examples
|- valign="top"
| TV episodes
| "season", "tvshow"
| TV episodes can access artwork for their containing season and TV show
| "Player.Art(tvshow.clearlogo)", "Player.Art(season.poster)"
|- valign="top"
| Seasons
| "tvshow"
| TV show artwork
| "ListItem.Art(tvshow.banner)", "ListItem.Art(tvshow.clearlogo)"
|- valign="top"
| Movies
| "set"
| In Kodi 18, movies can access artwork for their containing set / collection
| "ListItem.Art(set.clearlogo)", "ListItem.Art(set.poster)"
|- valign="top"
| Songs
| "album", "artist", "albumartist", "artist1", "albumartist1"
| Songs can access the artwork for their containing album and all artists. Songs can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists. "albumartist" works the same for album artists.
| "Player.Art(album.thumb)", "Player.Art(artist.fanart)", "Player.Art(albumartist.clearlogo)", "Player.Art(artist1.fanart)"
|- valign="top"
| Albums
| "artist", "artist1"
| Albums can access the artwork for their containing album. Albums can have multiple artists; in Kodi 18 "artist1" will be artwork for the second artist - "artist2", "artist3", and so on will be filled for additional artists.
| "ListItem.Art(artist.fanart)", "ListItem.Art(artist.clearlogo)"
|}

== Example artwork types ==

Here is a short list of example artwork types and how to access them. Kodi's artwork system allows any number of artwork types, so it's impossible to list all that may be available here. See the artwork pages for different library sections like [[Movie artwork]] or [[Music artwork]] for a list of generally available artwork types, or navigate to image 2 of [[Artwork#Kodi- Choose Art]] on a media item in your local Kodi installation to see what types of artwork are currently available for at least one of that media type in your local library.

{| class="prettytable" width="100%"
|+ Example artwork types and skin access
! Artwork type
! Skin InfoLabel
! style="50%" | Description
|- valign="top"
| poster
| ListItem.Art(poster)
| Poster of the currently focused media item (like a movie or TV show)
|- valign="top"
| fanart
| ListItem.Art(fanart)
| Fanart of the currently focused media item
|- valign="top"
| landscape
| ListItem.Art(landscape)
| Landscape of the currently focused media item
|- valign="top"
| clearlogo
| Player.Art(clearlogo)
| Clearlogo of the currently playing media item
|- valign="top"
| tvshow.poster
| Player.Art(tvshow.poster)
| For a currently playing TV episode, this is the poster of the parent TV show
|- valign="top"
| set.poster
| Player.Art(set.clearlogo)
| For currently playing movies, this is the clearlogo of the containing movie set
|- valign="top"
| album.thumb
| Player.Art(album.thumb)
| For currently playing music, this is the cover of the album
|}

= {{Kodi}} version updates =

* The music library in {{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. The video library has had this level of support for some time now.
* {{Kodi}} 18 adds a '''[[Advancedsettings.xml#Music library extra artwork| whitelist in advancedsettings.xml]]''' ([[Advancedsettings.xml#Extra artwork|for the video library]]) so that {{Kodi}} will add any specified artwork from scrapers and the file system automatically.

{{Top}}

{{updated|18}}
[[Category:Development]]

User:Rmrector

2019-02-02T14:12:21Z

Rmrector:

=== v18 Artwork updates ===
* ''Nothing in progress''
* But still need to update the Movies, TV shows, and Music Videos pages

==== Merged ====
* [[User:Rmrector/Artwork/Accessing with skins and JSON-RPC - new]]
* [[User:Rmrector/Artwork - updates for Kodi 18]]
* [[User:Rmrector/Music artwork - for Kodi 18]]

Artwork

2019-02-02T14:03:45Z

Rmrector:

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} |[[HOW-TO:Create_Music_Library|Create Music Library]] {{l2|[[HOW-TO:Create_Video_Library|Create Video Library]]}}}}

<section begin="intro" />The use of artwork takes pride of place in Kodi. The 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" />

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Choose the subject that interests you to obtain further information. Information common to all categories is located on this page. Specific category details are located on linked pages.

'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''

= Flexible artwork types =

<gallery mode="packed" widths=350px heights=200px>
File:Artwork-PosterView01.jpg
File:Artwork-FanartView01.jpg
File:Artwork-Banner01.jpg
File:Artwork-PosterView02.jpg
File:Artwork-MusicArtist01.jpg
File:Artwork-ClearLogo02.jpg
</gallery>

{{Kodi}}'s support for artwork types to represent media items is very flexible: Any number of artwork can be added to a media item with free-form names that have only a few rules.
* Naming rules: artwork names must be
** only alphanumeric characters
** lowercase letters
** keep them short - 20 characters is a bit long, though not forbidden
* Named by convention so that skins and JSON-RPC consumers can find and use them reliably
* Some common types of artwork are "fanart", "clearlogo", "landscape", "banner", and "poster"

To view all art types that are already assigned in your Kodi library for any particular media type, use Kodi's built-in [[Artwork#Kodi- Choose Art| Choose Art]] dialog on nearly any item in the library (movie, TV show, episode, so on), and the list of artwork types shown on this window are assigned to at least one media item of the same type.

== Artwork whitelist ==

Starting with Kodi 18, there is a whitelist configuration for artwork types to be added automatically. This whitelist applies to all artwork added automatically by Kodi, either when scanning in local files or scraping from online sources. This allows you to share one media file library with a full artwork selection and configure individual Kodi clients separately based on processing power, skin selection, or client-local storage space (the local artwork cache takes up the most space of all Kodi running data). It is currently configured with advancedsettings.xml '''[[Advancedsettings.xml#Extra artwork| for the video library]]''' and '''[[Advancedsettings.xml#Extra artwork 2| for the music library]]'''.

= Obtaining Artwork =
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.

== Scrapers ==
A scraper is a Kodi core function which, in combination with the relevant metadata API add-on, will preform an automatic online search for movie, tv show and music information and then retrieve all relevant metadata and artwork and import the data into the Kodi Library and the artwork into the [[Artwork#Cache|cache]]. The default sources for information are:

Movies- [https://www.themoviedb.org/ The MovieDB]<br />
TV Shows- [http://thetvdb.com/ The TVDB]<br />
Music- [http://www.theaudiodb.com/ The AudioDB]<br />
<br />
There are many other scraper information sources, but most are specialist listings for foreign language movies or Disney movies, for example.

The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.

The Music scraping process is reliant on correct file naming and music tags.

Kodi will then match the video or music and download all relevant metadata and artwork. It is important to note that if you already have correctly named artwork in the video and music folder, then Kodi will scrape the local artwork and ignore the online source. Metadata will still be downloaded though.

If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to [[Artwork#Kodi-_Choose_Art|paragraph 2.1]] below.
; {{see also|Naming video files}}
; {{see also|Add-on:The Movie Database}}
; {{see also|Add-on:The TVDB}}
; {{see also|Add-on:Universal Album Scraper}}
; {{see also|Add-on:Universal Artist Scraper}}

== 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 ==
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/documentation/editing/images<nowiki>themoviedb- Image Creation Guide</nowiki>]''
*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>]''

= Importing-Scanning Artwork =
{{anchor|Importing-Scraping Artwork}}

This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.

'''When performing an Update Library or Scrape, Kodi will always use Local Artwork first if it exists. If there is no local artwork, Kodi will obtain the artwork from online sources.'''

'''It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans.''' If you have made changes to either 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 [[Music_artwork]]
#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]]'''''

== "Available" artwork ==

Scrapers and NFO files can include multiple images for a single type of artwork. The first image will be assigned to the media item for skins and other interfaces to access for display, and the full list will be saved for the "Choose art" dialog, where you can select a new image for any art type.

== Kodi- Choose Art ==
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

#Highlight the media item whose artwork you want to change.
#Call up the ''Information'' page, (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)
#* This dialog is filled with artwork already assigned to similar media items in the library. If your type of artwork is not listed, then use the '''Add art''' button. 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 Page
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 scraper site, 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:
#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 artwork and metadata - Select '''No''' note- If you have no local nfo file, Kodi will scrape metadata from the online scraper site
#*To scrape online artwork and metadata - Select '''Yes'''

= Artwork details for media sections =

<gallery mode="packed" widths=350px heights=200px>
File:Skin.rapier fullscreen music.jpg
File:Artwork-MusicBanner01.jpg
File:Artwork-FanartView02.jpg
File:Rapier new tvshows.jpg
File:Artwork-Animated01.gif
File:Artwork-musiclandscape-EstuaryATF.jpg
</gallery>

== Movie Artwork ==
{{#lst:Movie_artwork|intro}}
{{see|Movie artwork}}

== TV Show Artwork ==
{{#lst:TV-Show_artwork|intro}}
{{see|TV-Show artwork}}

== Music Artwork ==
{{#lst:Music_artwork|intro}}
{{see|Music artwork}}

== Music Videos Artwork ==
{{#lst:Music_Video_artwork|intro}}
{{see|Music Video artwork}}

== Live TV Artwork ==
{{#lst:Live_TV_Artwork|intro}}
{{see|Live TV Artwork}}

== Pictures Artwork ==
There is no user definable artwork for the Pictures section of Kodi.<br />
:'''''See: [[Pictures]]

All images added to Pictures are cached as follows:
#Embedded EXIF previews are scanned and cached. If none available then
#Preview images are created and cached
:'''''See: [[Artwork#Cache|Artwork Cache]]'''''<br />

To add an image to the folder icon:
:'''''See: [[Movie_artwork#Source Folder Artwork|Folder Image]]'''''

= 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 ==
{{#lst:import-export_library|intro}}
; {{see also|Import-export library}}

= 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}}

= Animated artwork - experimental =

Kodi has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

== Limitations of animated artwork ==

Kodi's support for displaying animated artwork is basic, and does have some limitations.

Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
* Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
** 1920 × 1080 = 2,073,600 * 11 =
*** 22,809,600 pixels '''plus''' one more frame

Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.

= Accessing with skins and JSON-RPC =
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
; {{see also|Artwork/Accessing with skins and JSON-RPC}}

{{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-02-02T13:58:06Z

Rmrector: /* Artwork details for media sections */

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} |[[HOW-TO:Create_Music_Library|Create Music Library]] {{l2|[[HOW-TO:Create_Video_Library|Create Video Library]]}}}}

<section begin="intro" />The use of artwork takes pride of place in Kodi. The 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" />

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Choose the subject that interests you to obtain further information. Information common to all categories is located on this page. Specific category details are located on linked pages.

'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''

= Flexible artwork types =

<gallery mode="packed" widths=350px heights=200px>
File:Artwork-PosterView01.jpg
File:Artwork-FanartView01.jpg
File:Artwork-Banner01.jpg
File:Artwork-PosterView02.jpg
File:Artwork-MusicArtist01.jpg
File:Artwork-ClearLogo02.jpg
</gallery>

{{Kodi}}'s support for artwork types to represent media items is very flexible: Any number of artwork can be added to a media item with free-form names that have only a few rules.
* Naming rules: artwork names must be
** only alphanumeric characters
** lowercase letters
** keep them short - 20 characters is a bit long, though not forbidden
* Named by convention so that skins and JSON-RPC consumers can find and use them reliably
* Some common types of artwork are "fanart", "clearlogo", "landscape", "banner", and "poster"

To view all art types that are already assigned in your Kodi library for any particular media type, use Kodi's built-in [[Artwork#Kodi- Choose Art| Choose Art]] dialog on nearly any item in the library (movie, TV show, episode, so on), and the list of artwork types shown on this window are assigned to at least one media item of the same type.

== Artwork whitelist ==

Starting with Kodi 18, there is a whitelist configuration for artwork types to be added automatically. This whitelist applies to all artwork added automatically by Kodi, either when scanning in local files or scraping from online sources. This allows you to share one media file library with a full artwork selection and configure individual Kodi clients separately based on processing power, skin selection, or client-local storage space (the local artwork cache takes up the most space of all Kodi running data). It is currently configured with advancedsettings.xml '''[[Advancedsettings.xml#Extra artwork| for the video library]]''' and '''[[Advancedsettings.xml#Extra artwork 2| for the music library]]'''.

= Obtaining Artwork =
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.

== Scrapers ==
A scraper is a Kodi core function which, in combination with the relevant metadata API add-on, will preform an automatic online search for movie, tv show and music information and then retrieve all relevant metadata and artwork and import the data into the Kodi Library and the artwork into the [[Artwork#Cache|cache]]. The default sources for information are:

Movies- [https://www.themoviedb.org/ The MovieDB]<br />
TV Shows- [http://thetvdb.com/ The TVDB]<br />
Music- [http://www.theaudiodb.com/ The AudioDB]<br />
<br />
There are many other scraper information sources, but most are specialist listings for foreign language movies or Disney movies, for example.

The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.

The Music scraping process is reliant on correct file naming and music tags.

Kodi will then match the video or music and download all relevant metadata and artwork. It is important to note that if you already have correctly named artwork in the video and music folder, then Kodi will scrape the local artwork and ignore the online source. Metadata will still be downloaded though.

If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to [[Artwork#Kodi-_Choose_Art|paragraph 2.1]] below.
; {{see also|Naming_video_files}}
; {{see also|Add-on:The_Movie_Database}}
; {{see also|Add-on:The_TVDB}}
; {{see also|Add-on:Universal_Album_Scraper}}
; {{see also|Add-on:Universal_Artist_Scraper}}

== 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 ==
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/documentation/editing/images<nowiki>themoviedb- Image Creation Guide</nowiki>]''
*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>]''

= Importing-Scanning Artwork =
{{anchor|Importing-Scraping Artwork}}

This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.

'''When performing an Update Library or Scrape, Kodi will always use Local Artwork first if it exists. If there is no local artwork, Kodi will obtain the artwork from online sources.'''

'''It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans.''' If you have made changes to either 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 [[Music_artwork]]
#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]]'''''

== "Available" artwork ==

Scrapers and NFO files can include multiple images for a single type of artwork. The first image will be assigned to the media item for skins and other interfaces to access for display, and the full list will be saved for the "Choose art" dialog, where you can select a new image for any art type.

== Kodi- Choose Art ==
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

#Highlight the media item whose artwork you want to change.
#Call up the ''Information'' page, (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)
#* This dialog is filled with artwork already assigned to similar media items in the library. If your type of artwork is not listed, then use the '''Add art''' button. 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 Page
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 scraper site, 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:
#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 artwork and metadata - Select '''No''' note- If you have no local nfo file, Kodi will scrape metadata from the online scraper site
#*To scrape online artwork and metadata - Select '''Yes'''

= Artwork details for media sections =

<gallery mode="packed" widths=350px heights=200px>
File:Skin.rapier fullscreen music.jpg
File:Artwork-MusicBanner01.jpg
File:Artwork-FanartView02.jpg
File:Rapier new tvshows.jpg
File:Artwork-Animated01.gif
File:Artwork-musiclandscape-EstuaryATF.jpg
</gallery>

== Movie Artwork ==
{{#lst:Movie_artwork|intro}}
{{see|Movie artwork}}

== TV Show Artwork ==
{{#lst:TV-Show_artwork|intro}}
{{see|TV-Show artwork}}

== Music Artwork ==
{{#lst:Music_artwork|intro}}
{{see|Music artwork}}

== Music Videos Artwork ==
{{#lst:Music_Video_artwork|intro}}
{{see|Music Video artwork}}

== Live TV Artwork ==
{{#lst:Live_TV_Artwork|intro}}
{{see|Live TV Artwork}}

== Pictures Artwork ==
There is no user definable artwork for the Pictures section of Kodi.<br />
:'''''See: [[Pictures]]

All images added to Pictures are cached as follows:
#Embedded EXIF previews are scanned and cached. If none available then
#Preview images are created and cached
:'''''See: [[Artwork#Cache|Artwork Cache]]'''''<br />

To add an image to the folder icon:
:'''''See: [[Movie_artwork#Source_Folder_Artwork|Folder Image]]'''''

= 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 ==
{{#lst:import-export_library|intro}}
; {{see also|Import-export library}}

= 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}}

= Animated artwork - experimental =

Kodi has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].

== Limitations of animated artwork ==

Kodi's support for displaying animated artwork is basic, and does have some limitations.

Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
* Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
** 1920 × 1080 = 2,073,600 * 11 =
*** 22,809,600 pixels '''plus''' one more frame

Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.

= Accessing with skins and JSON-RPC =
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
; {{see also|Artwork/Accessing with skins and JSON-RPC}}

{{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]]