View source for Settings/Media/Music

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

__TOC__


= Library Display and Navigation =
[[File:Settings-Media-Music-01.jpg|600px]]


== Show "All items" entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Advanced
|- valign="top"
| '''Description:'''
| Show an "All items" entry in the music library views. eg. ''All albums'' or ''All artists''.
|}


== Show song and album artists ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| When enabled both song and album artists are shown. When disabled only album artists are shown.
When disabled, artists that appear only on songs on compliation albums or as guest artist on an album by another artist are not listed.
|}


== Split albums into individual discs ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Basic
|- valign="top"
| '''Description:'''
| When enabled, opening an album that contains two or more discs will list the avaialble discs in the album or boxset. Select a disc to view the songs.
Disable the setting to display the songs instead of the discs. <ref>https://github.com/xbmc/xbmc/pull/16915</ref>
|}


== Use artist sortname when sorting by artist ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| When Enabled, this setting will change the sort order of artists from name (''Taylor Swift'') to sortname (''Swift, Taylor''). Band/Group names are not affected.
|}


== Use original release date of albums for year ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Advanced
|- valign="top"
| '''Description:'''
| When enabled it allows albums to be sorted by the original album release date instead of the album re-release date.<ref>https://github.com/xbmc/xbmc/pull/17437</ref>
|}



= Library Information Sources =
[[File:Settings-Media-Music-02.jpg|600px]]


== Fetch additional information during updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Advanced
|- valign="top"
| '''Description:'''
| When enabled album and artist additional information will be automatically fetched via scrapers from remote sites or NFO files, as the final phase of library scanning. This can be a slow process if you have a large music collection. 
If this is the initial creation of your library, and you are unsure about the quality of your music file tagging, leave this setting disabled and first check the accuracy of your scanned music and fix tagging errors where required. The additional information can be fetched later from the Context Menu in the Artists and Albums listing.
|}


== Artist information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Select the folder where artist nfo files and local artwork are stored. 
|-
| '''See Also:'''
| '''''[[Artist information folder]]'''''
|}


== Default provider for album information ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Selects the default album information provider (scraper) for albums.
|}


== Default provider for artist information ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Selects the default album information provider (scraper) for artists.
|}


== Prefer online information ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| When enabled some artist and album data in the library, which had been derived from music file tags, will be overwritten by information that is downloaded from the scraper site or from a NFO file. 
For a list of library fields and tags that will be overwritten see '''[[NFO files/Music]]'''. 
This will not modify the music file themselves in any way, only the library entries. However this option is being deprecated, only enable if you are absolutely sure you want to do it and understand the consequences. It can not be used to fix bad tagging of music files.
|}



= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Music-03.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Music-04.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18173</ref>


== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- (default) Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''album/artist thumbs'' and ''fanart'' only. 
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. These advanced settings can be used to control where individual artwork types are scanned or scraped from. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

{{see|Artwork}}

The following four settings relate to the '''Custom''' setting.


== Use all local image files as artwork ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| The same as the ''Maximum'' setting but only applies to ''local'' artwork.
|}


== Use all remote artwork fetched by scrapers ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| The same as the ''Maximum'' setting but only applies to ''online'' artwork.
|}


== Artist art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Create a whitelist of Artist artwork to be used in the {{kodi}} library. Kodi standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed. 
|}


== Album art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Create a whitelist of Album artwork to be used in the {{kodi}} library. Kodi standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed. 
|}


== Thumbnail image files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Expert
|- valign="top"
| '''Description:'''
| Nominate the name of album image files that {{kodi}} should search for in your album folders. The most common are pre-selected.
|}


== Prefer online album art ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| When enabled and when no local album cover exists:
* Online art will be fetched from online providers and
* Embedded images in music files will only be used when neither local art or online art is available.<br>
This is useful if the covers embedded in music files are low resolution and the user would prefer the higher quality results fetched by the scraper.
|-
| '''See Also:'''
| '''''[[Music artwork#Library_Artwork_Source_Priority| Library Artwork Source Priority]]'''''
|}



