Official Kodi Wiki - User contributions [en]

Raspberry Pi

2017-04-24T14:38:12Z

ChristW: /* Random notes */ remove empty bullet point

{{mininav|[[Devices]]}}
{{device notice}}

[[File:Pi2ModB1GB_-comp.jpeg|320px|right]]

{{forum link2|1=For more info and help, check out the [http://forum.kodi.tv/forumdisplay.php?fid=166 Kodi Raspberry Pi support forum]}}
<section begin="intro" />The '''Raspberry Pi''', '''Raspberry Pi 2'''/'''3''' and '''Raspberry Pi Zero''' are a series of ARM-powered, credit card-sized single-board computers (developer boards) made in the UK by the non-profit Raspberry Pi Foundation organization for educational and hobbyist purposes. These low power computers are mass produced at very low prices and the high number of units sold gives it massive community support. As Kodi HTPC, all Raspberry Pis support full 1080p (Full HD) video playback of the most commonly used codecs, most if not all Kodi [[add-ons]], and have reasonably responsive GUI performance.<section end="intro" />

== Installing Kodi ==
{{Main|HOW-TO:Install Kodi on Raspberry Pi}}
{{#lst:HOW-TO:Install Kodi on Raspberry Pi|install}}

== Frequently Asked Questions ==
{{see|Raspberry Pi FAQ}}

== Maximizing performance ==
<section begin="performance" />
{{note|Some of these tweaks are more aimed at the Pi 1 CPUs (A, B, A+, B+, Compute Module, Zero) as they only have a slow single-core CPU. Raspberry Pi 2/3 probably doesn't need some of these tweaks to run Kodi really well, but it also won't hurt anything, if you really want to push things to their limit.}}

* Avoid "heavy" skins and lots of "service" type add-ons that run in the background.

* Turn off RSS feeds and any scrolling text options for your skin. Depending on the skin/text, this can really boost a Pi 1, sometimes even a Pi 2/3.

* Use an SD card with good rewrite speeds. The class of the SD card doesn't always mean it will be better, as that speed classification is for sustained reading and writing, whereas for Kodi, random read/write speeds are more important.
::* [http://elinux.org/RPi_SD_cards#Working_.2F_Non-working_SD_cards Raspberry Pi only supports SDHC cards], apart from a few exceptions where the cards are marked as SDXL but maintain SDHC compatibility.
::* [http://swag.raspberrypi.org/products/noobs-8gb-sd-card The class 6/8 Samsung SD cards sold on the Raspberry Pi Store] (the ones with NOOBS on them) typically have much better performance than many class 10 cards.
::* Samsung "EVO" SD/mSD cards also have very excellent read/write speed for their price.
::* For [http://www.raspberrypi.org/forums/viewtopic.php?p=53159 more information about SD card speeds, read this excellent thread on the R-Pi forum].

* You can also try a combination of SD and fast USB drive for your Kodi install, but with the recent software improvements even just using a good SD card is about as fast as using a fast USB drive.

* Avoid using wifi. If you do use wifi, use a wifi adapter that contains two antennae (internal or external) that advertises "300 Mbps". Otherwise, stick to wired ethernet, local USB drives, or ethernet-over-power devices (like Homeplug).
::* [http://openelec.tv/forum/124-raspberry-pi/73670-the-best-wireless-usb-adapter-for-raspberry-pi-b Edimax EW-7811UTC AC600 is highly recommended in this thread].

* If you are using wifi and it seems just on the edge of being fast enough, check out '''[[HOW-TO:Modify the video cache]]'''.

* Try using '''[[NFS]]''' file shares instead of SMB file shares.

* [http://forum.osmc.tv/showthread.php?tid=6825 Try mounting network shares through OS rather than Kodi]. This allows more tweaking of filesystem options, like chosing UDP and larger block sizes.

* [http://forum.kodi.tv/showthread.php?tid=199272 Overclock]. Most Pi's can handle a significant overclock, as long as they have a good power supply. There is no universal setting that will work for everyone (except for the default speed that you get without overclocking). Try various overclocking settings and run Kodi for a while to see if it's stable. If one group of overclocking settings causes crashes, try a group of lower settings.
:: {{note|Overclocking is pretty important for the Raspberry Pi 1 (A, B, A+, B+) and Zero, but much less so on the Pi 2/3 due to the multiple CPU cores as well as increased speed per core. You can still overclock the Pi 2 if you really want to, but for most users it makes little difference.}}

* By default, "Extract thumbnail and video information" (in '''[[Settings/Video#File lists|file lists settings]]''') is disabled on the Pi, improving browsing performance.

* For smoother video playback, enable "Adjust display refresh rate to match video" in '''[[Settings/Video#Playback|playback settings]]'''

* When using dvdplayer, "Sync playback to display" and "adjust PLL" for sync method are recommended; see '''[[Settings/Video#Playback|playback settings]]'''.

* Make sure the video is using H.264 (up to High Profile — [[Hi10P]] will not work), or MPEG-4, or, if additional codecs have been enabled, MPEG-2 or VC-1.

* Passthrough is recommended as it lowers CPU usage for DTS and AC3. Use '''[[Settings/System#Audio output|audio passthrough]]''' if your TV/receiver supports it.

* To determine which audio passthrough formats your HDMI-connected TV supports, you can log in via SSH and run this command: <code>/opt/vc/bin/tvservice a</code> (on OpenELEC: <code>tvservice -a</code>).

* Feeling adventurous? [[Development builds#Raspberry Pi specific testing|Check out the latest OpenELEC test builds]], which often have even more speed improvements. Just remember that these builds can often be unstable!

* For locally connected drives containing videos and music, the filesystem can have an impact on read and write speeds. NTFS for example tends to be much slower on any Linux-based system than the more native ext2, ext3, etc.

* If you use [[MySQL]], you will want to make sure that your images are pre-cached using the '''[[Texture Cache Maintenance utility]] tool'''. Local libraries typically don't need this as their images are cached when videos are scanned in. Using MySQL can improve performance as the database queries are handled by another machine.

* Organizing your movies in single folders for each movie, rather than all movies in one folder, is recommended. The individual folders reduce the time it takes for Kodi to look for supporting media like external subtitles, which makes browsing, scanning and starting playback a little faster. You might also want to consider pre-scraping the meta data using a '''[[Library manager]]''' to reduce the time it takes to scan in both movies and TV shows.

* [http://forum.kodi.tv/showthread.php?tid=222498 For Raspberry Pi units with only 256MB of RAM, see this thread].
<section end="performance" />

== Remote controls ==
[[File:gpioir.png|right|250px|thumb|Wiring instructions for a TSOP4838 GPIO IR sensor.]]
;GPIO IR receiver
:Don't have a CEC TV or a smartphone remote? For less than a dollar/euro, you can add an IR receiver to your Raspberry Pi that works with most MCE and Apple remotes (and a few others). Most Kodi install options for the Pi should work with the GPIO IR out of the box, or by enabling a setting from within Kodi. Go to a local electronics store or search on eBay for "<code>TSOP4838</code>" and use some simple jumper wires (or solder the pins directly, if you wish). ''<small>(We need a link to a good, up to date GPIO IR guide. Most of the links I found are outdated and contain instructions for additional configurations that are no longer required. If you find a good link/guide, please add it to the wiki.)</small>''

:If you are using '''[[OpenELEC]]''', just add this to your config.txt file ''(full help page '''[http://wiki.openelec.tv/index.php?title=Guide_To_lirc_rpi_GPIO_Receiver here]''')'':
::<pre>dtoverlay=lirc-rpi</pre>

:The default GPIO pin used is 18. This can be changed by using the following
::<pre>dtoverlay=lirc-rpi,gpio_in_pin=18</pre>
:Where <code>pin=18</code> would be changed to whatever GPIO pin number you would rather use.

:If you are using '''[[OSMC]]''', your remote will probably work out of the box. If it doesn't, go to My OSMC -> Remotes and select your desired remote. There is also [https://osmc.tv/store/product/osmc-remote-control/ an official OSMC remote] which also works on other distributions.

;[[CEC]]
:If your TV supports '''[[CEC]]''', you should be able to use the remote control that came with your TV to control Kodi. The remote control signals are sent over the HDMI cable and most often don't require any further settings or configuration.

;[[MCE remotes]]
:Various '''MCE''' USB receivers and remotes will work on the Pi.

;[[Keyboards]] and mice
:Any '''[[keyboard]]''' such as wired, wireless, bluetooth. This includes remotes that are seen as keyboards, such as Rii remotes, the Mele F10-Pro remote, or the (very awesome) '''[[Flirc]]'''.

;[[Smartphone/tablet remotes]]
:Use your smartphone or tablet as a remote control.

;[[Web interface]]s
:Control Kodi from anything that has a web browser.
{{-}}

== Further reading ==
* [http://raspberrypi.org RaspberryPi.org]
* [http://elinux.org/RaspberryPiBoard Raspberry Pi Hub Wiki]
* [http://lea-linux.org/documentations/Raspberry_Pi Raspberry Pi French Wiki]
* [[Wikipedia:Raspberry Pi]]

== Random notes ==
{{large|''Feel free to place various notes, tips, and links here. As this section of the wiki gets more organized, those notes will be properly sorted. Consider this like a dumping ground for when you're not sure where to put something.''}}
* Notes for using a Pi with a GPIO touch screen:
** http://forum.kodi.tv/showthread.php?tid=222880&pid=2000331#pid2000331
** http://markamc.traki-iski.co.uk/raspberry-pixbian-egalax-touchscreen/
** http://arendwierks.blogspot.nl/p/touchscreen-fix-raspberry-pi-xbmc-kodi.html

* Add-on for turning off the HDMI port when idle: https://github.com/timker/kodi.screensaver.pimon

{{Updated|16}}

[[Category:Linux]]
[[Category:HTPC]]
[[Category:Raspberry Pi]]
[[Category:Broadcom]]
[[Category:ARM]]

LibreELEC

2017-04-24T14:33:21Z

ChristW: Fixed typos, made a sentence more readable.

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[Installing]]{{l2|[[Linux]]}}}}

<section begin=intro />'''LibreELEC''' (short for "''Libre Embedded Linux Entertainment Center''") is a non-profit fork of [[OpenELEC]], a small and very fast booting, open source [[JeOS implementations for Kodi|JeOS (Just enough Operating System)]]. LibreELEC is a complete media center software suite for embedded systems and computers, as it comes with a pre-configured version of Kodi and optional third-party [[PVR]] backend software.<section end=intro />

LibreELEC works on most computers and you can install {{kodi}} on the [[Raspberry Pi]] as well as a few other selected single-board computers and media player devices. LibreELEC is, like OpenELEC, also optimized to be used with flash based drives, like compact flash, USB drives, or SSD harddrives.

This fork of OpenELEC was announced in March of 2016 as a split from the OpenELEC team after "creative differences", taking with it a number of active developers at the time which joined the new LibreELEC project.

== Main features ==
LibreELEC includes all features that {{kodi}} has to offer and in some cases more.

== Installing LibreELEC ==

A detailed guide about installing LibreELEC can be found at their wiki page: [http://wiki.libreelec.tv/index.php?title=Installation Installation]

== Updating LibreELEC ==

A detailed guide about updating LibreELEC can be found at their wiki page: [http://wiki.libreelec.tv/index.php?title=Updating_LibreELEC Updating]

== Back Up Configuration/settings ==

== Further reading ==

* [https://wiki.libreelec.tv/index.php?title=Main_Page LibreELEC Wiki]
* [http://www.libreelec.tv LibreELEC Homepage]
* [http://wiki.libreelec.tv/index.php?title=Installation Installing LibreELEC]

== See also ==
* [[JeOS implementations for Kodi]]
* [[Raspberry Pi]]

[[Category:LibreELEC|*]]
[[Category:OpenELEC|*]]
[[Category:Linux]]
[[Category:Raspberry Pi]]
[[Category:Embedded distro]]

NFO files/Movies

2015-11-23T10:10:11Z

ChristW: /* Editing the .NFO file */

{{mininav|[[NFO files]]}}
=== Video .nfo Files containing XML data ===
1. The *.nfo file is an XML file containing the data for inclusion in the library.

movie.nfo will override all and any .nfo files in the same folder as the media files if you use the "Use foldernames for lookups" setting. If you don't, then moviename.nfo is used.
If there is only one .nfo file in a folder, The scraper will use it for all media files in that folder. If there are multiple media files in a folder, the *.nfo should be named exactly the same as the video file it is representing (ie. '''moviename.avi''' and '''moviename.nfo''').

<section begin="stacking note" />{{note|In the case of multi-part (stacked) video '''[[file stacking]]''', name the file either '''moviename.nfo''' or '''moviename-CD1.nfo''' where the first filename is '''moviename-CD1.avi'''.}}<section end="stacking note" />

{{note|If your movie is ripped as VOB's and stored in a 'VIDEO_TS' folder, you will have to name the file 'VIDEO_TS.nfo' and place it in the same directory with the VIDEO_TS.ifo file.}}

Additionally the 'set' tag can be used to help sort movies that are [[Movie Sets|part of a series or collection]] (ie Harry Potter, James Bond films). This sort of collection tagging must be done in the .NFO file before the movie is scanned into the library.

<syntaxhighlight lang="xml" enclose="div">
<movie>
<title>Who knows</title>
<originaltitle>Who knows for real</originaltitle>
<sorttitle>Who knows 1</sorttitle>
<set>Who knows trilogy</set>
<rating>6.100000</rating>
<year>2008</year>
<top250>0</top250>
<votes>50</votes>
<outline>A look at the role of the Buckeye State in the 2004 Presidential Election.</outline>
<plot>A look at the role of the Buckeye State in the 2004 Presidential Election.</plot>
<tagline></tagline>
<runtime>90</runtime> //runtime in minutes
<thumb>http://ia.ec.imdb.com/media/imdb/01/I/25/65/31/10f.jpg</thumb>
<mpaa>Not available</mpaa>
<playcount>0</playcount>
<id>tt0432337</id>
<filenameandpath>c:\Dummy_Movie_Files\Movies\...So Goes The Nation.avi</filenameandpath>
<trailer></trailer>
<genre></genre>
<credits></credits>
<fileinfo>
<streamdetails> 
</streamdetails>
</fileinfo>
<director>Adam Del Deo</director>
<actor>
<name>Paul Begala</name>
<role>Himself</role>
</actor>
<actor>
<name>George W. Bush</name>
<role>Himself</role>
</actor>
<actor>
<name>Mary Beth Cahill</name>
<role>Herself</role>
</actor>
<actor>
<name>Ed Gillespie</name>
<role>Himself</role>
</actor>
<actor>
<name>John Kerry</name>
<role>Himself</role>
</actor>
</movie>
</syntaxhighlight>

=== Video .nfo files containing a URL ===
2. The *.nfo file contains a URL of the information page to scrape.
The file can include other information (i.e. scene info), Kodi will scan through it and use a relevant URL if a match is found.

The scraper tries to match URL's to all scrapers of the content type a directory is set to. e.g. if you set the content type to movies, all movie scrapers check .nfo files for a matching URL. This means that .nfo files override the scraper setting. I.e. a directory is set to use the IMDB scraper but you have a German movie in it. Simply create an .nfo for that movie with the OFDB link in it and you are sorted!

* <code>Moviename.nfo</code> placed next to Moviename.avi where Moviename is the name of the movie file.

* <code>movie.nfo</code> if you use the "Use Foldername for Lookups" option, movie.nfo takes priority over any other .nfo files.

If you use the "Movies are in separate folders that match the movie title" [[Set Contents (Video Library)#Options After Selecting Scraper|scraper setting]] Kodi will use the first nfo file it finds in the folder (other than the .nfo files described above) and apply it to any valid video file it finds in the same folder.

=== Video .nfo files containing a mix of XML and URL ===
You can also create .nfo files that contain both XML data and an URL.
This is useful for instance, if you want the entry in your database to have another name than the one officially provided by the scraper, for the movie to sort differently or the movie to be a part of a movie set.

Example:
<syntaxhighlight lang="xml" enclose="div">
<movie>
<title>Sin City (Recut, Extended, Unrated)</title>
<runtime>147 min.</runtime>
</movie>
http://www.imdb.com/title/tt0401792/
</syntaxhighlight>

<syntaxhighlight lang="xml" enclose="div">
<movie>
<title>Star Wars (1977 Original Theatrical Release)</title>
<runtime>121 min.</runtime>
<set>Star Wars Saga</set>
<sorttitle>Star Wars1</sorttitle>
</movie>
http://www.imdb.com/title/tt0076759/
</syntaxhighlight>

By default the xml entry is '''added''' to the scraped entry in the database and may result in some duplicates. If you want to completely override the scraped result you need to set a clear attribute for the relevant xml tag in the .nfo file.

Example:
<syntaxhighlight lang="xml" enclose="div">
<movie>
<genre clear="true">Action</genre>
<genre>Horror</genre>
<genre>Thriller</genre>
<director clear="true">Frank Miller</director>
<director>Robert Rodriguez</director>
<director>Quentin Tarantino</director>
</movie>
http://www.imdb.com/title/tt0401792/
</syntaxhighlight>

Currently supported tags for the clear attribute are genre, director, studio, actor, credits and artist for Music Videos.

=== Movie sets ===

<syntaxhighlight lang="XML" enclose="div">
<movie>
<title>Hellboy - Uncut Extended</title>
<set>Hellboy Collection</set>
<sorttitle>Hellboy 1</sorttitle>
</movie>
http://www.themoviedb.org/movie/1487
</syntaxhighlight>
* Get the URL at the end by searching the movie on your favorite movie DB site (but you need a [[scraper]] for Kodi of this site) and copy the link from the address bar of the browser.
* Doing it this way has the advantage, to get all other information like cast, poster, fanart, rating, etc. automatically from the movie DB site, while being able to specify the exact title.<br />''This is especially helpful for example for the themoviedb.org, which does not recognise "Uncut", "Extended Version", etc. in the movie title.''
* '''Only single movie sets are supported'''

==== Editing the .NFO file ====
The two tags we’re interested in are shown on the [[NFO files/movies]] page, but not really explained. They are:
* '''<sorttitle>''': This tag is used to give a secondary ’sort title’ that will be used to order the movies when sorting the movies by name. The easiest way to handle this is to just use “Die Hard 1″, "Die Hard 2″, etc.
Since Kodi also remembers views for different folders, you could also just sort this folder by movie year, rather than name, and achieve the same result.
* '''<set>''': This tag is used to give a name to the set, or series, so that it can be listed in your Movies view.

For the Die Hard example we would add the following tags to each .NFO file in the movie series.
<syntaxhighlight lang="XML" enclose="div">
<sorttitle>Die Hard 1</sorttitle>
<set>Die Hard Collection</set>
</syntaxhighlight>
''Note that the sorttitle tag is an option tag that is not specific to sets. You only need it if you want your movies to sort by a different name other than their actual title. It is safe to leave it out if you would rather just use the date sort.''

=== Movie tags ===
To add a movie to one or multiple tags an [[NFO files|NFO file]] can be created and for every tag an XML tag can be added like this
<syntaxhighlight lang="XML" enclose="div">
<movie>
...
<tag>Name of the tag</tag>
...
</movie>
</syntaxhighlight>
If there's no tag with the specified name it will be automatically created and the tag will be attached to the movie. A movie can be added to multiple tags by adding it multiple times.

{{tip|See '''[[Video library tags]]'''}}
{{frodo updated}}

[[Category:Scraper]]
[[Category:Video library]]
[[Category:Manual]]

NFO files

2015-04-30T13:29:08Z

ChristW: {{kodi}} where needed

{{mininav|[[Video library]] {{l2|[[Music library]]}}|[[Video management|Management]] <br />  }}
{{see also|Set content and scan}}
<section begin="intro" />NFO files can be used to provide data for a video file in {{kodi}} or influence the search behaviour of scrapers. In particular they are helpful if the information fetched from a web site does not match the video file, or data for that particular file does not exist.<section end="intro" />

By default at the time of scanning, if the media folder contains a correctly named *.nfo file, then {{kodi}} will load the *.nfo file and attempt to either, in the case of it containing XML data get the meta-data directly from the .nfo file or will parse it for a direct URL to the scraper info page. This allows {{kodi}} to skip its normal lookup and/or search procedures; this is useful if a file's information is not available on any of the scraper sites or if the file-matching criteria fail for the particular file.

After the NFO files are scanned into the library, the NFO file is no longer used and only serves as a backup. If you make changes to the NFO file you will need to '''[[refresh]]''' that library entry for the changes to be loaded into Kodi.

{{kodi}} also contains a Local-NFO-only mode for when you add videos to the library, but this mode is only required if you want to prevent online-lookups for videos that lack NFO files. See '''[[Set content and scan#Local NFO only options]]''' for more information on this Local-NFO-only mode.

== Getting an .NFO file ==
Various options:

=== .NFO exists ===
If you have a movie with an .NFO file already, continue with the next section.

=== Create an .NFO file (recommended) ===
* This is recommended to have .NFO files only where needed.
* Create a text file with a text editor (e.g. notepad) with '''exactly the same name as the movie file''' (if all movies in one dir; in case each movie has its own folder, place the '''.nfo''' file there and the name does not matter). The extension has to be '''.nfo''' (e.g. ''Hellboy (2004) English.DTS.1080p.x264.nfo'').

=== Export .NFO files for all movies ===
* First you need to have all the movies scanned into your [[Video Library]].
* Once this is done you’ll need to export your library as a series of separate .NFO files. This can be done by going to [[Videos Settings|Settings > Video]] > Library and choosing Export Library. Make sure you choose the separate files option, and a bunch of .NFO files (one for every movie) will be dumped to the directories the movies are stored in.
{{tip|See '''[[Import-export library]]'''}}
* Once you have the .NFO you'll need to open it for all the movies in the series and add some info to them.

== NFO Examples ==

Below are the different sections explained on how to create specific nfo files for them.

* '''[[NFO files/movies|Movies]]'''
:* [[NFO files/movies#Movie sets|Movie sets]]
:* [[NFO files/movies#Movie tags|Movie tags]]

* '''[[NFO files/tvshows|TV Shows]]'''

:* '''[[NFO files/tvepisodes|TV Episodes]]'''

* '''[[NFO files/musicvideos|Music videos]]'''

* '''[[NFO files/music|Music]]'''

== Importing library information from "My Movies" media management software ==
[http://www.mymovies.dk/ My Movies (www.mymovies.dk)] is an online database for profiling DVD-Video movies. [http://www.mymovies.dk/ My Movies] saves an XML file and a poster cover image which with this patch will get scanned by {{kodi}} in the same way as {{kodi}}'s own XML formatted NFO files are scanned/scraped.

{{kodi}} has the ability to get the import movie library information from "[http://www.mymovies.dk/ My Movies]" via the mymovies.xml files that it generates, these mymovies.xml are checked after the movie.nfo file.

{{gotham updated}}

[[Category:Scraper]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Manual]]

Media sources

2015-01-05T12:49:59Z

ChristW:

{{mininav|[[Video library]]{{l2|[[Music library]]}} }}
<section begin="intro" />Media Sources are virtual links to the content you wish {{kodi}} to use. When you enter any of the [[Videos]], [[Music]], [[Pictures]] or the [[Filemanager]], you will see an entry for "Add Sources". When you first start with {{kodi}} you should at least add one source, like a drive or directory on your {{kodi}} device to get you started.<section end="intro" />

If you select "Add sources" a dialog appears, where you may manually input a path, or browse to a source that contains media that you would like {{kodi}} to use and display. As an example, if you enter the Music section, you could tell {{kodi}} where it should look for your music. This can be as simple as selecting a folder on your computer or you can also choose to browse your home network for media.

== Adding media sources ==
{{Main|Adding video sources}}

You can select as many sources you like if you have content in different places. When you have finished browsing and found the folder you would like, you should input a name for your source. This name will be displayed when you browse your sources under Videos -> Files. When a source, or a folder within a source, has '''[[adding video sources|content set]]''' then those entries will be added to the '''Movies''' and '''TV Shows''' options in the [[home screen]].

=== Root file selection ===
[[File:Add pictures.jpg|right|300px]]
By default every root section includes a ''Add Sources'' button that you can click to start adding sources. This can be disabled though [[Appearance Settings#View Options|Settings/Appearance/View Options/Disable add source buttons in file lists]].
{{-}}

=== Via the context menu ===
[[File:bookmark.add.jpg|right|300px]]
While in the root of any of {{kodi}}'s sections you being up the context menu by pressing {{keypress|C}} on a keyboard or {{button|guide}} on a remote. From there you can also edit any of your current sources, just make sure you have the source you wish to edit selected.

{{note|The exact options shown in the context menu will change depending on where you are in {{kodi}}.}}
{{-}}

== Add source window ==
{{incomplete}}
[[File:Source.add.jpg|500px|right]]
Browse or enter the name and location (Local / IP ) you wish to assign to the source.
For more detailed information on the virtual keyboard including USB, gamepad, remote, and remote t9 text input see the [[On Screen Keyboard]] section of the manual.

From here you can also set the content of your media source, '''''see:''''' [[Set Contents (Video Library)|Advanced Topics/Set Content (Video Library)]]. With this feature you can let {{kodi}} pick the FanArt and Thumbnails from the internet that way giving your {{kodi}} a very nice look by showing the appropriate FanArt and Thumbnails when browsing your media.

{{-}}

== Network file sharing ==
{{See|File sharing}}

== Internet streams ==
{{main|STRM|Add-ons|RSS media source}}
{{#lst:STRM|intro}}
{{-}}

== Scanning sources into the library ==
{{main|Set content and scan}}
{{#lst:Set content and scan|intro}}
{{-}}

== Locking ==
{{see also|Settings/System#Master lock}}
<section begin="Locking" />
If you want to make a source more private, you can use ''lockcodes or passwords'' to protect that source. The easiest way to accomplish this in {{kodi}}, is using the GUI dialogs. First, enable the Master Lock in {{highlight|bordered=yes|[[Settings/System/Master lock]]}}. After enabling the Master Lock, a ''Set Lock'' button will pop up in the ''Context Menu'' allowing you to set a lock on specific sources. {{kodi}} will ask for the ''master lock code'' and then give you the opportunity to set a unique ''Password'' on that specific share. To ''Remove the Lock'' you need to remember the ''Master Lock'' code.<br />

{{note| Locking a source means you only give it protection in {{kodi}}. Outside {{kodi}} the source is still available and only protected, or not protected at all, by the Operating System. In the same way, if someone has access to manually edit the ''sources.xml'' he or she can remove or change the settings for the locked source. So, don't feel too safe when you protect a source in {{kodi}}.}}
<section end="Locking" />

== See also ==
* [[Adding videos to the library]]
* [[Video library/Setting content and scanning|Setting content and scanning]]
* [[Sources.xml]]
* [[List of media source types]]
* [[File sharing]]
* [[Filemanager]]
{{Frodo updated}}

[[Category:Manual]]
[[Category:Settings]]
[[Category:File sharing]]
[[Category:Video library]]
[[Category:Music library]]

Media sources

2015-01-05T12:48:33Z

ChristW: /* Adding media sources */

{{mininav|[[Video library]]{{l2|[[Music library]]}} }}
<section begin="intro" />Media Sources are virtual links to the content you wish XBMC to use. When you enter any of the [[Videos]], [[Music]], [[Pictures]] or the [[Filemanager]], you will see an entry for "Add Sources". When you first start with XBMC you should at least add one source, like a drive or directory on your XBMC device to get you started.<section end="intro" />

If you select "Add sources" a dialog appears, where you may manually input a path, or browse to a source that contains media that you would like XBMC to use and display. As an example, if you enter the Music section, you could tell XBMC where it should look for your music. This can be as simple as selecting a folder on your computer or you can also choose to browse your home network for media.

== Adding media sources ==
{{Main|Adding video sources}}

You can select as many sources you like if you have content in different places. When you have finished browsing and found the folder you would like, you should input a name for your source. This name will be displayed when you browse your sources under Videos -> Files. When a source, or a folder within a source, has '''[[adding video sources|content set]]''' then those entries will be added to the '''Movies''' and '''TV Shows''' options in the [[home screen]].

=== Root file selection ===
[[File:Add pictures.jpg|right|300px]]
By default every root section includes a ''Add Sources'' button that you can click to start adding sources. This can be disabled though [[Appearance Settings#View Options|Settings/Appearance/View Options/Disable add source buttons in file lists]].
{{-}}

=== Via the context menu ===
[[File:bookmark.add.jpg|right|300px]]
While in the root of any of {{kodi}}'s sections you being up the context menu by pressing {{keypress|C}} on a keyboard or {{button|guide}} on a remote. From there you can also edit any of your current sources, just make sure you have the source you wish to edit selected.

{{note|The exact options shown in the context menu will change depending on where you are in {{kodi}}.}}
{{-}}

== Add source window ==
{{incomplete}}
[[File:Source.add.jpg|500px|right]]
Browse or enter the name and location (Local / IP ) you wish to assign to the source.
For more detailed information on the virtual keyboard including USB, gamepad, remote, and remote t9 text input see the [[On Screen Keyboard]] section of the manual.

From here you can also set the content of your media source, '''''see:''''' [[Set Contents (Video Library)|Advanced Topics/Set Content (Video Library)]]. With this feature you can let XBMC pick the FanArt and Thumbnails from the internet that way giving your XBMC a very nice look by showing the appropriate FanArt and Thumbnails when browsing your media.

{{-}}

== Network file sharing ==
{{See|File sharing}}

== Internet streams ==
{{main|STRM|Add-ons|RSS media source}}
{{#lst:STRM|intro}}
{{-}}

== Scanning sources into the library ==
{{main|Set content and scan}}
{{#lst:Set content and scan|intro}}
{{-}}

== Locking ==
{{see also|Settings/System#Master lock}}
<section begin="Locking" />
If you want to make a source more private, you can use ''lockcodes or passwords'' to protect that source. The easiest way to accomplish this in XBMC, is using the GUI dialogs. First, enable the Master Lock in {{highlight|bordered=yes|[[Settings/System/Master lock]]}}. After enabling the Master Lock, a ''Set Lock'' button will pop up in the ''Context Menu'' allowing you to set a lock on specific sources. XBMC will ask for the ''master lock code'' and then give you the opportunity to set a unique ''Password'' on that specific share. To ''Remove the Lock'' you need to remember the ''Master Lock'' code.<br />

{{note| Locking a source means you only give it protection in XBMC. Outside XBMC the source is still available and only protected, or not protected at all, by the Operating System. In the same way, if someone has access to manually edit the ''sources.xml'' he or she can remove or change the settings for the locked source. So, don't feel too safe when you protect a source in XBMC.}}
<section end="Locking" />

== See also ==
* [[Adding videos to the library]]
* [[Video library/Setting content and scanning|Setting content and scanning]]
* [[Sources.xml]]
* [[List of media source types]]
* [[File sharing]]
* [[Filemanager]]
{{Frodo updated}}

[[Category:Manual]]
[[Category:Settings]]
[[Category:File sharing]]
[[Category:Video library]]
[[Category:Music library]]

Settings/System

2015-01-05T12:46:21Z

ChristW: /* Master lock */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running {{kodi}} (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, {{kodi}} will still playback any content containing those audio types, however instead of the audio being passed through, {{kodi}} will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that {{kodi}} detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of {{kodi}} using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, {{kodi}} will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and {{kodi}} will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, {{kodi}} cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|{{kodi}} also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within {{kodi}}. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock {{kodi}} on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
{{kodi}} will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit {{kodi}} and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:45:20Z

ChristW: /* Debugging */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running {{kodi}} (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, {{kodi}} will still playback any content containing those audio types, however instead of the audio being passed through, {{kodi}} will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that {{kodi}} detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of {{kodi}} using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, {{kodi}} will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and {{kodi}} will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, {{kodi}} cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|{{kodi}} also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within {{kodi}}. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:42:40Z

ChristW: /* Power saving */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running {{kodi}} (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, {{kodi}} will still playback any content containing those audio types, however instead of the audio being passed through, {{kodi}} will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that {{kodi}} detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of {{kodi}} using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, {{kodi}} will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and {{kodi}} will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, {{kodi}} cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|{{kodi}} also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within XBMC. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:42:07Z

ChristW: /* Internet access */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running {{kodi}} (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, {{kodi}} will still playback any content containing those audio types, however instead of the audio being passed through, {{kodi}} will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that {{kodi}} detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of {{kodi}} using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, {{kodi}} will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and {{kodi}} will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, XBMC cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|XBMC also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within XBMC. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:41:33Z

ChristW: /* Input devices */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running {{kodi}} (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, {{kodi}} will still playback any content containing those audio types, however instead of the audio being passed through, {{kodi}} will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that {{kodi}} detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of {{kodi}} using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, {{kodi}} will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and XBMC will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, XBMC cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|XBMC also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within XBMC. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:40:49Z

ChristW: /* Audio output */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running {{kodi}} (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, {{kodi}} will still playback any content containing those audio types, however instead of the audio being passed through, {{kodi}} will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that XBMC detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of XBMC using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, XBMC will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and XBMC will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, XBMC cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|XBMC also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within XBMC. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:39:49Z

ChristW: /* Video output */

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display {{kodi}} in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where {{kodi}} can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where {{kodi}} is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before {{kodi}}'s settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in {{kodi}}, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running XBMC (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, XBMC will still playback any content containing those audio types, however instead of the audio being passed through, XBMC will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that XBMC detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of XBMC using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, XBMC will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and XBMC will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, XBMC cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|XBMC also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within XBMC. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Settings/System

2015-01-05T12:25:23Z

ChristW: Added note that 'Audio keep-alive' doesnt work on RPI.Arm systems

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display XBMC in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where XBMC can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where XBMC is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:vertical tearing|vertical tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before XBMC's settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in XBMC, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
|Select how audio is downmixed, for example from 5.1 to 2.0:<br />
'''[Enabled]''' maintains the dynamic range of the original audio source when downmixed however volume will be lower<br />
'''[Disabled]''' maintains volume level of the original audio source however the dynamic range is compressed. Note - Dynamic range is the difference between the quietest and loudest sounds in a audio source
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running XBMC (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, XBMC will still playback any content containing those audio types, however instead of the audio being passed through, XBMC will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that XBMC detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of XBMC using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Remote control sends keyboard presses
| When activated, your keyboard arrows will move the selection on the virtual keyboard. When deactivated, they will move the cursor from your text.
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, XBMC will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and XBMC will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, XBMC cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|XBMC also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of {{kodi}}.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within XBMC. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of {{kodi}}. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock XBMC on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
XBMC will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit XBMC and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Advancedsettings.xml

2014-12-18T11:25:26Z

ChristW: Rename from XBMC to Kodi

{{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 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%\XBMC\userdata\.</code>}}

== Layout ==

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

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

where "setting" gives the name of the setting, and "value" gives it's value.

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

= List of available settings =

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}
{{see also|debug log}}
<section begin="loglevel" />
{{xml setting
| tag name = loglevel
| tag attribute = hide
| tag attribute type = true_false
| tag attribute values =
{{option values
| value1= true | value1 description= Hides "enable debugging" guisetting.
| value2= false | value2 description= "enable debugging" guisetting will switch between min(loglevel, 0) and max(loglevel, 2) for off and on respectively. '''(Default)'''
}}
| tag attribute default values = true
| option type = list
| option values =
{{option values
| value1= -1 | value1 description= No logging, suppresses all log output
| value2= 0 | value2 description= Normal logging, only logging errors '''(Default)'''
| value3= 1 | value3 description= Debug logging ''(without showing text on screen)''
| value4= 2 | value4 description= Debug logging with freemem, fps and cpu usage shown on screen
| value5= 3 | value5 description= Debug logging with freemem, fps and cpu usage and full smb logging
}}
| default values = 0
| example values =
| platform = all
| {{kodi}} version = 8-12
| description =
The logging level that {{kodi}} will use to log errors and information. The "hide" attribute is optional.
| example =
Example:
<syntaxhighlight lang="xml" enclose="div">
<loglevel hide="false">1</loglevel>
</syntaxhighlight>

<br />

{{Note| If debugging is switched on in the GUI, loglevel will be set to 2 (''log to both file and on-screen information''); this will over-ride any <code>advancedsettings.xml</code> setting.}}<br />

{{Note| If debugging is switched on in the GUI when {{kodi}} is shut down, then it will be automatically be re-enabled at level 2 when it is re-started. This is true even if 'hide' is subsequently set to 'true' - in other words, if you enable it in the GUI and then hide the GUI toggle, it will stay on level 2 irrespective of what you subsequently set in <code>advancedsettings.xml</code>.}}<br />
}}
<section end="loglevel" />

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON RPC]] 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>

=== other - enableairtunesdebuglog ===
{{see|#enableairtunesdebuglog}}

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h264 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 (default on ATV)
* 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}}
{{see also|HOW-TO:Modify automatic watch and resume points|HOW-TO:Modify time seeking}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 
<smallstepbackseconds>7</smallstepbackseconds> 
<usetimeseeking>true</usetimeseeking> 
<timeseekforward>30</timeseekforward> 
<timeseekbackward>-30</timeseekbackward> 
<timeseekforwardbig>600</timeseekforwardbig> 
<timeseekbackwardbig>-600</timeseekbackwardbig> 
<percentseekforward>2</percentseekforward> 
<percentseekbackward>-2</percentseekbackward> 
<percentseekforwardbig>10</percentseekforwardbig> 
<percentseekbackwardbig>-10</percentseekbackwardbig> 
<blackbarcolour>1</blackbarcolour> 
<fullscreenonmoviestart>true</fullscreenonmoviestart> 
<defaultplayer>dvdplayer</defaultplayer> 
<excludefromscan> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
<playcountminimumpercent>90</playcountminimumpercent> 
<ignoresecondsatstart>180</ignoresecondsatstart> 
<ignorepercentatend>8</ignorepercentatend>


<forcevaapienabled>true</forcevaapienabled> 

<vdpauscaling>true</vdpauscaling>


<enablehighqualityhwscalers>true</enablehighqualityhwscalers> 
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing> 
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing> 
<autoscalemaxfps>30</autoscalemaxfps> 



<adjustrefreshrate>









<override>
<fps>23.976</fps> 
<refresh>60.0</refresh> 
</override>

<override>
<fpsmin>29.96</fpsmin> 
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin> 
<refreshmax>61.0</refreshmax>
</override>




<fallback>
<refresh>50.0</refresh> 
</fallback>


<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>




</adjustrefreshrate>

<checkdxvacompatibility>value</checkdxvacompatibility>


<useocclusionquery>-1</useocclusionquery> 
<fpsdetect>1</fpsdetect> 



<latency>


<delay>0</delay>




<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>


<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>

</latency>

<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
<stagefright>

<useavccodec>-1</useavccodec>
<usevc1codec>-1</usevc1codec>
<usevpxcodec>-1</usevpxcodec>
<usemp4codec>-1</usemp4codec>
<usempeg2codec>-1</usempeg2codec>
<useswrenderer>false</useswrenderer>
</stagefright>
<mediacodec>

<useavccodec>-1</useavccodec>
<usevc1codec>-1</usevc1codec>
<usevpxcodec>-1</usevpxcodec>
<usemp4codec>-1</usemp4codec>
<usempeg2codec>-1</usempeg2codec>
<useswrenderer>false</useswrenderer>
</mediacodec>
<disablehi10pmultithreading>false</disablehi10pmultithreading> 
</syntaxhighlight>
{{helix box|1=
<syntaxhighlight lang="xml" enclose="div">

<disableswmultithreading>false</disableswmultithreading> 
<dxvaallowhqscaling>false</dxvaallowhqscaling> 
<useffmpegvda>false</useffmpegvda> 
</syntaxhighlight>
}}
<syntaxhighlight lang="xml" enclose="div">
</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>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>true</applydrc>

<dvdplayerignoredtsinwav>false</dvdplayerignoredtsinwav>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

=== measurerefreshrate ===
{{anchor|.3Cmeasurerefreshrate.3E}}
When using "Sync playback to display" on Windows, the detected refreshrate might be wrong.
When enabling measurerefreshrate, the refreshrate is measured instead, which makes it more accurate.

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

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|EDL}}
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 ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<minvideocachelevel>5</minvideocachelevel> 
<minaudiocachelevel>10</minaudiocachelevel> 
<cacheindvdplayer>true</cacheindvdplayer> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<epg>
<lingertime>1440</lingertime> 
<updatecheckinterval>300</updatecheckinterval> 
<lingercleanupintervaltime>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>30</retryinterruptedupdateinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</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

== 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 .3gp .nsv .ts .ty .strm .rm .rmvb .m3u .ifo .mov .qt .divx .xvid .bivx .vob .nrg .img
.iso .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .dvr-ms .mpg .mpeg .mp4 .mkv .avc .vp3
.svq3 .nuv .viv .dv .fli .flv .rar .001 .wpl .zip
</pre>
Examples:
<syntaxhighlight lang="xml" enclose="div">
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</syntaxhighlight>
<section end="videoextensions" />

=== discstubextensions ===
{{anchor|.3Cdiscstubextensions.3E}}
A list of additional file-extensions that will (<tt><add></tt>) or will not (<tt><remove></tt>) be treated as disc stubs.

Default extensions for DISC STUBS:
<pre>
.disc
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<discstubextensions>
<add>.dvd|.blu</add>
<remove>.cd|.vhs</remove>
</discstubextensions>
</syntaxhighlight>

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

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

=== sorttokens ===
{{anchor|.3Csorttokens.3E}}
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
<syntaxhighlight lang="xml" enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
This is used by the [[File Stacking]] algorithm to combine multi-part files and contains a list of "''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''"

As of {{kodi}} v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. Old ones and three capture expressions are dropped (see [[Log file|log]]). More information on how the algorithm works is available [[File Stacking#How does it work.3F|here]].

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

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

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck]|d)[ _.-]*[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" />

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a ''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''

Default expression:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleandatetime>(.+[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-1][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 Expression (RegEx) Tutorial|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.

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

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<tvshowmatching>
<regexp>[Ss]([0-9]+)[][ ._-]*[Ee]([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)
:* Expressions are converted to lower case before being evaluated. ''(XBMC v13.0 alpha4 and earlier only)''
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[TV Shows (Video Library)|TV shows]] page.

:* 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 [http://forum.kodi.tv/showthread.php?t=51614 forum thread] has a discussion of pre-made regex lists to match common names. These drastically improve XMBC's ability to match TV show names, at the risk of some 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', 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>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[Regular Expression (RegEx) Tutorial|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 Expression (RegEx) Tutorial|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 Expression (RegEx) Tutorial|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 (RegEx) Tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[Regular Expression (RegEx) Tutorial|RegEx]]''" or "''[[Regular Expression (RegEx) Tutorial|RegExp]]''") 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

<syntaxhighlight lang="xml" enclose="div">
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<backgroundupdate>false</backgroundupdate> 

<cleanonupdate>false</cleanonupdate> 
<hideallitems>false</hideallitems> 
<hideemptyseries>false</hideemptyseries> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<mymovies> 
<categoriestogenres>false</categoriestogenres> 
</mymovies>
<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>

=== myth ===
{{anchor|.3Cmyth.3E}}
Not seeing all the recordings you expected in the Movies folder? If so, it's very likely that the electronic program guide (EPG) used by MythTV doesn't accurately distinguish between TV Shows and Movies all the time. The following setting allows the length of the recording to also be used to determine if a recording is a Movie.

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

<movielength>0</movielength>
</myth>
</syntaxhighlight>

== Library artwork ==

=== imageres ===
{{anchor|.3Cimageres.3E}}
This tag is new for v12 (Frodo), replacing <thumbsize>.

<section begin="imageres description" />Specify the maximal resolution that art 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}}
This tag is new for v12 (Frodo), replacing <fanartheight>.

<section begin="fanartres description" />Specify the resolution that 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>

=== fanart ===
{{anchor|.3Cfanart.3E}}
As of v12 (Frodo), this tag is only used for music and not video.

A list of additional files to try when searching for fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight>

=== useddsfanart ===
{{anchor|.3Cuseddsfanart.3E}}
This settings allows {{kodi}} to use your GPU rendering fanart and some other images. This will make loading images considerably faster, especially on systems with slower processors (e.g. atom based systems). Do not use this option on ARM based systems (Apple TV2/iOS/RPi/many Android systems) as it is likely to degrade performance because DDS images are not supported.

<syntaxhighlight lang="xml" enclose="div">
<useddsfanart>true</useddsfanart>
</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>

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for both music and video.

:{{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.'''}}
'''type'''

Can be either "sqlite3" or "mysql" (default: sqlite3)

'''host'''

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'''

sqlite3: silently ignored

mysql: defines the port of the mysql socket (default: 3306)

'''name'''
:''Not needed by default, and some users report issues when defining the this tag. When not used "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'''

sqlite3: silently ignored

mysql: defines the user with privileged access to the database

'''pass'''

sqlite3: silently ignored

mysql: defines the password for the user with privileged access to the database

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The videodatabase and musicdatabase 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 and musicdatabase tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
<name>kodi_music</name>
</musicdatabase>
</syntaxhighlight>

{{note| ''If you use MySQL for the music database, but are finding that it slows down your music library significantly, execute the following query to create an index on the song table. This will significantly speed up queries using the songview views looking up by artist:'' }}

<syntaxhighlight lang="sql" enclose="div">
CREATE INDEX ixSongArtist
ON song(idArtist, idAlbum)
</syntaxhighlight>
<section end="videodatabase" />

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

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Music windows.

Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .mpa .wav .wma .ogg .mp3 .mp2 .m3u .mod .amf .669 .dmf .dsm .far .gdm
.imf .it .m15 .med .okt .s3m .stm .sfx .ult .uni .xm .sid .ac3 .dts .cue .aif .aiff .wpl .ape .mac .mpc
.mp+ .mpp .shn .zip .rar .wv .nsf .spc .gym .adplug .adx .dsp .adp .ymf .ast .afc .hps .xsp
</pre>

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

=== 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 ===
{{anchor|.3Cmusiclibrary.3E}}
Options specific to the Music Library

<syntaxhighlight lang="xml" enclose="div">
<musiclibrary>
<hideallitems>true</hideallitems> 
<allitemsonbottom>true</allitemsonbottom> 
<backgroundupdate>true</backgroundupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumssortbyartistthenyear>true</albumssortbyartistthenyear> 
<albumformat>%B - %Y</albumformat> 
<albumformatright>%A</albumformatright> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
</musiclibrary>
</syntaxhighlight>

=== karaoke ===
{{anchor|.3Ckaraoke.3E}}
{{Main|Karaoke}}<section begin="karaoke" />
<syntaxhighlight lang="xml" enclose="div">
<karaoke>

<syncdelaycdg>0.0</syncdelaycdg>

<syncdelaylrc>0.0</syncdelaylrc>

<alwaysreplacegenre>false</alwaysreplacegenre>

<storedelay>true</storedelay>

<autoassignstartfrom>1</autoassignstartfrom>

<nocdgbackground>true</nocdgbackground>

<defaultbackground type="video" path="special://masterprofile/karaokevideobg.avi"/>

<nextsongpopuptime>0.0</nextsongpopuptime>
</karaoke>
</syntaxhighlight>
<section end="karaoke" />

== 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 .cbr .rar .m3u
</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 Expression (RegEx) Tutorial|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 ==

=== 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}}
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>5</curllowspeedtime> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<cachemembuffersize>20971520</cachemembuffersize> 
<buffermode>0</buffermode> 
<readbufferfactor>1.0</readbufferfactor> 
</network>
</syntaxhighlight>

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

<audiochannelselection>false</audiochannelselection>

<submenuselection>false</submenuselection>

<defaultrootmenu>0</defaultrootmenu>

<defaultsubmenu>4</defaultsubmenu>

<pictureicon>true</pictureicon>

<epgrequesttime>10</epgrequesttime>

<zapwaittime>0</zapwaittime>
</tuxbox>
</syntaxhighlight>

=== enableairtunesdebuglog ===
{{helix box|This option will be replaced by a GUI option in v14:
{{anchor|.3Cenableairtunesdebuglog.3E}}<section begin="enableairtunesdebuglog" />
This enables the debug output of libshairport which is used for the AirTunes feature. Defaults to off - because its spamming badly.

Example:
<syntaxhighlight lang="xml" enclose="div">
<enableairtunesdebuglog>1</enableairtunesdebuglog>)
</syntaxhighlight>
<section end="enableairtunesdebuglog" />
}}

=== 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-on]] rollback feature. Increasing the size should increase the amount of past versions saved.
| 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

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
'''[[Path substitution]]s''' 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>

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

=== remoterepeat ===
{{anchor|.3Cremoterepeat.3E}}
This used to adjust the amount of time in milliseconds between repeated keystrokes. Used to prevent key-bounce, in other words prevents {{kodi}} (lirc?) seeing one key press as multiple key presses with certain remotes.

<syntaxhighlight lang="xml" enclose="div">
<remoterepeat>800</remoterepeat>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
The controller deadzone is the region of movement around the center which is not recognized by the device. Because joysticks can have noise (report motion when still) and bias (report an offset when centered), spurious events can be reported even though the controller isn't being touched. If you notice these kinds of events, you most likely need to increase your controller's deadzone (both axes recommended). The values range from 0.0 (no deadzone, {{kodi}} will see all input your controller is capable of registering) to 1.0 (it will ignore all input inside of the device's physical limits).

<syntaxhighlight lang="xml" enclose="div">
<controllerdeadzone>0.2</controllerdeadzone>
</syntaxhighlight>

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

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
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>

=== allowd3d9ex ===
{{anchor|.3Callowd3d9ex.3E}}
Applies only to Windows Vista and up. Values: true/false. Allows {{kodi}} to use Direct3D 9Ex, which is a bit more stable and robust than Direct3D 9.

Default:
<syntaxhighlight lang="xml" enclose="div">
<allowd3d9ex>true</allowd3d9ex>
</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>

=== forced3d9ex ===
{{anchor|.3Cforced3d9ex.3E}}
Windows only: {{kodi}} attempts to detect drivers released for a version earlier than Vista, to avoid using advanced features which are often not emulated correctly. The detection may be incorrect and this setting allows forcing the using of D3D9Ex.

<syntaxhighlight lang="xml" enclose="div">
<forced3d9ex>false</forced3d9ex>
</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, combined with nofliptimeout=0, 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, combined with nofliptimeout 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>

=== nofliptimeout ===
{{anchor|.3Cnofliptimeout.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="nofliptimeout" />Specifies the timeout in milliseconds after which {{kodi}} will not flip the graphics buffers anymore when nothing has been rendered, this lowers both CPU and GPU usage. Sometimes adjusting this value can help prevent flickering.

* -1: disabled
* 0 or higher: timeout in milliseconds '''(0 is default)'''
<section end="nofliptimeout" />
Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<nofliptimeout>1000</nofliptimeout>
</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>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setup's 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>

Alternate code.
<syntaxhighlight lang="xml" enclose="div">
<videoscreen>
<fakefullscreen>false</fakefullscreen>
</videoscreen>
</syntaxhighlight>

== 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|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed 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

== guisettings.xml settings ==
{{Note|In XBMC v13 "Gotham", using guisettings in advancedsettings.xml might not work anymore or might give unexpected results.}}

You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Any guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang="xml" enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in {{kodi}}'s interface for the character set will then no longer be visible, and {{kodi}} will always use the Hebrew (Windows) character set.

{{Gotham updated}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]