Audio/Subtitle Language Flags Overlay¶
The languages
Default Overlay File is used to create an overlay of a flag and ISO 639-1 Code based on the audio/subtitle languages available on each item within your library.
Requirements & Recommendations¶
Supported library types: Movie & Show
Supported Audio/Subtitle Language Flags¶
Audio/Subtitle Languages |
Key |
Weight |
Default Flag |
Default Use |
---|---|---|---|---|
English |
|
|
|
✅ |
German |
|
|
|
✅ |
French |
|
|
|
✅ |
Spanish |
|
|
|
✅ |
Portuguese |
|
|
|
✅ |
Japanese |
|
|
|
✅ |
Korean |
|
|
|
❌ |
Chinese |
|
|
|
❌ |
Danish |
|
|
|
❌ |
Russian |
|
|
|
❌ |
Italian |
|
|
|
❌ |
Hindi |
|
|
|
❌ |
Telugu |
|
|
|
❌ |
Farsi |
|
|
|
❌ |
Thai |
|
|
|
❌ |
Dutch |
|
|
|
❌ |
Norwegian |
|
|
|
❌ |
Icelandic |
|
|
|
❌ |
Swedish |
|
|
|
❌ |
Turkish |
|
|
|
❌ |
Polish |
|
|
|
❌ |
Czech |
|
|
|
❌ |
Ukrainian |
|
|
|
❌ |
Hungarian |
|
|
|
❌ |
Arabic |
|
|
|
❌ |
Bulgarian |
|
|
|
❌ |
Bengali |
|
|
|
❌ |
Bosnian |
|
|
|
❌ |
Catalan |
|
|
|
❌ |
Welsh |
|
|
|
❌ |
Greek |
|
|
|
❌ |
Estonian |
|
|
|
❌ |
Basque |
|
|
|
❌ |
Finnish |
|
|
|
❌ |
Tagalog |
|
|
|
❌ |
Filipino |
|
|
|
❌ |
Galician |
|
|
|
❌ |
Hebrew |
|
|
|
❌ |
Croatian |
|
|
|
❌ |
Indonesian |
|
|
|
❌ |
Georgian |
|
|
|
❌ |
Kazakh |
|
|
|
❌ |
Kannada |
|
|
|
❌ |
Latin |
|
|
|
❌ |
Lithuanian |
|
|
|
❌ |
Latvian |
|
|
|
❌ |
Macedonian |
|
|
|
❌ |
Malayalam |
|
|
|
❌ |
Marathi |
|
|
|
❌ |
Malay |
|
|
|
❌ |
Norwegian Nokmål |
|
|
|
❌ |
Norwegian Nynorsk |
|
|
|
❌ |
Punjabi |
|
|
|
❌ |
Romanian |
|
|
|
❌ |
Slovak |
|
|
|
❌ |
Slovenian |
|
|
|
❌ |
Albanian |
|
|
|
❌ |
Serbian |
|
|
|
❌ |
Somali |
|
|
|
❌ |
Swahili |
|
|
|
❌ |
Tamil |
|
|
|
❌ |
Urdu |
|
|
|
❌ |
Vietnamese |
|
|
|
❌ |
Lingala |
|
|
|
❌ |
Wolof |
|
|
|
❌ |
Mayan |
|
|
|
❌ |
Inuktitut |
|
|
|
❌ |
Romani |
|
|
|
❌ |
Amharic |
|
|
|
❌ |
Sundanese |
|
|
|
❌ |
Zulu |
|
|
|
❌ |
Luxembourgish |
|
|
|
❌ |
Mossi |
|
|
|
❌ |
Square Style¶
Below is a screenshot of the alternative Square (square
) style which can be set via the style
template variable.
Half Style¶
Below is a screenshot of the alternative Half (half
) style which can be set via the style
template variable.
Config¶
The below YAML in your config.yml will create the overlays:
libraries:
Movies:
overlay_path:
- pmm: languages
TV Shows:
overlay_path:
- pmm: languages
- pmm: languages
template_variables:
builder_level: season
- pmm: languages
template_variables:
builder_level: episode
Template Variables¶
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the template_variables:
section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it’s just ignored.
All Shared Overlay Variables are available with the default values below as well as the additional Variables below which can be used to customize the file.
Variable |
Default |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Variable |
Description & Values |
|||||||
---|---|---|---|---|---|---|---|---|
|
Description: Controls which Languages will be active. |
|||||||
|
Description: Controls if the overlay is based on subtitle language instead of audio language. |
|||||||
|
Description: Choose the Overlay Level. |
|||||||
|
Description: Choose the horizontal position for the flag group. |
|||||||
|
Description: Choose the vertical position for the flag group. |
|||||||
|
Description: Choose the number of overlay this queue displays. |
|||||||
|
Description: Choose the display alignment for the flag group. |
|||||||
|
Description: Controls the visual theme of the overlays created.
|
|||||||
|
Description: Controls the flag alignment in the backdrop. |
|||||||
|
Description: Controls the offset between the flag and the text. |
|||||||
|
Description: Controls if the overlay display is in lowercase. |
|||||||
|
Description: Use the Custom Given Queue instead of the the provided Queues. |
|||||||
|
Description: Controls the country image for the Overlay. |
|||||||
|
Description: Controls the weight of the Overlay. Higher numbers have priority. |
Each default overlay has a
key
that when calling to effect a specific overlay you must replace<<key>>
with when calling.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
libraries:
Movies:
overlay_path:
- pmm: languages
template_variables:
languages:
- en
- ja
use_subtitles: true
style: square