Plex-Meta-Manager/docs/defaults/overlays/streaming.md
2022-10-17 10:00:48 -04:00

2.7 KiB

Streaming Services Overlay

The streaming Default Overlay File is used to create an overlay based on the streaming service the file is found on for each item within your library.

This file works with Movie and Show Libraries.

Supported Streaming Services

Streaming Service Key Weight
Netflix netflix 90
Prime Video amazon 80
Disney+ disney 70
HBO Max hbomax 60
YouTube youtube 50
Hulu hulu 40
Paramount+ paramount 30
AppleTV appletv 20
Peacock peacock 10

Config

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

libraries:
  Movies:
    overlay_path:
      - pmm: streaming
  TV Shows:
    overlay_path:
      - pmm: streaming

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 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 150
vertical_align bottom
back_color #00000099
back_radius 30
back_width 305
back_height 105
Variable Description & Values
weight_<<key>>1 Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number
  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.

libraries:
  Movies:
    overlay_path:
      - pmm: streaming
        template_variables:
          use_peacock: false
          use_youtube: false
          weight_youtube: 5