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

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

Requirements & Recommendations

Supported Overlay Level: Movie, Show

Supported Streaming Services

Streaming Service Key Weight
Netflix netflix 160
Prime Video amazon 150
Disney+ disney 140
Max max 130
Crunchyroll Crunchyroll 120
YouTube youtube 110
Hulu hulu 100
Paramount+ paramount 90
AppleTV appletv 80
Peacock peacock 70
Showtime showtime 60
discovery+ discovery 58
Crave crave 55
NOW now 50
All 4 all4 40
britbox britbox 30
BET+ bet 20
hayu hayu 10

Config

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

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

Template Variable Default Values

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.

Variable Description & Values
horizontal_offset Description: Change the horizontal offset.
Default Value: 15
horizontal_align Description: Change the horizontal alignment.
Default Value: left
vertical_offset Description: Change the vertical offset.
Default Value: 390
vertical_align Description: Change the vertical alignment.
Default Value: bottom
back_color Description: Change the back color.
Default Value: #00000099
back_radius Description: Change the back (lozenge) radius .
Default Value: 30
back_width Description: Change the back (lozenge) width.
Default Value: 305
back_height Description: Change the back (lozenge) height.
Default Value: 105
region Description: Changes some Streaming Service lists to regional variants (see below table for more information.
Default: us
Values: us,uk,ca, da, de, es, fr, it, pt-br
originals_only Description: Changes Streaming Service overlays to only apply to original content produced by the service.
Note: Cannot be used with region, and only produces overlays for amazon, appletv, disney, max, hulu, netflix, paramount, peacock
Default: false
Values: true, false
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 overlay you must replace <<key>> with when calling.

Regional Variants

Some logic is applied to allow for regional streaming service lists to be available to users depending on where they are, as detailed below:

Region Key Description
any besides us amazon, disney, netflix These overlays will use regional variant lists to ensure the overlays are applied to what is available in the region specified
any besides uk all4, britbox, hayu, now These overlays will not be used if the region is not uk as these streaming services are UK-focused
any besides ca crave These overlays will not be used if the region is not ca as these streaming services are Canada-focused
ca max, showtime These overlays will not be used if the region is ca as these streaming services are part of the Crave streaming service in Canada

{% include-markdown "../overlay_variables.md" %}

Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.

libraries:
  Movies:
    overlay_files:
      - pmm: streaming
        template_variables:
          originals_only: true
          use_peacock: false
          weight_netflix: 100