Skip to content

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

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

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 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 will use its default value if it has one if not it's just ignored.

Variable Lists (click to expand)
  • File-Specific Template Variables are variables available specifically for this PMM Defaults file.

  • Overlay Template Variables are additional variables shared across the PMM Overlay Defaults.

Default Template Variable Values (click to expand)
Variable Default
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
Variable Description & Values
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.
Variable Description & Values
use_<<key>>1 Description: Turns off individual Overlays in a Defaults file.
Values: false to turn off the overlay
file Description: Controls the images associated with all the Overlays to a local file.
Values: Filepath to Overlay Image
file_<<key>>1 Description: Controls the image associated with this key's Overlay to a local file.
Values: Filepath to Overlay Image
url Description: Controls the images associated with all the Overlays to a url.
Values: URL to Overlay Image
url_<<key>>1 Description: Controls the image associated with this key's Overlay to a url.
Values: URL to Overlay Image
git Description: Controls the images associated with all the Overlays to the git repo.
Values: Git Path to Overlay Image
git_<<key>>1 Description: Controls the image associated with this key's Overlay to the git repo.
Values: Git Path to Overlay Image
repo Description: Controls the images associated with all the Overlays to a custom repo.
Values: Repo Path to Overlay Image
repo_<<key>>1 Description: Controls the image associated with this key's Overlay to a custom repo.
Values: Repo Path to Overlay Image
horizontal_offset Description: Controls the Horizontal Offset of this overlay. Can be a %.
Values: Number 0 or greater or 0%-100%
horizontal_align Description: Controls the Horizontal Alignment of the overlay.
Values: left, center, or right
vertical_offset Description: Controls the Vertical Offset of this overlay. Can be a %.
Values: Number 0 or greater or 0%-100%
vertical_align Description: Controls the Vertical Alignment of the overlay.
Values: top, center, or bottom
back_color Description: Controls the Backdrop Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
AA is transparency; 00 [transparent] to FF [opaque]
back_width Description: Controls the Backdrop Width for the Text Overlay. If back_width is not specified the Backdrop Sizes to the text
Values: Any number greater than 0
back_height Description: Controls the Backdrop Height for the Text Overlay. If back_height is not specified the Backdrop Sizes to the text
Values: Any number greater than 0
back_align Description: Controls the Alignment for the Text Overlay inside the backdrop. If back_align is not specified the Backdrop Centers the text.
Values: left, right, center, top, or bottom
back_padding Description: Controls the Backdrop Padding for the Text Overlay.
Values: Any number greater than 0
back_radius Description: Controls the Backdrop Radius for the Text Overlay.
Values: Any number greater than 0
back_line_color Description: Controls the Backdrop Line Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA``AA is transparency; 00 [transparent] to FF [opaque]
back_line_width Description: Controls the Backdrop Line Width for the Text Overlay.
Values: Any number greater than 0
  1. Each default overlay has a key that when calling to effect a specific collection you must replace <<key>> with when calling.
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