Official Kodi Wiki - User contributions [en]

Archive:Android FAQ

2013-11-29T17:48:23Z

Announ: /* Troubleshooting */ How to hide the Android navigation bar

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Android]]}} }}
{{FAQ header|for Android.}}
{{XBMC FAQ}}
__TOC__
{{-}}

== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>
{| width="100%"

{{FAQ|1= Really?
| BGcolor=
| Question= Will this really do 1080 and all that stuff the desktop can do?
| Answer=
* Yes! This is a full port of XBMC! It is not a thin client or lite version!
:: {{note|Hardware video decoding support is very limited right now, so most devices will have to use software decoding. Expect support for hardware decoding to improve with time.''}}
* The initial aim for the Android port is to get XBMC working on inexpensive Android set-top-boxes. Phones and tablets will be supported as well for those who want XBMC on-the-go.
}}

{{FAQ|1=Installing
| BGcolor= WhiteSmoke
| Question= Installing/getting XBMC for Android
| Answer=
{{Main|HOW-TO:Install XBMC for Android}}
* {{big|'''[[Nightly builds]] for Android should now have hardware video decoding for most Android devices.'''}}
* If you've bought a device that was advertised to run XBMC, such as the Pivos XIOS, G-box, MiniX Neo, etc, then you should check with their respective websites for a final v12 Frodo build. Many of these devices need specific builds for hardware decoding and won't work correctly with the generic build released on xbmc.org
* A basic v12 build of XBMC for Android (APK) can be found here: http://mirrors.xbmc.org/releases/android/ . XBMC for Android will eventually come to the Google Play application store once there is support for more Android devices.
* [[Nightly builds]] can be found here: http://mirrors.xbmc.org/nightlies/android/
}}

{{FAQ|1=Version
| BGcolor=
| Question= Is XBMC for Android different from normal XBMC?
| Answer=
* The current version of XBMC for Android is based on XBMC v12.2 [[Frodo FAQ|Frodo]], and is based on the same code as XBMC for all the other supported platforms.
}}

{{FAQ|1=Current_build
| BGcolor= WhiteSmoke
| Question= How do I find out what version of XBMC am I running?
| Answer=
* XBMC main menu > System > Lower submenu > System info. '''Note the version and/or build date.'''
}}

{{FAQ|1=Formats
| BGcolor=
| Question= Video and audio formats XBMC for Android can playback
| Answer=
* XBMC for Android supports all the same formats that other platforms do (such as desktop OS).
* Due to the weak processing power of most ARM processors, for smooth playback most Android hardware will require proper hardware decoding. (See [[#Requirements]] below)
}}

{{FAQ|1=Media
| BGcolor= WhiteSmoke
| Question= Accessing media
| Answer=
{{See also|Adding videos to the library|File sharing}}
* You can connect to media that's being shared from a computer, HTPC, or NAS device on your local network.
* You can access media on the internal memory, SD cards or from USB ports (hard drives, USB stick drives, directly or via hubs, etc).
}}

{{FAQ|1=Add-ons|2=Skins
| BGcolor=
| Question= Add-ons and skins
| Answer=
* XBMC for Android is a full version of XBMC and will be able to use all non-platform specific [[add-ons]] and [[skins]]. More feature rich (CPU demanding) skins like AEON Nox might not run smoothly on lower powered systems, so keep to "lighter" skins for those boxes.
* If you are using a touch screen device and the build you are using did not include it, you can manually instal [[Add-on:Touched]] for better touch screen support.
}}

{{FAQ|1=Remotes
| BGcolor= WhiteSmoke
| Question= Remote controls
| Answer=
* Some Android set-top-boxes come with a remote and an IR port which XBMC can use.
* Any '''[[Keyboard]]''' such as wired, wireless, bluetooth (if supported in your Android ROM). This includes "keymotes" such as a Rii, [[Boxee remote]], most "air mouse" keyboard remotes, and others that appear as a normal USB keyboard to the system.
* '''[[Web interface]]s''', including add-on interfaces.
* XBMC '''[[:Category:Smartphone and tablet remotes|smartphone and tablet remote apps]]'''.
* Other IR remotes can be used with IR receivers such as the '''[[Flirc]]'''.
* Some Android devices support '''[[CEC]]'''
}}

{{FAQ|1=Requirements
| BGcolor=
| Question= Requirements
| Answer=
:{{see also|Android hardware}}
{{#lst:Supported hardware|Android}}
}}

{{FAQ|1=Google_TV
| BGcolor= WhiteSmoke
| Question= Google TV
| Answer=
* You can install XBMC on Google TV devices that have the Android 4.2 update.
}}

{{FAQ|1=Apps
| BGcolor=
| Question= Launching Android apps from within XBMC
| Answer=
* XBMC can launch other Android apps by going to "Programs" (on the home screen) and selecting the app you want to run.
}}

{{FAQ|1=Startup
| BGcolor= WhiteSmoke
| Question= Automatically start XBMC
| Answer=
* You can automatically start XBMC when your Android device boots up using an application such as [https://play.google.com/store/apps/details?id=imoblife.startupmanager Startup Manager (free)]
}}

{{FAQ|1=Hardware_decode
| BGcolor=
| Question= Why can other players work with HD video but not XBMC?
| Answer=
* HD video (720 and 1080 resolution files) requires what's known as hardware video decoding, using special chips that handle video playback, in order to run smoothly on most ARM/Android systems. Some Android systems have powerful enough CPUs that they can playback some HD video without hardware decoding, but most will require it.
* Unlike most OSes, hardware decoding on Android isn't standard across different manufacturers and chip makers.
* Hardware video decoding is still under very active development in XBMC for Android, and it is expected that XBMC will be able to support a large selection of devices.
* Other players have hardware video decoding because they've signed NDAs or are using closed source code, which are not options for XBMC.
}}

|}

== Troubleshooting ==
{{see also|Troubleshooting}}
{| width="100%"

{{FAQ|1=Forum|2=IRC
| BGcolor=
| Question= Getting more help with XBMC for Android
| Answer=
* '''[http://forum.xbmc.org/forumdisplay.php?fid=164 XBMC for Android specific help forum]'''
* '''[irc://irc.freenode.org/xbmc-osx #xbmc]''' [[w:IRC|IRC]] chat channel on irc.freenode.org.
}}

{{FAQ|1=Userdata|2=logs|3=Logs
| BGcolor= whitesmoke
| Question= Userdata folder and logs
| Answer=
The userdata folder and debug log is located on external storage/sdcard at one of the following locations (depending on your device):
;[[userdata folder]]
* /Android/data/org.xbmc.xbmc/files/.xbmc/userdata/
* /sdcard/Android/data/org.xbmc.xbmc/files/.xbmc/
* /data/data/org.xbmc.xbmc/files/.xbmc/

;[[debug log]]
* /Android/data/org.xbmc.xbmc/cache/temp/xbmc.log
* /sdcard/Android/data/org.xbmc.xbmc/cache/temp/xbmc.log
* /data/data/org.xbmc.xbmc/cache/temp/xbmc.log

;Crash log
* If you don't have a computer, download the SendLog app from Android market. It allows you to send your system log to an email address. Email it to yourself and show us where the error happened.
* With a computer, it's easier and faster. Plug your device, download and unzip the [http://d.android.com/sdk/index.html Android SDK] and run ddms.bat in the tools folder. There you have it under ''LogCat''.
* The logfile is kept on a phone for a while, so you don't need to reproduce a crash in order to get the log.
* Be sure to have hidden folders set to be shown in your file explorer.
}}

{{FAQ|1=navbar
| BGcolor=
| Question= How to hide the Android navigation bar
| Answer=
* Since Android 4.0 (Ice Cream Sandwich) the way the navigation bar works has been changed. On some Android devices that do not have physical buttons the navbar cannot be normally hidden, but only “dimmed”. Some Android set‐top boxes have this “no buttons” flag set and will not hide the navigation bar when using XBMC.
* '''To remove the navbar:'''
** You can use "[http://ppareit.github.com/HideBar/ HideBar]" (Has a free version, and is open source if you wish to compile yourself)
** The app "[https://play.google.com/store/apps/details?id=de.tsorn.FullScreen Full!Screen]" is free and should also work.
** A custom Android distribution can be installed to correctly handle the navbar. [http://replicant.us/ Replicant], [http://www.cyanogenmod.org/ CyanogenMod] and some others offer an “extended desktop” mode which hides the navigation bar and, optionally, the status bar too.
** There's some other tricks you can do if you have rooted the device {{editor note|I keep hearing this, but haven't found any of these tricks yet. If someone finds one, please note it here.}}
}}

{{FAQ|1=Battery
| BGcolor= whitesmoke
| Question= XBMC uses the battery too fast on portable devices
| Answer=
* This is a known issue. The main effort right now for XBMC for Android is set-top-boxes, but expect power usage issues to improve in time.
}}

{{FAQ|1=Volume
| BGcolor=
| Question= Issues with audio volume
| Answer=
* XBMC has its own volume level in addition to the Android system volume level, so be sure to check that both are up if you are having issues hearing audio.
}}

{{FAQ|1=Buffering|2=Performance
| BGcolor= WhiteSmoke
| Question= Performance: video buffering, stuttering, choppiness
| Answer=
* {{note|Remember that hardware video decoding, which will be required on most devices for smooth video playback, is still very limited at this time. (see [[#Requirements]])}}
* Avoid using wireless. A lot of Android devices have weak wifi, even those that advertise as being wireless-n. It may be possible to use a USB-to-ethernet dongle on some devices, or even a USB wifi adapter that has a better wifi radio than what is built-in.
* Switch to a different network protocol to see if that has any effect, i.e. [[FTP]], [[WebDAV]], [[SMB]], etc. Note that NFS currently isn't an option on the R-Pi yet.
* Try sharing the media on another device to rule out a device-specific (or network) issue.
* Turn off thumbnails, XBMC > Settings > Video > File and deselect 'generate thumbnails'.
* h.264 Hi10P will not work as there are no ARM processors powerful enough to software decode it, and no hardware decoders exist for it.
* If your TV/receiver supports it, enable various [[Settings/System#Audio output|audio passthrough options]] to reduce the load on the CPU.
* If RSS feed is enabled, disable it in settings. This makes the main menu a bit faster. In fact, having rss enabled is probably the single-biggest battery-killing cpu-draining thing you can do.
}}

|}

[[Category:XBMC Manual]]
[[Category:FAQ|Android]]
[[Category:Android|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Naming video files/TV shows

2013-10-02T01:28:34Z

Announ: /* Using custom file names */ Added warning about expression case folding

{{:Adding videos to the library/Contents}}
{{mininav|[[General topics]]|[[Video library|Videos]]|[[Video library/Management|Management]]|[[Video library/Naming files|Naming files]]}}
{{#lst:Adding videos to the library/Naming files|naming files}}
XBMC requires each TV show to be in its own folder, and for each file to contain a pattern from which XBMC can determine the season and episode number (e.g. "S01E01").

:'''Folder name''' = Show title
:'''File name''' = Season/Episode number

The folder name will be [[Userdata/advancedsettings.xml#.3Ccleanstrings.3E|cleaned]] of commonly used strings, such as DVDRip, 1080p, x264, etc. before being passed to the scraper. If the year of release is included, this will be [[advancedsettings.xml#.3Ccleandatetime.3E|extracted]] and used by the scraper to assist in making a match.

Spaces, periods, or underscores may be used to separate words in the folder and file names, but shouldn't be mixed in the same folder name. Note also the caution [[#Split-episode|below]] regarding file names with periods.

{{Note|Flat structures with files for different shows in a single directory are '''''not supported'''''.}}
== Directories ==
You must set the content to TV Shows on the directory directly above the individual show folders.
To ensure accurate matches for your TV shows, the folder names should match the title displayed on the site being scraped.
For the default TVDB scraper this may mean including the year of release, e.g. [http://www.thetvdb.com/?tab=series&id=83462 Castle (2009)] (in cases of duplicate titles), or the country of origin, e.g. [http://www.thetvdb.com/?tab=series&id=196921 Being Human (US)] (in cases of foreign remakes).

Below the show folder, the files may be organized how you wish, e.g. into separate season folders, or by year. These folders will be ignored.
=== Simple ===
Typically, you will add the top-level directory as a source and set the content to TV shows when you add it.
;Example
:{|
|
<pre>
TV Shows <<Source folder, Content: TV shows>>
|----TV Show 1
| |----Season #
| |--Files
|----TV Show 2 (year)
| |--Files
|----TV Show 3
| |----2008
| |--Files
</pre>
|}
=== Complex ===
In more complex situations where your top-level directory is further sub-divided before the show folders, you can add the top-level as source but not set the content, and then set the content to TV shows on each sub-folder.
;Example
:{|
|
<pre>
TV Shows <<Source folder, Content: None>>
|----A-M <<Content: TV shows>>
| |----TV Show 1
| |--Files
|----N-Z <<Content: TV shows>>
| |----TV Show 2
| |--Files
</pre>
|}
It's also possible to have a sub-folder group multiple shows together in an otherwise normal directory structure. Just change the content on the sub-folder and de-select the "Selected folder contains a single TV show" setting.
;Example
:{|
|
<pre>
TV Shows <<Source folder, Content: TV shows>>
|----TV Show 1
| |----Season #
| |--Files
|----Star Trek Series <<Content:TV shows>>
| |----Star Trek
| | |--Files
| |----Star Trek The Next Generation
| |--Files
</pre>
|}
In these cases, it's best to refrain from scanning the files into the library until the content is set correctly for all folders, to avoid incorrect results and the need to rescan.
== Files ==
XBMC uses a series of regular expressions to determine the season and episode numbers from the file name.
These are checked in order with the first match being the one used. Anything else included in the file name is ignored.

There are '''7''' default patterns, plus a separate multi-episode pattern. Use of any other numbering scheme will require you to edit your [[advancedsettings.xml]] (see [[#Using custom file names|below]]).

{{note|In the examples we will mostly use the format:
:''name''.'''<<pattern>>'''.ext,
where ''name'' is the title of the show, and .ext is a [[advancedsettings.xml#.3Cvideoextensions.3E|recognized video file extension]], but '''''any format''''' will work, so long as the pattern is included somewhere in it. The ''name'' is optional and could just as easily be after the pattern, or excluded entirely. }}
=== Single episode ===
Most of the time you will only have a single episode per file.

The order in which the patterns are checked for by XBMC is included in brackets after each example below (most patterns allow some variation, hence the duplicate numbers). If your file name contains more than one pattern, only the first one checked for will be used.

All the examples will be read as season 1, episode 2.
;With season
:The most common scenario.
:''name''.'''s01e02'''.ext (1)
:''name''.'''s1e2'''.ext (1)
:''name''.'''s01.e02'''.ext (1)
:''name''.'''s01_e02'''.ext (1)
:''name''.'''1x02'''.ext (5)
:''name''.'''102'''.ext (6)
;Without season
:In cases where you only have one season (or are using absolute order in the TVDB scraper), you may want to forego the inclusion of the season number.
:''name''.'''ep02'''.ext (2)
:''name''.'''ep_02'''.ext (2)
:You may also use Roman numerals (I, IV, XI, etc.), often used for mini-series or short documentary series.
:''name''.'''part.II'''.ext (7)
:''name''.'''pt.II'''.ext (7)
:''name''.'''pt_II'''.ext (7)
;By date
:Common for long-running daily shows, you can also use the date the episode aired.
:''name''.'''1996.11.14'''.ext (3)
:''name''.'''1996-11-14'''.ext (3)
:''name''.'''14.11.1996'''.ext (4)

=== Multi-episode ===
In cases where your file contains more than one episode, you can specify all the episodes included. Everything after the first found pattern match will be checked for further matches to the same pattern.
;Examples
:''name''.'''s01e01'''.'''s01e02'''.ext
:''name''.'''s01e01'''.''episode1.title''.'''s01e02'''.''episode2.title''.ext
:''name''.'''s01e01'''.'''s01e02'''.'''s01e03'''.ext
:''name''.'''1x01'''_'''1x02'''.ext
:''name''.'''s01e01''' 1x02.ext (mixed patterns do not work)
:''name''.'''ep01'''.'''ep02'''.ext
The remainder will also be checked against a shorter form [[Userdata/advancedsettings.xml#.3Ctvmultipartmatching.3E|multi-episode pattern]].
;Examples
:''name''.'''s01e01e02'''.ext
:''name''.'''s01e01-02-03'''.ext
:''name''.'''1x01x02'''.ext
:''name''.'''ep01_02'''.ext
The '''ex-_''' are fully interchangeable and stackable, e.g. ''name''.'''1x01e02_03-x-04'''.ext is perfectly valid (if somewhat odd).

{{Note|Only the episodes in the file name will be added, e.g. ''name''.'''s01e01-03'''.ext will not include episode 2.}}
=== Split-episode ===
Typical for childrens cartoons, files which only contain a distinct part of an episode may be named as to which part, if the scraper supports it (currently only TVDB using DVD order).
;Examples
:''name''.'''s01e01.1'''.ext
:''name''.'''s01e01a'''.ext
:''name''.'''1x01.1'''.ext
:''name''.'''1x01a'''.ext
:''name''.'''ep01.1'''.ext
:''name''.'''101.1'''.ext
Up to 9 sub-parts are allowed (using either .1-.9 or a-i).

These can also be combined with the multi-episode pattern, if your file contains all parts joined as a single episode.
;Examples
:''name''.'''s01e01.1.s01e01.2'''.ext
:''name''.'''1x01.1x01.2'''.ext (note this is (1x01.1)x(01.2) not (1x01).(1x01.2))
:''name''.'''ep01a_01b'''.ext

Each part will be added to the library just with its full episode number, the sub-part will not be displayed.

{{Note|If you use periods in your file names and include material after the episode number (such as the episode title), you may get a false match to a split-episode pattern if that material begins with a number below 10, e.g.
:''Nikita''.'''S01E02.2'''.0.mkv
:''24''.'''1x02.1'''.00.am-2.00.am.avi
:''name''.'''1x01.1'''x'''02'''.ext (i.e. (1x01.1) x (02) )
This will likely lead to the episode not being added to the library. The recommendation is to use a space or underscore instead to separate the numbers for those files, e.g.
:''Nikita''.'''S01E02'''_2.0.mkv
:''24''.'''1x02'''_1.00.am-2.00.am.avi
:''name''.'''1x01''' '''1x02'''.ext (i.e. (1x01) (1x02) )
}}
=== Special episodes ===
Special episodes, if supported by your scraper, should be marked as being season 0. You should check the site being scraped to see what episode number to use, as they can be fairly arbitrary. For example, [http://thetvdb.com/?tab=season&seriesid=76736&seasonid=24194&lid=7 BlackAdder's Christmas Carol] should have a file name that matches season 0 episode 3, e.g.:
:''BlackAdder''.'''s00e03'''.BlackAdder's Christmas Carol.mkv

== The TVDB scraper ==
The default TV show scraper uses [http://thetvdb.com The TVDB] to scan your TV shows into the library. You should search on the site before adding a new show to ensure you're using the right title. Caution should be taken over using aliases or alternative titles, although these will work in a website search, they don't work in the API the scraper uses.

The TVDB scraper has three possible settings for determining episode order: Aired order, DVD order, and Absolute order. These will affect how you name your files, or vice versa, how you name your files will affect which setting you should use.
;Aired order
:The default, episodes are ordered by season and numbered as they were originally broadcast. For split-episodes, each part is given its own distinct episode number.
:Visible when you click on any season link on the show page.
;DVD order
:Episodes are ordered by season and numbered as they appeared on DVD release. Split-episodes are numbered by episode and sub-part.
:Visible when you click the "DVD Order" link on any season page for the show.
;Absolute order
:Episodes are ordered as a single season and numbered sequentially from start to finish. Split episodes have distinct episode numbers. Commonly used for anime.
:Visible when you click the "Absolute Order" link on the All seasons page for the show.
For a list of all available settings and their meaning, see [[Add-on:The TVDB]].
== Advanced usage ==
=== Supplemental tools ===
A variety of [[supplemental tools]] exist to automatically rename files and folders into XBMC compatible formats.
* [[Supplemental tools/Linux#Rename tools|Renaming tools for Linux]]
* [[Supplemental tools/Mac OS X#Rename tools|Renaming tools for Mac OS X]]
* [[Supplemental tools/Windows#Rename tools|Renaming tools for Windows]]
{{-}}

=== Changing scraper settings for one show ===
A very common situation, when you have one or more shows that require different scraper settings (particularly episode order) to the other shows in your folder, it is possible to change the settings for individual shows. Just navigate to the show's folder in file view and select Change content from the context menu and then alter the settings from there. If the files have already been incorrectly added to the library, you will need to refresh the folder (e.g. from the info screen).

The classic example is Firefly, whose aired order differs greatly from its DVD order:
<pre>
TV Shows <<Source folder, Content: TV shows, Scraper: TVDB - default settings>>
|----TV Show 1
| |----Season 1
| |--Files
|----TV Show 2
| |--Files
|----Firefly <<Scraper: TVDB - DVD order>>
| |----1x01.Serenity.ext
| |----1x02.The Train Job.ext
</pre>
=== Using custom file names ===
It's possible to use custom file names that don't match any of the default patterns by editing your [[advancedsettings.xml]] file to include a [[advancedsettings.xml#.3Ctvshowmatching.3E|tvshowmatching]] tag containing regular expressions.

A tvshowmatching regexp needs up to three capturing groups:
:1 capturing group = episode number (season will default to season 1), no multi-episode matches will be attempted
:2 capturing groups = season number + episode number (in that order), no multi-episode matches will be attempted
:3 capturing groups = season number + episode number + multi-episode matching part (typically just the remainder of the file name)
(A capturing group is essentially a part of the regexp contained inside brackets.)

To have no season but multi-episode matching, use three groups but leave the first empty.

Date-based regexps are also possible, and are marked by a bydate="true" attribute in the regexp. These also use three capturing groups, either as year-month-day or day-month-year, the lengths must be exactly 4-2-2 or 2-2-4.

Your custom tvshowmatching regexps can be either checked for before the default set (action="prepend") or after (action="append"). Not including an action will result in only your regexps being tested. Care should be taken to ensure that the right regexp matches your file names, particularly in regard to the three digit "102" pattern seen [[#single episode|above]].
The regexps should be grouped together inside a single tvshowmatching tag, although you can use two if you wish to prepend ''and'' append different regexps.
{{note|The expressions are converted to lower case before being evaluated on ''XBMC v13.0 alpha4'' and earlier versions, so Perl character classes like '\W' and '\D' can’t be used. Use bracketed character classes like '[^A-Za-z0-9_]' and '[^0-9]' instead.}}

You can also change the multi-episode matching regexp by including a [[Userdata/advancedsettings.xml#.3Ctvmultipartmatching.3E|tvmultipartmatching]] tag in your advancedsettings.xml (separate from the tvshowmatching tag).
There can be only one tvmultipartmatching expression, whatever you use will overwrite the default, so take care to only expand on the default pattern unless you are certain.
The tvmultipartmatching requires one capturing group for the episode number.

{{note|For simplicity, the split-episode pattern has been excluded from the examples below.}}
To allow for split-episodes, replace the <code>[0-9]+</code> in the episode capturing group with <code>[0-9]+(?:(?:[a-i]|\.[1-9])(?![0-9]))?</code>
==== Examples ====
A fairly straightforward example to begin.
;Season ## - Episode ##
:"Season [season#] - Episode [episode#]" anywhere in the file name
:{|
|
<source lang="xml">
<tvshowmatching action="prepend">
<regexp>Season ([0-9]+) - Episode ([0-9]+)([^\\/]*)$</regexp>
</tvshowmatching>
</source>
|}
:'''Example''' : TV Shows\Scrubs\Season 1\Scrubs - '''Season 1 - Episode 01''' - Pilot.avi
:The first two capturing groups should be obvious, the third group <code>([^\\/]*)</code> captures everything up to the end of the file name <code>$</code>, this allows for multi-part file names such as ''name''.'''Season 1 - Episode 01''' - '''Season 1 - Episode 02'''.ext as well as the simpler ''name''.'''Season 1 - Episode 01-02'''.ext

The entire file path is passed to the regexps, so care should be taken to ensure the matches can't occur earlier in the path, but this does mean for example, you can capture the season number from a sub-folder name.
;\Season #\##
:Season [season#] at the end of the directory name, file name starts with [episode#]
:{|
|
<source lang="xml">
<tvshowmatching action="prepend">
<regexp>Season[\._ ]([0-9]+)[\\/]([0-9]+)([^\\/]*)$</regexp>
</tvshowmatching>
</source>
|}
:'''Example''' : \Battlestar Galactica (2003)\'''Season 3\01''' - Occupation.avi (Season 3, Episode 1)
:Again we use three groups here to allow for multi-episode, but in this case (obviously) only the shorter multi-episode pattern can occur, e.g. '''Season 1\01x02''' - Episode title.ext.

For numbering without a season, you should ensure that only the episode number gets matched against and not another number in the title or episode title, or a number as part of a different pattern.
; - ## -
:" - [episode#] - " anywhere in the file name
:{|
|
<source lang="xml">
<tvshowmatching action="prepend">
<regexp> - ()([0-9]+)((?:-[0-9]+)*) - [^\\/]*$</regexp>
</tvshowmatching>
</source>
|}
:'''Example''' : \One Piece\One Piece''' - 099 - '''Spirit of the Fakes! Heart of the Rebel Army, Kamyu!.avi ("Season 1", Episode 99) (Using Absolute order)
:Here, the first capturing group is left empty, and there is a distinct pattern before and after the episode number to ensure only it gets matched. Also instead of capturing the remainder of the file name for multi-part matching, we only capturing a single repeating pattern so only a '''- 01-02-03 -''' format will work.

It's also possible to specify a different default season for without-season regexps.
;\Specials\##
:Directory name is Specials, file name starts with [episode#]
:{|
|
<source lang="xml">
<tvshowmatching action="prepend">
<regexp defaultseason="0">Specials[\\/]()([0-9]+)([^\\/]*)$</regexp>
</tvshowmatching>
</source>
|}
:'''Example''' : \Firefly\'''Specials\04''' - Browncoats Unite.mkv (Season 0, Episode 4)
:A combination of the previous two examples, allowing special episodes to reside in a "Specials" folder rather than a "Season 0" folder.

The default date-based regexps only allow for periods or hyphens as delimiters...
;<nowiki>####_##_##</nowiki>
:[year]_[month]_[day] anywhere in the file name
:{|
|
<source lang="xml">
<tvshowmatching action="prepend">
<regexp bydate="true">([0-9]{4})_([0-9]{2})_([0-9]{2})[^\\/]*$</regexp>
</tvshowmatching>
</source>
|}
:'''Example:''' : \The Colbert Report\'''2005_10_17'''.avi
:The exact number of digits is specified for each group to ensure compliance. A separate [day]_[month]_[year] regexp would be needed if both formats are in use.

The default regexps don't allow for DVD folder structures, this can usually be remedied by replacing the final <code>$</code> with <code>(?:(?:[\\/]video_ts)?[\\/]video_ts\.ifo)$</code>
;S##E##\VIDEO_TS\VIDEO_TS.IFO
:{|
|
<source lang="xml">
<tvshowmatching action="append">
<regexp>[Ss]([0-9]+)[ ._-]*[Ee]([0-9]+)([^\\/]*)(?:(?:[\\/]video_ts)?[\\/]video_ts\.ifo)$</regexp>
</tvshowmatching>
</source>
|}
:'''Example:''' \Battlestar Galactica (2003)\The Mini-Series '''S00E01E02'''\VIDEO_TS\VIDEO_TS.IFO
:The VIDEO_TS folder is optional, e.g. '''S01E01'''\VIDEO_TS.IFO will also work.

Similarly for Bluray folder structures, you can replace the final <code>$</code> with <code>(?:(?:[\\/]bdmv)?[\\/]index\.bdmv)$</code>
;<nowiki>#</nowiki>x##\BDMV\index.bdmv
:{|
|
<source lang="xml">
<tvshowmatching action="append">
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)(?:(?:[\\/]bdmv)?[\\/]index\.bdmv)$</regexp>
</tvshowmatching>
</source>
|}
:With Bluray folders, you'll also run into trouble with the various mpls and m2ts files incorrectly matching other patterns, so you should also exclude all the other folders and files from being scanned:
:{|
|
<source lang="xml">
<video>
<excludetvshowsfromscan action="append">
<regexp>[\\/](auxdata|backup|clipinf|playlist|stream|certificate)[\\/]</regexp>
<regexp>movieobject\.bdmv</regexp>
</excludetvshowsfromscan>
</video>
</source>
|}

Finally, a tvmultipartmatching example.
;S##E##+##
:Multiple episode numbers, separated by a + sign
:{|
|
<source lang="xml">
<tvmultipartmatching>^[-_EeXx+]+([0-9]+)</tvmultipartmatching>
</source>
|}
:'''Example:''' : \Lost\Lost.'''S01E23+24'''.Exodus.mkv
:In this case we can simply add the + sign to the default symbols, thus preserving the defaults as well.

== Troubleshooting ==
=== The scraper picks the wrong TV show ===
The most common cause for this is that you haven't named the show's folder correctly. Check the site being scraped, and copy the title exactly as it is displayed, including anything in brackets.

If that doesn't solve the issue, or you are unable to change the folder name, you can force a match by adding a [[Import - Export Library#TV Shows 2|tvshow.nfo]] with the url of the show's page on the scraped site.
=== All files are added as a single TV show ===
This may happen if you've set content on the wrong folder, (usually the one above the one containing your TV shows). The telltale sign will be the title of the show everything is added as: "Al '''TV'''", "Genius '''Series'''", etc. The title will be derived from the name of your top-level TV folder.
<pre>
Videos <<Source folder, Content: TV Shows>>
|----TV <<Scanned as "Al TV">>
| |----TV Show 1 <<Ignored>>
| | |--Files
| |----TV Show 2 <<Ignored>>
| | |--Files
</pre>
In these cases, you can either remove the source and re-add the TV shows folder as source, or change the content on the source to None, and then set the content on the correct folder (see examples [[#Complex|above]]).
=== Some files refuse to be added ===
The most obvious cause is that the files are not named correctly and don't match any of the patterns. In these cases you will need to rename the files, or add a custom tvshowmatching regexp to deal with them.

If the files appear to be correctly named, they may instead be matching the ''wrong pattern''. If you use custom tvshowmatching regexps, check carefully the order in which the regexps are being matched alongside the defaults. Also check the note in [[#Split-episode|split-episode]] above.

Another possibility is that this is actually a case of the scraper picking the wrong TV show (the problem may be masked by the use of local artwork or lack of online artwork, although episode titles and plots should be a giveaway). In this situation even correctly named files will not get added if they lie outside the numbering of the incorrect show.
;Example
:The show [http://www.thetvdb.com/?tab=series&id=82607&lid=7 Castle] is a six episode documentary series about castles, not the [http://www.thetvdb.com/?tab=series&id=83462 multi-season 2009 crime drama]. Any file numbered s01e07 or higher will not be added if XBMC thinks the latter is the former.
 
A fourth cause can be that you've different season listings than the scraper you're using. E.g. your season one is S1E01-S1E20 while according to the scraper E17-20 belongs to season two. The scraper will then add E1-16 to season one, the rest won't get scraped. 
To fix this you can:
* Use a different scraper. The TV addon [[Add-on:XEM | XEM]] allows you to choose use between four different sources.
* [[NFO files#Create an .NFO file .28recommended.29|Create NFO files]] for the TV show.
* If you still want to add the TV show with the scraper that has different listings than you, check the scraper site and rename/move your files according to its listings.

[[Category:Video Library]]
[[Category:XBMC Manual]]
{{frodo updated}}

Advancedsettings.xml

2013-10-02T01:28:27Z

Announ: /* <tvshowmatching> */ Clarification on case folding

{{mininav|[[General topics]]|[[Settings]]}}
{{clean up}}
{{DISPLAYTITLE:advancedsettings.xml}}
{{TOC right}}

The "'''advancedsettings.xml'''" file, which does not exist by default, may be created by a user in their "'''/[[userdata]]/'''" folder.

This file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens).

"'''advancedsettings.xml'''" is useful for advanced/expert users and for installers.

{{note|<code>'''This file will not exist unless created by the end-user, meaning YOU!'''</code>}}
The XBMC software will never write to this file, so any settings you define will not be overwritten by any XBMC GUI settings. You can only edit this file manually on your computer, via a text-editor (like Notepad in Windows or a XML-editor). All the settings available outside of the GUI are documented on this page.

If you are running XBMC on a dedicated HTPC and can only access the HTPC over the network then use an application like WinSCP to gain remote access to the file system on the HTPC from another computer and edit this file. You can edit this file from within WinSCP via the right click menu options.

{{note|
# - This file is '''C'''a'''S'''e '''S'''e'''N'''s'''I'''t'''I'''v'''E''' and must contain the <advancedsettings> tag (see the layout section below), so make sure you use all lower-case tags or they will not be read properly by XBMC.
# - After you have edited this file it is advisable to reboot XBMC completely to ensure that new settings take effect properly.
# - For some Windows versions, XBMC 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>C:\Users\[username]\AppData\Roaming\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.

== How to include GUI settings ==

You can also define the settings normally defined in the GUI in advancedsettings.xml. Any GUI based settings defined in advancedsettings.xml will override the GUI values, and the settings will be removed completely from the GUI (ie only alterable by editing advancedsettings.xml).

The easiest way to include a GUI setting is to first make sure it is set in the GUI to the value that you want, and then to 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 for the GUI (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 GUI entry for the character set will then no longer appear, and XBMC will always use the Hebrew (Windows) character set.

== List of available settings ==

=== <loglevel> ===
{{see also|debug log}}
{{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
| 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
| XBMC version = 8-12
| description =
The logging level that XBMC will use to log errors and information. The "hide" attribute is optional.
| example =
Example:
<syntaxhighlight lang="xml" enclose="div">
<loglevel hide="false">2</loglevel>
</syntaxhighlight>
}}

=== <packagefoldersize> ===
{{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>500</packagefoldersize> </syntaxhighlight>
}}

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

=== <cddbaddress> ===
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default: <tt>freedb.freedb.org</tt>

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

=== <airtunesport> ===
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).

=== <airplayport> ===
This overwrites the default listening port of the AirPlay server (announced via zeroconf).

=== <detectasudf> ===
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== <virtualshares> ===
Set to false to disable virtual shares like plugin, last.fm or shoutcast sources.

Default: True

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

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

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

=== <discstubextensions> ===
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> ===
Translation table for subtitle and audio names. Contains entries of the form

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

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

=== <samba> ===
<syntaxhighlight lang="xml" enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

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

=== <cleandatetime> ===
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> ===
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|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|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</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> ===
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.xbmc.org/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)''
: Use only one pair of parentheses
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards)''
: 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> ===
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<tvmultipartmatching>^[-_EeXx]+([0-9]+)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.

=== <excludefromscan> ===
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> ===
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

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

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

=== <pathsubstitution> ===
'''[[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 XBMC 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>

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

=== <playlistasfolders> ===
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.}}

=== <playlistretries> ===
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> ===
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

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

=== <remotedelay> ===
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> ===
This used to adjust the amount of time in milliseconds between repeated keystrokes. Used to prevent key-bounce, in other words prevents xbmc (lirc?) seeing one key press as multiple key presses with certain remotes.

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

=== <controllerdeadzone> ===
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, XBMC will see all input your controller is capable of registering) to 1.0 (XBMC will ignore all input inside of the device's physical limits).

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

=== <thumbsize> ===

{{frodo box|1=
<syntaxhighlight lang="xml" enclose="div">
This tag is replaced by <imageres> in Frodo.
</syntaxhighlight>
}}

The '''geometric mean''' of the image size i.e. The square root of the Width x Height : GM = 2√ W × H

There is a maximum value of 1024 enforced internally because anything larger is impractical and results in massive images that take up space and slow everything down for no gain. If you specify a value larger than 1024 it will be ignored and XBMC will use 1024.

If the GM of your source image is LESS than the value specified in the <thumbsize> tag, the image will NOT be resized and will be imported as is.

XBMC supports all sorts of different aspect ratios - compare banners with posters for example - and a single maximum width or height setting doesn't really make much sense so instead a single value is supplied which is the '''geometric mean'''.

This typically gives a better result than specifying a maximum dimension for either axis as 512 (for example) would give quite small banner images because it would restrict the width to 512 (smaller than is shown in some skins) yet would give large album covers because they are square and would end up being 512 x 512 (larger than what is shown in most skins), but is probably about right for posters in most skins.

To use an example, if you have a source image of 1000 x 1500 pixels, the geometric mean is: 2√1000 × 1500 = 1224.75 = 1225 rounded up.

1225 is greater than 1024, so XBMC will scale the image down to a size of 836 x 1253.

This is because : 2√ 836 x 1253 = 1023.478 = 1024 rounded up (maximum allowed GM)

So in summary, if you want XBMC to resize all images to a size of 667 x 1000 (as a random example) you must calculate the GM of that as follows:

2√ 667 × 1000 = 816.7 = 817 rounded up.

817 is therefore the value you must set <thumbsize> to so that any image you supply that is LARGER than 667 x 1000 to begin with, will be scaled down to that size.

=== <fanartheight> ===
{{frodo box|1=
<syntaxhighlight lang="xml" enclose="div">
This tag is replaced by <fanartres> in Frodo.
</syntaxhighlight>
}}

To specify the height value cached fanart should be resized to in pixels. The width is automatically calculated as being 16/9*height.

Default: 1080

=== <imageres> ===
{{frodo box|1=
<syntaxhighlight lang="xml" enclose="div">
This tag is new for Frodo, replacing <thumbsize>.
</syntaxhighlight>}}

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.

<syntaxhighlight lang="xml" enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== <fanartres> ===
{{frodo box|1=
<syntaxhighlight lang="xml" enclose="div">This tag is new for Frodo, replacing <fanartheight>.</syntaxhighlight>
}}

To 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.

<syntaxhighlight lang="xml" enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

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

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

=== <dvdthumbs> ===

{{frodo box|1=
<syntaxhighlight lang="xml" enclose="div">Frodo ignores this tag.</syntaxhighlight>
}}

A list of additional files to try when searching for dvdrom thumbnail images. (The default is folder.jpg which can be removed.)

{{note|
* File names are case sensitive in XBMC and due to the fact that internally XBMC looks for "folder.jpg" using 4 different variants of that file name with different casing, you MUST specify all 4 variants of that file name in the <remove> tag to make XBMC ignore it completely. On a Windows system case sensitivity is irrelevant so if any one of the 4 variants is still being looked for by XBMC when it scans your folders, it will match "folder.jpg" regardless of the casing.

* This is not obvious and unless you know what the XBMC code is doing internally you wouldn't know this and wouldn't know what variants, specifically, you need to include in the <remove> tag.

* The example below shows you exactly what it should look like.

* If you are working on Linux systems where case sensitivity IS an issue then obviously you should also make sure that you provide variants of any file names you include in the <add> tag that cover any possible differences in casing that the scanner may encounter.}}

e.g.. To make sure that it finds "cover.jpg" on a Linux file system where case sensitivity matters, you would probably want
to do this:
<syntaxhighlight lang="xml" enclose="div">
<add> Cover.jpg|cover.jpg|Cover.JPG|cover.JPG </add>
</syntaxhighlight>

In a Windows environment this tends to not be an issue with regards the <add> tag because case is ignored but you STILL need
to provide all 4 variants of "folder.jpg" in the <remove> tag.

{{note| The order of the items that you include in the <tt><add/></tt> element IS important. If you add both thumb.jpg and cover.jpg, and you have BOTH of those files in a folder that XBMC scans and imports
from, XBMC will use the FIRST matching file name it finds in the <tt><add/></tt> element. So in the example below thumb.jpg would be used as the thumbnail and cover.jpg would be IGNORED.}} 

<syntaxhighlight lang="xml" enclose="div">
<dvdthumbs>
<remove>folder.jpg|Folder.jpg|folder.JPG|Folder.JPG</remove>
<add>thumb.jpg|cover.jpg</add>
</dvdthumbs>
</syntaxhighlight>

=== <fanart> ===
{{frodo box|1=
<syntaxhighlight lang="xml" enclose="div">Frodo ignores this tag for video. It's still used for music, however.</syntaxhighlight>
}}
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>

=== <masterlock> ===
If you enable any masterlock settings below, they will be removed from UI. Code needs to be MD5'd, and you can use [http://pajhome.org.uk/crypt/md5/ this site] to hash it.

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<startuplock>false</startuplock> 
<automastermode>false</automastermode> 
<loginlock>true</loginlock> 

<maxretries>3<maxretries> 
</masterlock>
</syntaxhighlight>

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

<resample>48000</resample>

<applydrc>true</applydrc>

<dvdplayerignoredtsinwav>false</dvdplayerignoredtsinwav>

<limiterhold>0.025</limiterhold>

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

The new [[AudioEngine]] introduced in Frodo includes support for the following advancedsettings:
{{frodo box|1=
<syntaxhighlight lang = "xml">
<audio>

<resample>0</resample>

<forceDirectSound>0</forceDirectSound>

<audiophile>0</audiophile>

<audiosinkbufferdurationmsec>50</audiosinkbufferdurationmsec>

<allowtranscode44100>0</allowtranscode44100>

<streamsilence>0</streamsilence>
</audio>
</syntaxhighlight>
}}
For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

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

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


<vdpauscaling>true</vdpauscaling>


<enablehighqualityhwscalers>true</enablehighqualityhwscalers> 
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing> 
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing> 
<allowmpeg4vdpau>true</allowmpeg4vdpau> 
<allowmpeg4vaapi>true</allowmpeg4vaapi> 
<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>
</syntaxhighlight>
{{Gotham box|
<syntaxhighlight lang="xml" enclose="div">

<stereoscopicflagssbs>3DSBS|3D.SBS|HSBS|H.SBS|H-SBS| SBS |FULL-SBS|FULL.SBS|FULLSBS|FSBS|HALF-SBS</stereoscopicflagssbs>
<stereoscopicflagstab>3DTAB|3D.TAB|HTAB|H.TAB|3DOU|3D.OU|3D.HOU| HOU | OU |HALF-TAB</stereoscopicflagstab>
</syntaxhighlight>
}}
<syntaxhighlight lang="xml" enclose="div">
</video>
</syntaxhighlight>

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

=== <videolibrary> ===
Options specific to the Video Library

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

<cleanonupdate>true</cleanonupdate> 
<hideallitems>true</hideallitems> 
<hideemptyseries>true</hideemptyseries> 
<hiderecentlyaddeditems>true</hiderecentlyaddeditems> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<mymovies> 
<categoriestogenres>false</categoriestogenres> 
</mymovies>
<dateadded>2</dateadded> 
</videolibrary>
</syntaxhighlight>

=== <videoscanner> ===
Options specific to the Video scanner
<syntaxhighlight lang="xml" enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

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

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

=== <network> ===
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>5</curllowspeedtime> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<cachemembuffersize>5242880</cachemembuffersize> 
</syntaxhighlight>
{{Gotham box|1=
<syntaxhighlight lang="xml" enclose="div">
<alwaysforcebuffer>1</alwaysforcebuffer> 
<readbufferfactor>4.0</readbufferfactor> 
</syntaxhighlight>}}
<syntaxhighlight lang="xml" enclose="div">
</network>
</syntaxhighlight>

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

=== <ftpshowcache> ===
default is false, if set to true, shows cache (X Y Z) partitions in the root directory listing

=== <screensaver> ===
To avoid potential worries of plasma screen burn-in, you can set the Dim screensaver fade level to 0% here or in the Settings.
<syntaxhighlight lang="xml" enclose="div">
<screensaver>
<dimlevel>0</dimlevel> 
</screensaver>
</syntaxhighlight>

=== <hosts> ===
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang="xml" enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== <fullscreen> ===
Starts XBMC in full screen (check resolutions!).

<syntaxhighlight lang="xml" enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== <splash> ===
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang="xml" enclose="div">
<splash>false</splash>
</syntaxhighlight>

=== <cputempcommand> ===
Provide a shell command XBMC will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]". 
;For Nvidia and Raspberry Pi
<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>
;For ATI/AMD
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== <gputempcommand> ===
Provide a shell command XBMC will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]". 
;For Nvidia
<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>
;For ATI/AMD
<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>

;For Raspberry Pi
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== <glrectanglehack> ===
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> ===
Added in XBMC v9.11 ('''win32 only'''). Keeps XBMC 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>

=== <externalplayer> ===
See the relevant [[External players]].

=== <bginfoloadermaxthreads> ===
Control the number of threads in the background info loader thread pool (thumb generator, flagging, etc). Useful for tuning platforms that are low on CPU, like Intel Atom based systems.
<syntaxhighlight lang="xml" enclose="div">
<bginfoloadermaxthreads>5</bginfoloadermaxthreads>
</syntaxhighlight>

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

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

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

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

:{{note|''This Option requires SVN Version r26733 or a current GIT version.''}}

=== <musicdatabase>/<videodatabase> ===
{{see also|HOW-TO:Sync multiple libraries}}
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 XBMC's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as XBMC 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/xbmc/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>xbmc_video</name>
<user>xbmc</user>
<pass>xbmc</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/xbmc/databases</host>
<name>xbmc_music</name>
</musicdatabase>
</syntaxhighlight>

{{note|
* '' This Option requires SVN Version r28117 or current GIT revision.''
* '' 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">
CREATE INDEX ixSongArtist
ON song(idArtist, idAlbum)
</syntaxhighlight>

=== <window> ===
This allows you to manually set the default size of XBMC'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>

=== <useddsfanart> ===
This settings allows XBMC 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>

=== <allowd3d9ex> ===
Applies only to Windows Vista and up. Values: true/false. Allows xbmc 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> ===
Windows only. A bitmask to prevent xbmc 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> ===
Windows only: XBMC 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>

=== <jsonrpc> ===
To make it easier for developers using the [[JSON RPC]] API in their (third party) applications to debug during development the json output of XBMC 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 XBMC 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>

=== <subsdelayrange> ===
to set subtitle delay slider to more than 10 seconds

<syntaxhighlight lang="xml" enclose="div">
<video>
<subsdelayrange>30</subsdelayrange>
</video>
</syntaxhighlight>

=== <enablemultimediakeys> ===
This setting only has any effect on Windows versions of XBMC, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. XBMC 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>

=== <algorithmdirtyregions> ===

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, big speed gains can be seen. Because all GPUs work differently, only Mode 3, combined with nofliptimeout=0, is guaranteed to be safe for everyone, but current timing issues with nofliptimeout keep this from being the default.

{| class="wikitable"
! 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'''
|}

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== <visualizedirtyregions> ===
Enable dirty-region visualization. Paints a rectangle over marked controls.
* true: on
* false: off (default)

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== <nofliptimeout> ===
Specifies the timeout in milliseconds after which XBMC will not flip the graphics buffers anymore when nothing has been rendered, this lowers both CPU and GPU usage.
* -1: disabled
* 0 or higher: timeout in milliseconds (0 is default)

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<nofliptimeout>1000</nofliptimeout>
</gui>
</syntaxhighlight>

=== <showexitbutton> ===
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>false</showexitbutton>
</syntaxhighlight>

=== <pvr> ===
<syntaxhighlight lang="xml" enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<showepginfoonselect>true</showepginfoonselect> 
<minvideocachelevel>5</minvideocachelevel> 
<maxvideocachelevel>10</maxvideocachelevel> 
<cacheindvdplayer>true</cacheindvdplayer> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

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