Plex-Meta-Manager/docs/defaults/overlays/video_format.md

# 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](https://trash-guides.info/) filename naming scheme.**

![](images/video_format.png)

## 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:

```yaml
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 `templates_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](../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.<br>**Values:** `season` or `episode`                                                                                                                                                                                                                                                                                                                              |
| `font`                       | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file                                                                                                                                                                                                                                                                                  |
| `font_style`                 | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style                                                                                                                                                                                                                                                                                                                           |
| `font_size`                  | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0                                                                                                                                                                                                                                                                                         |
| `font_color`                 | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`                                                                                                                                                                                                                                          |
| `stroke_width`               | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0                                                                                                                                                                                                                                                                                                            |
| `stroke_color`               | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`                                                                                                                                                                                                                                                                   |
| `text_<<key>>`<sup>1</sup>   | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`remux`</td><td>`REMUX`</td></tr><tr><td>`bluray`</td><td>`BLU-RAY`</td></tr><tr><td>`web`</td><td>`WEB`</td></tr><tr><td>`hdtv`</td><td>`HDTV`</td></tr><tr><td>`dvd`</td><td>`DVD`</td></tr><tr><td>`sdtv`</td><td>`SDTV`</td></tr></table>**Values:** Any String |
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number                                                                                                                                                                                                                                                                                                 |
| `regex_<<key>>`<sup>1</sup>  | **Description:** Controls the regex of the Overlay Search.<br>**Values:** Any Proper Regex                                                                                                                                                                                                                                                                                                                   |

1. 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.

```yaml
libraries:
  Movies:
    overlay_path:
      - pmm: audio_codec
        template_variables:
          text_bluray: BLURAY
          use_sdtv: false
          use_dvd: false
```
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00			`# 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.

Replace instances of "TV Libraries" with "Show Libraries" 2022-10-17 12:19:18 +00:00			`This file works with Movie and Show Libraries.`
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
[171] wiki update 2022-10-29 15:59:01 +00:00			`Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.`
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
			`![](images/video_format.png)`

			`## Supported Video Formats`

[22] table alignment 2022-11-16 14:30:04 +00:00			`\| Video Format \| Key \| Weight \|`
			`\|:-------------\|:---------\|:-------\|`
			\| REMUX \| `remux` \| `60` \|
			\| BLU-RAY \| `bluray` \| `50` \|
			\| WEB \| `web` \| `40` \|
			\| HDTV \| `hdtv` \| `30` \|
			\| DVD \| `dvd` \| `20` \|
			\| SDTV \| `sdtv` \| `10` \|
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
			`## Config`

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

			```yaml
			`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 `templates_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.

[191] added delete_collections operation 2022-11-08 20:59:23 +00:00			`All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.`
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
[22] table alignment 2022-11-16 14:30:04 +00:00			`\| Variable \| Default \|`
			`\|:--------------------\|:------------\|`
			\| `horizontal_offset` \| `15` \|
			\| `horizontal_align` \| `left` \|
			\| `vertical_offset` \| `30` \|
			\| `vertical_align` \| `bottom` \|
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00			\| `back_color` \| `#00000099` \|
[22] table alignment 2022-11-16 14:30:04 +00:00			\| `back_radius` \| `30` \|
			\| `back_width` \| `305` \|
			\| `back_height` \| `105` \|
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
Various doc fixes 2022-10-17 12:13:48 +00:00			`\| Variable \| Description & Values \|`
			`\|:-----------------------------\|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\| `overlay_level` \| Description: Choose the Overlay Level.<br>Values: `season` or `episode` \|
			\| `font` \| Description: Choose the font for the Overlay.<br>Default: `fonts/Inter-Medium.ttf`<br>Values: Path to font file \|
			\| `font_style` \| Description: Font style for Variable Fonts.<br>Values: Variable Font Style \|
			\| `font_size` \| Description: Choose the font size for the Overlay.<br>Default: `55`<br>Values: Any Number greater then 0 \|
			\| `font_color` \| Description: Choose the font color for the Overlay.<br>Default: `#FFFFFF`<br>Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` \|
			\| `stroke_width` \| Description: Font Stroke Width for the Text Overlay.<br>Values: Any Number greater then 0 \|
			\| `stroke_color` \| Description: Font Stroke Color for the Text Overlay.<br>Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` \|
[1] fix resolution default 2022-11-09 20:12:47 +00:00			\| `text_<<key>>`<sup>1</sup> \| Description: Choose the text for the Overlay.<br>Default: <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`remux`</td><td>`REMUX`</td></tr><tr><td>`bluray`</td><td>`BLU-RAY`</td></tr><tr><td>`web`</td><td>`WEB`</td></tr><tr><td>`hdtv`</td><td>`HDTV`</td></tr><tr><td>`dvd`</td><td>`DVD`</td></tr><tr><td>`sdtv`</td><td>`SDTV`</td></tr></table>Values: Any String \|
			\| `weight_<<key>>`<sup>1</sup> \| Description: Controls the weight of the Overlay. Higher numbers have priority.<br>Values: Any Number \|
			\| `regex_<<key>>`<sup>1</sup> \| Description: Controls the regex of the Overlay Search.<br>Values: Any Proper Regex \|
Various doc fixes 2022-10-17 12:13:48 +00:00
			1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
			`The below is an example config.yml extract with some Template Variables added in to change how the file works.`

			```yaml
			`libraries:`
			`Movies:`
			`overlay_path:`
			`- pmm: audio_codec`
			`template_variables:`
			`text_bluray: BLURAY`
			`use_sdtv: false`
			`use_dvd: false`
			```