Settings/Media/Library: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Music Edits)
(v21 Updates)
 
(8 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]]
= 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]]
= 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 ===
== Ignore different video versions on scan ==
<section begin="IgnoreVideoVersionsScan" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Settings ► Media ► Library ► Video Library ► '''Ignore different video versions on scan'''
 
* '''Disabled''' - When an Update Library is run and the scanner discovers a title that may be a duplicate of another title already scanned into the library, the Update Library will pause with a pop-up requesting confirmation on how to treat the duplicate. The Library Update will not continue until the pop-up is cleared.
* '''Enabled''' - (default) When an Update Library is run, there are no interruptions to the scan and the various versions will be scanned or scraped into the library without a video version being created. Use the Versions Manager method described below to create a Video Version after scanning has ended.
|}<section end="IgnoreVideoVersionsScan" />
 
 
== 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.<br/>Videos in the ''Extras'' folder will be treated like a movie file and added to the library. To avoid this ensure the advancedsettings.xml file has the correct ignore code.<br/>See: '''[[Add-on:Extras#Preventing_Extras_Being_Added_To_Library|Preventing Extras being added to the library]]'''
|}<section end="IgnoreVideoExtrasScan" />
 
 
== Clean library ==
{|
{|
|- valign="top"
|- valign="top"
Line 68: Line 113:
|- 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.
| 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 131:
|- 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 144:
|- 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]]
= 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 161:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Check for new media files for all connected sources at 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 174:
|- 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 185:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used if you have moved, deleted or renamed files. 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.
| 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 songs with invalid paths
* Removes any albums which have no references
* Removes any albums which have no references
Line 133: Line 195:




=== Export library ===
== Export library ==
{|
{|
|- valign="top"
|- valign="top"
Line 140: Line 202:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Export the music library database to XML files. This will optionally overwrite your current XML files. Only Album and Artist data is exported and song data such as rating, play count, and last time played are not exported<br />
| 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.  
{{see also|Import-export library|NFO files}}
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 152: Line 215:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Import XML files (aka nfo files) into the music library database. The data is only imported if the library entry exists via initially scanning the source.
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.<br>
If it exists:
See: '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
# It removes all current info for that entry from the database.
# Inserts the info for that entry from the XML file.<br />
{{see also|Import-export library|NFO files}}
|}
|}




{{Top}}
{{Top}}
{{updated|21}}


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

Latest revision as of 00:54, 1 May 2024

Home icon grey.png   ▶ Settings ▶ Media ▶ Library



Manage Sources

Settings media library manage sources.jpg


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

Settings-Media-Library-VideoLibrary.jpg


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.


Ignore different video versions on scan

Settings level: Basic
Description:

Settings ► Media ► Library ► Video Library ► Ignore different video versions on scan

  • Disabled - When an Update Library is run and the scanner discovers a title that may be a duplicate of another title already scanned into the library, the Update Library will pause with a pop-up requesting confirmation on how to treat the duplicate. The Library Update will not continue until the pop-up is cleared.
  • Enabled - (default) When an Update Library is run, there are no interruptions to the scan and the various versions will be scanned or scraped into the library without a video version being created. Use the Versions Manager method described below to create a Video Version after scanning has ended.


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. To avoid this ensure the advancedsettings.xml file has the correct ignore code.
    See: Preventing Extras being added to the library


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

Settings media library music library.jpg


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



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