Settings/System: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (Updated for v20)
 
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{mininav|[[Settings]]}}
{{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 <!-- For some reason it says "Display" on Mac OS X, and "Resolution" on Windows -->
| 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... ====
[[File:Settings-System-Display-01.jpg|700px|right]]
{{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 />
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Display|Display]]}}'''
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
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Audio|Audio]]}}'''
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|-
|colspan="2"|'''Audio output device'''
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Input|Input]]}}'''
|Select the device to be used for audio output.
|Standard
|All
|-
|-
|colspan="2"|'''Number of channels'''
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Internet_access|Internet access]]}}'''
|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'''
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Power_saving|Power saving]]}}'''
|-
|-
|'''Best Match'''
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Add-ons|Add-ons]]}}'''
|-
|-
|-
|'''{{resize|1.3em|[[File:Circle arrow right font awesome.png|60px|left]] [[Settings/System/Logging|Logging]]}}'''
|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> <!-- enter the max number of retries to input code, 3 is default. This setting isn't exposed in the actual GUI and can only be changed by manually editing this XML file -->
  <startuplock>false</startuplock>  <!-- true prompts user for code upon startup -->
</masterlock>
</syntaxhighlight>




{{Gotham updated}}
{{updated|20}}


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

Latest revision as of 04:01, 19 January 2023