Settings/Media/Library: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
← Older edit
Davu (talk | contribs)
Patroller
683 edits
No edit summary
mNo edit summary
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{bigger|This category provides access to the windows for source managemeent and the Library settings for the databases.}}
{{mininav| [[Settings]] | [[Settings/Media|Media]]  }}
 
 
__TOC__
__TOC__


== Manage Sources ==
 
[[File:Settings_media_library_manage_sources.jpg|500px|right]]
= Manage Sources =
=== Videos ===
[[File:Settings_media_library_manage_sources.jpg|600px]]
 
 
== Videos ==
{|
{|
|- valign="top"
|- valign="top"
Line 11: Line 16:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| This provides access to where video sources can be added and otherwise managed.
| This provides access to the Video Sources. It is an alternate access to Videos►Files from the main menu.<br>
See: '''[[HOW-TO:Create Video Library]]'''
|}
|}




=== Music ===
== Music ==
{|
{|
|- valign="top"
|- valign="top"
Line 22: Line 28:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| This provides access to where music sources can be added and otherwise managed.
| This provides access to the Music Sources. It is an alternate access to Music►Files from the Music menu.<br>
See: '''[[HOW-TO:Create Music Library]]'''
|}
|}




=== Pictures ===
== Pictures ==
{|
{|
|- valign="top"
|- valign="top"
Line 33: Line 40:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| This provides access to where picture sources can be added and otherwise managed
| This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.<br>
See: '''[[Pictures]]'''
|}
|}




== Video Library ==
 
[[File:Settings_media_library_video_library.jpg|500px|right]]
= Video Library =
=== Update library on startup ===
[[File:Settings-Media-Library-VideoLibrary.jpg|600px]]
 
 
== Update library on startup ==
{|
{|
|- valign="top"
|- valign="top"
Line 46: Line 57:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Check for new mediafiles on given sources on startup.
| Check for new video content every time {{kodi}} is started.
'''Note: '''If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
See: '''[[Updating or removing videos]]'''
|}
|}




=== Hide progress of library updates ===
== Hide progress of library updates ==
{|
{|
|- valign="top"
|- valign="top"
Line 57: Line 70:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Hide the library scanning progress bar during scans.
| Hide the pop-up progress bar.
|}
|}




=== Clean library ===
== Group the different versions of videos ==
<section begin="IgnoreVideoVersionsScan" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Settings ► Media ► Library ► Video Library ► '''Group the different versions of videos'''<br>
This new setting in v22 replaces the former ''Ignore different video versions on scan''<br>
* '''Off''' - No action taken on any video versions. ''Off'' is the same as ''Enabled'' using the former setting
* '''Ask''' - When versions are found, library scans will pause until a response is made by the user. ''Ask'' is the same as ''Disabled'' using the former setting.
* '''Auto''' - Automatically creates a new version without user intervention. Library scans are not interrupted.
Auto uses the same existing video-matching algorithms as Ask (search by unique id then title and year) and when there is a single match, creates a new version with the type of the new setting Default version type. The default type is "Standard Edition", with a selection from all the defined types in the system.
The default value is "Off", same as the current setting. <ref>https://github.com/xbmc/xbmc/pull/28349</ref>
|}<section end="IgnoreVideoVersionsScan" />
: See: '''[[Video_versions|Video Versions]]'''
 
 
== Make the most recent version the default version ==
<section begin="recentversiondefault" />
{|
{|
|- valign="top"
|- valign="top"
Line 68: Line 102:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Remove items from our library that can't be found (either renamed, deleted or on removable storage that is currently unplugged.
|  
Settings ► Media ► Library ► Video Library ► '''Make the most recent version the default version'''<br>
Setting is visible when either ''Ask'' or ''Auto'' are selected in the previous setting.<br>
When an existing version or movie exists and a new version is scanned into the library, this new version becomes the default version.<br>
Users who prefer managing default version themselves should disable this setting. <ref>https://github.com/xbmc/xbmc/pull/28668</ref>
|}<section end="recentversiondefault" />
: See: '''[[Video_versions|Video Versions]]'''
 
 
== Ignore video extras on scan ==
<section begin="IgnoreVideoExtrasScan" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Settings ► Media ► Library ► Video Library ► '''Ignore video extras on scan'''
 
* '''Disabled''' - When an Update Library is run, and if a folder named ''Extras'' exists, any video files in the folder will be added to the Extras listing for the movie.<br/>
See: '''[[Video_extras|Video Extras]]'''
* '''Enabled''' - (default) When an Update Library is run, any extras in the ''Extras'' folder will not be added to the Extras listing. Videos in the ''Extras'' folder will be treated like a movie file and added to the library. If this is unwanted, ensure the advancedsettings.xml file has the correct ignore code.<br/>
See: '''[[Video_extras#Advancedsetting.xml|Video Extras Advanced Settings]]'''
|}<section end="IgnoreVideoExtrasScan" />
 
 
== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Is used to clean orphaned entries in the library database. Not all tables are cleaned by this process.
 
