Documentation › Settings
Config File
Every setting is stored in config.yaml and can be edited by hand
if desired. Any changes to the file directly will require TinePlayer to be restarted
to take effect.
For the file location see Where Data Is Saved.
Settings
No setting is required, everything will use its default if omitted.
| Key | Default | Values |
|---|---|---|
ui_scale | Unset (Automatic) | Interface scale from 0.33 to 3, such as
1.5. |
language | Unset (System) | The interface language as a locale
code, such as ru or pt-BR. |
sounds | true |
Play navigation click sounds. |
check_for_updates | true |
Check for and alert for new updates. |
primary_sink | Unset (System Default) | The first output device's name. If unset will use the system default device. Use tineplayer --list-devices from the command line. |
secondary_sink | Unset (null) | The second output's device name, or null for none. |
primary_languagesecondary_language | Unset | A language code for track auto-selection. |
primary_audio_descriptionsecondary_audio_description | false |
Auto-select a described track. |
primary_volumesecondary_volume | 1.0 |
The output's level, from 0.0 to 1.0. |
main_volume | 1.0 |
The All Outputs level, which each output's own level is a fraction
of, from 0.0 to 1.0. |
primary_mutedsecondary_muted | false |
Whether the output is muted. |
primary_offset_mssecondary_offset_ms | 0 |
Sync for the device,
in milliseconds from -1000 to 1000. |
primary_offset_onsecondary_offset_on | false |
Whether the sync correction is applied. Allows retaining the above value without using it. |
subtitle_kind | forced_only |
Which subtitles to choose automatically: none,
forced_only, forced, full or
sdh. |
subtitle_language | first |
Which language to choose for subtitles: first_only,
second_only, first, second, or a
language code. |
subtitle_size | 12 |
Point size from 8 to 24, measured against
the video's resolution. |
subtitle_font | Sans Bold |
Font family and style name. |
read_metadata | true |
Whether NFO and artwork files beside a video are read. The container's own tags are read either way. |
show_backdrop | true |
Whether the backdrop is drawn behind the media page. |
remember_positions | true |
Whether positions and track choices are written to
positions.json at all. Off keeps what is already saved and
stops adding to it. |
resume_min_percent | 5 |
Watch progress percentage to allow resuming. Never less than ten seconds. |
watched_percent | 90 |
Watch progress percentage to consider a video completely watched. |
Additional State Settings
A few keys are state rather than settings. They are also stored in config.yaml and can be
edited or deleted, but will be overwritten by TinePlayer when state changes.
| Key | State |
|---|---|
last_folder | Where the file browser was last open to. |
last_video | The most recent video opened. |
fullscreen | The fullscreen toggle state. |
kodi_paths | Manually added Kodi installations. |
Video watched percentage and track selections are stored in
positions.json. See Where data is saved.
Example Config
A fully commented config file covering every key can be found in the repository at examples/config.yaml.
ui_scale: 1.5
sounds: true
check_for_updates: true
primary_sink: Built-in Audio Analogue Stereo
primary_language: en
secondary_sink: Sennheiser USB Headset Analogue Stereo
secondary_language: ru
subtitle_language: ru
subtitle_size: 12
subtitle_font: Sans Bold
Invalid Configuration
If TinePlayer is unable to parse the config file it will report an error on startup and copy
the file to config.yaml.invalid so you can see what went wrong.
Fix it, rename it back, and restart.
Language Codes
The codes used by Preferred Language and Subtitle Language preferences, and for matching external audio and subtitle file languages.
A track tagged with any of the alternatives in the last column matches the
same language, and a region is ignored, so en-US and
en_GB both satisfy en.
| Code | Language | Its own name | Also matches |
|---|---|---|---|
ar | Arabic | العربية | ara |
hy | Armenian | Հայերեն | hye, arm |
az | Azerbaijani | Azərbaycan | aze |
bn | Bengali | বাংলা | ben |
bs | Bosnian | Bosanski | bos |
bg | Bulgarian | Български | bul |
yue | Cantonese | 粵語 | |
ca | Catalan | Català | cat |
zh | Chinese | 中文 | zho, chi, cmn |
hr | Croatian | Hrvatski | hrv |
cs | Czech | Čeština | ces, cze |
da | Danish | Dansk | dan |
nl | Dutch | Nederlands | nld, dut |
en | English | English | eng |
et | Estonian | Eesti | est |
fi | Finnish | Suomi | fin |
fr | French | Français | fra, fre |
ka | Georgian | ქართული | kat, geo |
de | German | Deutsch | deu, ger |
el | Greek | Ελληνικά | ell, gre |
he | Hebrew | עברית | heb, iw |
hi | Hindi | हिन्दी | hin |
hu | Hungarian | Magyar | hun |
is | Icelandic | Íslenska | isl, ice |
id | Indonesian | Bahasa Indonesia | ind, in |
it | Italian | Italiano | ita |
ja | Japanese | 日本語 | jpn |
kk | Kazakh | Қазақша | kaz |
ko | Korean | 한국어 | kor |
lv | Latvian | Latviešu | lav |
lt | Lithuanian | Lietuvių | lit |
ms | Malay | Bahasa Melayu | msa, may |
ml | Malayalam | മലയാളം | mal |
fa | Persian | فارسی | fas, per |
pl | Polish | Polski | pol |
pt | Portuguese | Português | por |
pa | Punjabi | ਪੰਜਾਬੀ | pan |
ru | Russian | Русский | rus |
sr | Serbian | Српски | srp |
sk | Slovak | Slovenčina | slk, slo |
sl | Slovenian | Slovenščina | slv |
es | Spanish | Español | spa |
sv | Swedish | Svenska | swe |
tl | Tagalog | Tagalog | tgl, fil |
ta | Tamil | தமிழ் | tam |
te | Telugu | తెలుగు | tel |
th | Thai | ไทย | tha |
tr | Turkish | Türkçe | tur |
uk | Ukrainian | Українська | ukr |
ur | Urdu | اردو | urd |
vi | Vietnamese | Tiếng Việt | vie |
Next: Where data is saved - every file TinePlayer writes.