Video Format Overlay¶
The video_format
Default Overlay File is used to create an overlay based on the video format available on each item within your library.
Requirements & Recommendations¶
Supported Overlay Level: Movie, Show, Season, Episode
Recommendations: Designed for TRaSH Guides filename naming scheme
Supported Video Formats¶
Video Format |
Key |
Weight |
---|---|---|
REMUX |
|
|
BLU-RAY |
|
|
WEB |
|
|
HDTV |
|
|
DVD |
|
|
SDTV |
|
|
Config¶
The below YAML in your config.yml will create the overlays:
libraries:
Movies:
overlay_path:
- pmm: video_format
TV Shows:
overlay_path:
- pmm: video_format
- pmm: video_format
template_variables:
builder_level: season
- pmm: video_format
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: Choose the Overlay Level. |
||||||||||||||
|
Description: Choose the font for the Overlay. |
||||||||||||||
|
Description: Font style for Variable Fonts. |
||||||||||||||
|
Description: Choose the font size for the Overlay. |
||||||||||||||
|
Description: Choose the font color for the Overlay. |
||||||||||||||
|
Description: Font Stroke Width for the Text Overlay. |
||||||||||||||
|
Description: Font Stroke Color for the Text Overlay. |
||||||||||||||
|
Description: Choose the text for the Overlay.
|
||||||||||||||
|
Description: Controls the weight of the Overlay. Higher numbers have priority. |
||||||||||||||
|
Description: Controls the regex of the Overlay Search. |
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: video_format
template_variables:
text_bluray: BLURAY
use_sdtv: false
use_dvd: false