Removing content from disconnected sources<br/>
If storage media are disconnected, using this function will not remove their contents from the library. This protects your library from accidental erasure in case a removable storage device is unplugged.<br/>
To permanently remove titles from the library:
# Use the correct method of removing titles from the library as detailed in the link below.<br>
# After correctly deleting from the library first, ''then'' run a clean library to purge the database of unnecessary records.<br>
See: '''[[Updating_or_removing_videos#Remove_From_Library|Removing content]]'''
|}
|}




=== Export library ===
== Export library ==
{|
{|
|- valign="top"
|- valign="top"
Line 79: Line 154:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Export the video library database to XML files. This will optionally overwrite your current XML files
| Export the contents of the video library. Used as a backup of your library, or to create a new {{kodi}} installation.
{{note|For the Video library, we recommend using the Separate Files method.}}<br>
See: '''[[Import-export_library/Video|Export Video Library]]'''
|}
|}


=== Import library ===
 
== Import library ==
{|
{|
|- valign="top"
|- valign="top"
Line 89: Line 167:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Import a XML file into the video library database
| If you exported your library using the '''Single File''' method, use this to import the single file into the video library.<br>
See: '''[[Import-export_library/Video#Import|Import Single File]]'''
|}
|}




== Music Library ==
 
[[File:Settings_media_library_music_library.jpg|500px|right]]
= Music Library =
=== Update library on startup ===
[[File:Settings_media_library_music_library.jpg|600px]]
 
 
== Update library on startup ==
{|
{|
|- valign="top"
|- valign="top"
Line 102: Line 184:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Check for new mediafiles on given sources on startup
| Check for new music content every time {{kodi}} is started.
'''Note:''' If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
See: '''[[Update Music Library]]'''
|}
|}




=== Hide progress of library updates ===
== Hide progress of library updates ==
{|
{|
|- valign="top"
|- valign="top"
Line 113: Line 197:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Hide the library scanning progress bar during scans
| Hide the pop-up library scanning progress bar during scans.
|}
|}




=== Clean library ===
== Clean library ==
{|
{|
|- valign="top"
|- valign="top"
Line 124: Line 208:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Remove items from our library that can't be found (either renamed, deleted or on removable storage that is currently unplugged
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used when you have moved, deleted or renamed files. To remove music from the library, delete the music files first then run the Clean library option.<br>
If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.
* Removes any songs with invalid paths
* Removes any albums which have no references
* Removes any artists which have no references
* Removes any genres which have no references
* Removes any paths which have no references
|}
|}




=== Export library ===
== Export library ==
{|
{|
|- valign="top"
|- valign="top"
Line 135: Line 225:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Export the music library database to XML files. This will optionally overwrite your current XML files
| Music files are still required to have the correct embedded tags to be scanned into the library. This function will export the additional data that was scraped into the music library.  
For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.<br>
See: '''[[Import-export_library/Music|Export Music Library]]'''
|}
|}




=== Import library ===
== Import library ==
{|
{|
|- valign="top"
|- valign="top"
Line 146: Line 238:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Import a XML file into the music library database
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.<br>
See: '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
|}
|}
= Maintenance =
[[File:Settings-Media-Library-Maintenance.jpg|600px]]
== Clean image cache ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| v22 adds a conservative image cache cleaning process. It removes images from the cache if they are not in the video or music library and have not been used in the past month. It is a  a background process checking up to 1000 images up to 4 times per day.<br>
This setting allows the user to clear all old images at once. <ref>https://github.com/xbmc/xbmc/pull/25293</ref>
|}
= References =
<references />
{{Top}}
{{updated|22}}
[[Category:Settings]]

Latest revision as of 08:46, 16 October 2026

  ▶ Settings ▶ Media ▶ Library



Manage Sources


Videos

Settings level: Standard
Description: This provides access to the Video Sources. It is an alternate access to Videos►Files from the main menu.

See: HOW-TO:Create Video Library


Music

Settings level: Standard
Description: This provides access to the Music Sources. It is an alternate access to Music►Files from the Music menu.