= General =
[[File:Settings-Media-Music-05.jpg|600px]]


== Switch to visualisation on playback ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Basic
|- valign="top"
| '''Description:'''
| Automatically switch to the fullscreen visualisation when playback commences.<ref>https://github.com/xbmc/xbmc/pull/17225</ref>
|}


== Track naming template ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Expert
|- valign="top"
| '''Description:'''
| The track naming template controls how names of songs are displayed in library views '''when sorted by track number'''.<br>
In order to extend this function to File view mode, the setting ''Enable tag reading in file view'' must be enabled.<br>
The default setting is '''[%N.]%A-%T''' which displays as '''''Track No.Artist name-Track name'''''
<section begin="Track naming template" />
{| class="prettytable" 
|-
! scope="row"| Music Data
|  TrackNumber ||  DiscNumber ||  Artist ||  Title ||  Album ||  Genre ||  Year ||  FileName ||  Duration ||  Date ||  Rating ||  File Size ||  User Rating
|-
! scope="row"| Mask Characters
| style="text-align:center;" |  %N 
| style="text-align:center;" |  %S
| style="text-align:center;" |  %A
| style="text-align:center;" |  %T
| style="text-align:center;" |  %B
| style="text-align:center;" |  %G
| style="text-align:center;" |  %Y
| style="text-align:center;" |  %F
| style="text-align:center;" |  %D
| style="text-align:center;" |  %J
| style="text-align:center;" |  %R
| style="text-align:center;" |  %I
| style="text-align:center;" |  %r
|}
'''Note:''' The above table details the commonly used masks for the music library.
A full list can be found in the Master branch [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/LabelFormatter.cpp#L66 here]. This Master list is a combined video and music library listing for the current Master branch which may be a newer Kodi version to the one you have installed.
<section end="Track naming template" />
{| class="prettytable" 
!colspan="2" style="width:150px; text-align:left" | Format Characters
!style="width:10px; text-align:left;" |
!colspan="2" style="text-align:left"| Usage Example
|-
! scope="row"| Bold 
|  [[B]...[/B]] || 
| style="background-color:#d3d3d3;" | Raw tag 
| [%N] [[I]%A[/I]] - %B : [[B]%T[/B]]
|-
! scope="row"| Italic
|  [[I]...[/I]] || 
| style="background-color:#d3d3d3;" | Output 
| [track nr.] ''artist'' - album : '''title'''
|}
|-
|
| An example using coloured and italic text:<br>
''(note: the closing [/color] tag is intentionally omitted to overcome a bug)''
<syntaxhighlight lang="xml">
[[COLOR yellow][COLOR red]%A[/COLOR][COLOR white][B]] - %B[[/B][I] - %T[/I][/COLOR]][ - %N]
</syntaxhighlight>
With the more complex templates, it may be easier to directly edit the '''[[Userdata#guisettings.xml|GUI settings.xml]]''' file located in the '''[[Userdata]]''' folder, as shown in the below image. '''Exit {{kodi}} before performing this edit.'''
[[File:TrackNamingTemplate-01.jpg|1000px]]
|}


== Search for thumbs on remote shares ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Advanced
|- valign="top"
| '''Description:'''
| When this option is enabled, Kodi will search for thumbs on network shares including DVD and CD.<br>
Due to the long seek/read times required to perform this function this will slow the listing of network folders quite dramatically (particularly if there are many items that have no thumbs). 
|}


== Enable tag reading in file view ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}} 
| Standard
|- valign="top"
| '''Description:'''
| Applies to File View only. When enabled, File view will display the song name from the embedded metadata along with other details rather than just the file name. However reading tags from every music file in real time can slow browsing the music files, especially for folders with a lot of music files or when accessed over a network. It is recommended that you can “Scan” your songs into the library by following the guide. Among many advantages this will allow File View to show additional song details without having to re-read tags everytime.
|}
{{-}}



= References =
<references />




{{top}}
{{updated|20}}

[[Category:Settings]]