Archive:Advanced topics

From Official Kodi Wiki
Jump to navigation Jump to search

This section covers advanced topics for power users and those not afraid to break things.

1 Topics

Advancedsettings.xml
The advancedsettings.xml file, which does not exist by default, can be created by a user in their userdata folder.

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

Artist information folder
In v18 the concept of the Artist Information Folder is introduced as a new way to handle providing local artist artwork and information via nfo files. The Artist Information Folder is a user nominated folder that Kodi will look in first for artwork or NFO files for any artist.

This topic is of interest to those users that want to provide local artwork for artists, or capture their current artist art and additional data for transfer to another installation of Kodi

Edit decision list
An edit decision list (EDL) contains information about edits that should be made to the video during playback. Edit decision list information is contained in a separate file to the video that is read by Kodi just before the video is played. Examples of use include can be to skip commercials, cut out content inappropriate for children, or skip over the half hour acid trip in 2001: A Space Odyssey .
External players
While the built in video and audio players are capable, out of the box, to handle a huge variety of content, users might find themselves in need of using a different playback software but still using Kodi for scraping and organizing content. Reasons might include improved post-processing abilities, DRM restricted media that requires a specific player (such as encrypted Blu-ray discs), special player-specific features, etc. Kodi has a powerful tool to achieve this, the external player. The current method involves the configuration of a playercorefactory.xml file.
Import-export library/Music
Music navigation
This page will provide information to navigate around the music section and the various ways to play your music.
Music tagging
MySQL
If you have more than one Kodi device on your local network then you might want to synchronize them by sharing the Kodi library databases via the MySQL protocol. Using shared library databases allows you to store information for either your video or music library in a central database, so that multiple devices can access the same information at the same time.
PVR/Backends
The backend software interfaces with the TV tuner card and decodes channel signals and enables all the Live TV and PVR functionality.
PVR/Basics
Details the steps for installing the Kodi add-on, adjusting settings and navigating.
PVR/Tuner cards
A Tuner Card is a device that allows connecting a coaxial cable from a household TV antenna connection or set top box to your computer to view and stream TV and radio channels to your PC and other devices.
Party Mode
Party mode is a quick and simple option to create a continuous playlist of music from your library. As the name implies it is a great way to set and forget music playback for parties.
Path substitution
Path substitutions are settings in advancedsettings.xml to force Kodi to use different 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. Path subs work for most file and folder paths. Path subs work across local and network paths, across different network protocols, and can even be used with some of the special protocol.
Sources.xml
Special protocol
The "Special Protocol" is Kodi's solution to platform dependent directories. Common directory names are assigned a special://[name] path which is passed around inside Kodi and then translated to the platform specific path before the operating system sees it. This helps keep most of the platform mess centralized in the code.
Update Music Library
Wake on lan
Starting in v13, Kodi can automatically issue a 'wake-on-lan' packet to MySQL or a file sharing server right before it needs to connect to it.


2 How-tos

HOW-TO:Change data location for Android
As of v14, Kodi supports a backdoor to specify the location of your settings folder, which includes the userdata folder and add-ons. It is the equivalent of using environment variables on other platforms
HOW-TO:Modify automatic watch and resume points
This page describes three advancedsettings.xml settings that can be used to modify when "watched" and "resume" marks are saved. These settings can also be used to prevent automatically saving watched and resume points. A watched point records if a video has been watched or not. A resume point records where in a video file playback has stopped, so it can be resumed later.
HOW-TO:Modify dirty regions
Dirty regions is an advanced setting and interface rendering method that can help speed up the GUI in Kodi and decrease the demand on your CPU and GPU. Dirty regions has no effect during video playback unless there are GUI elements (on screen buttons) visible. Using dirty regions requires Kodi v11 (Eden) or higher.
HOW-TO:Modify the video cache
This page describes three advancedsettings.xml settings that can be used to maximize the video playback cache. You can use all or just a couple of these settings to see significant improvements in cache performance, should you require it (most users will not require these modifications). This can help with intermittent network issues, buffering, reduce how long the network is tied up, and sometimes improve battery life.
HOW-TO:Modify time seeking
This page describes various advancedsettings.xml settings that can be used to modify the default seek "steps" in Kodi, commonly mapped to the directional keys during playback (left, right, up, down). By default, up/down is "BigStepForward/Back" +/- 10 minutes, and left/right is "StepForward/Back" +/- 30 seconds. There is also "SmallStepBack", which is -7 seconds. All of these options can be modified.
HOW-TO:Update SQL databases when files move

Kodi has functions to fully manage its database files. Some advanced operations can be performed by editing the database tables directly on your PC. Be forewarned that database tables are relational (inter-related) - do not change any entries unless you are sure of the implications! Make a backup first, and worst-case, you just have to delete the corrupt database file and rescan your music, videos, or programs from within Kodi.