See: HOW-TO:Create Music Library


Pictures

Settings level: Standard
Description: This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.

See: Pictures


Video Library


Update library on startup

Settings level: Standard
Description: Check for new video content every time Kodi is started.

Note: If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
See: Updating or removing videos


Hide progress of library updates

Settings level: Standard
Description: Hide the pop-up progress bar.


Group the different versions of videos

Settings level: Basic
Description:

Settings ► Media ► Library ► Video Library ► Group the different versions of videos
This new setting in v22 replaces the former Ignore different video versions on scan

  • Off - No action taken on any video versions. Off is the same as Enabled using the former setting
  • Ask - When versions are found, library scans will pause until a response is made by the user. Ask is the same as Disabled using the former setting.
  • Auto - Automatically creates a new version without user intervention. Library scans are not interrupted.

Auto uses the same existing video-matching algorithms as Ask (search by unique id then title and year) and when there is a single match, creates a new version with the type of the new setting Default version type. The default type is "Standard Edition", with a selection from all the defined types in the system. The default value is "Off", same as the current setting. [1]

See: Video Versions


Make the most recent version the default version

Settings level: Advanced
Description:

Settings ► Media ► Library ► Video Library ► Make the most recent version the default version
Setting is visible when either Ask or Auto are selected in the previous setting.
When an existing version or movie exists and a new version is scanned into the library, this new version becomes the default version.
Users who prefer managing default version themselves should disable this setting. [2]

See: Video Versions


Ignore video extras on scan

Settings level: Basic
Description:

Settings ► Media ► Library ► Video Library ► Ignore video extras on scan

  • Disabled - When an Update Library is run, and if a folder named Extras exists, any video files in the folder will be added to the Extras listing for the movie.

See: Video Extras

  • Enabled - (default) When an Update Library is run, any extras in the Extras folder will not be added to the Extras listing. Videos in the Extras folder will be treated like a movie file and added to the library. If this is unwanted, ensure the advancedsettings.xml file has the correct ignore code.

See: Video Extras Advanced Settings


Clean library

Settings level: Advanced
Description: Is used to clean orphaned entries in the library database. Not all tables are cleaned by this process.

Removing content from disconnected sources
If storage media are disconnected, using this function will not remove their contents from the library. This protects your library from accidental erasure in case a removable storage device is unplugged.
To permanently remove titles from the library:

  1. Use the correct method of removing titles from the library as detailed in the link below.
  2. After correctly deleting from the library first, then run a clean library to purge the database of unnecessary records.

See: Removing content


Export library

Settings level: Advanced
Description: Export the contents of the video library. Used as a backup of your library, or to create a new Kodi installation.

Note: For the Video library, we recommend using the Separate Files method.
See: Export Video Library


Import library

Settings level: Advanced
Description: If you exported your library using the Single File method, use this to import the single file into the video library.

See: Import Single File


Music Library


Update library on startup

Settings level: Standard
Description: Check for new music content every time Kodi is started.

Note: If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
See: Update Music Library


Hide progress of library updates

Settings level: Standard
Description: Hide the pop-up library scanning progress bar during scans.


Clean library

Settings level: Advanced
Description: Performs cleanup tasks on the Music database. Used to de-clutter the database of unused records. Used when you have moved, deleted or renamed files. To remove music from the library, delete the music files first then run the Clean library option.

If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.

  • Removes any songs with invalid paths
  • Removes any albums which have no references
  • Removes any artists which have no references
  • Removes any genres which have no references
  • Removes any paths which have no references


Export library

Settings level: Advanced
Description: Music files are still required to have the correct embedded tags to be scanned into the library. This function will export the additional data that was scraped into the music library.

For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.
See: Export Music Library


Import library

Settings level: Advanced
Description: If you exported your library using the Single File method, use this to import the single file into the music library.

See: Import Single File


Maintenance


Clean image cache

Settings level: Expert
Description: v22 adds a conservative image cache cleaning process. It removes images from the cache if they are not in the video or music library and have not been used in the past month. It is a a background process checking up to 1000 images up to 4 times per day.

This setting allows the user to clear all old images at once. [3]


References

  1. ↑ https://github.com/xbmc/xbmc/pull/28349
  2. ↑ https://github.com/xbmc/xbmc/pull/28668
  3. ↑ https://github.com/xbmc/xbmc/pull/25293



Return to top
Retrieved from "https://kodi.wiki/index.php?title=Settings/Media/Library&oldid=264649"