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.

This file works with Movie and Show Libraries.

Designed for TRaSH Guides filename naming scheme.

Supported Video Formats¶

Video Format	Key	Weight
REMUX	`remux`	`60`
BLU-RAY	`bluray`	`50`
WEB	`web`	`40`
HDTV	`hdtv`	`30`
DVD	`dvd`	`20`
SDTV	`sdtv`	`10`

Config¶

The below YAML in your config.yml will create the overlays:

libraries:
  Movies:
    overlay_path:
      - pmm: audio_codec
  TV Shows:
    overlay_path:
      - pmm: video_format
      - pmm: video_format
        template_variables:
          overlay_level: season
      - pmm: video_format
        template_variables:
          overlay_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
`horizontal_offset`	`15`
`horizontal_align`	`left`
`vertical_offset`	`30`
`vertical_align`	`bottom`
`back_color`	`#00000099`
`back_radius`	`30`
`back_width`	`305`
`back_height`	`105`

Variable

Description & Values

overlay_level

Description: Choose the Overlay Level.
Values: season or episode

font

Description: Choose the font for the Overlay.
Default: fonts/Inter-Medium.ttf
Values: Path to font file

font_style

Description: Font style for Variable Fonts.
Values: Variable Font Style

font_size

Description: Choose the font size for the Overlay.
Default: 55
Values: Any Number greater then 0

font_color

Description: Choose the font color for the Overlay.
Default: #FFFFFF
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA

stroke_width

Description: Font Stroke Width for the Text Overlay.
Values: Any Number greater then 0

stroke_color

Description: Font Stroke Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA

text_<<key>>¹

Description: Choose the text for the Overlay.
Default:

Key	Default
`remux`	`REMUX`
`bluray`	`BLU-RAY`
`web`	`WEB`
`hdtv`	`HDTV`
`dvd`	`DVD`
`sdtv`	`SDTV`

Values: Any String

weight_<<key>>¹

Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number

regex_<<key>>¹

Description: Controls the regex of the Overlay Search.
Values: Any Proper Regex

Each default overlay has a key that when calling to effect a specific collection 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: audio_codec
        template_variables:
          text_bluray: BLURAY
          use_sdtv: false
          use_dvd: false