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¶

Important

As of Kometa release 1.21, the keys associated with this Defaults file has changed.

If you are setting custom images, you will need to use <<originals_key>>

Streaming Service	Key	`originals_key`	Weight
Netflix	`8`	`netflix`	`160`
Prime Video	`9`	`amazon`	`150`
Disney+	`337`	`disney`	`140`
Max	`1189`	`max`	`130`
Crunchyroll	`283`	`Crunchyroll`	`120`
YouTube	`188`	`youtube`	`110`
Hulu	`15`	`hulu`	`100`
Paramount+	`531`	`paramount`	`90`
AppleTV	`350`	`appletv`	`80`
Peacock	`387`	`peacock`	`70`
Showtime	`37`	`showtime`	`60`
discovery+	`510`	`discovery`	`58`
Crave	`230`	`crave`	`55`
NOW	`39`	`now`	`50`
All 4	`103`	`all4`	`40`
britbox	`151`	`britbox`	`30`
BET+	`1759`	`bet`	`20`
hayu	`223`	`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 `GB`	`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:
      - default: streaming
  TV Shows:
    overlay_files:
      - default: 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 Kometa Defaults file.
Overlay Template Variables are additional variables shared across the Kometa 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`

File-Specific Template VariablesOverlay Template Variables

Variable	Description & Values
`region`	Description: Changes some Streaming Service lists to regional variants (see below table for more information. Default: `US` Values: Any ISO 3166-1 Code of the region where the streaming information should be based on.
`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>>`¹	Description: Controls the weight of the Overlay. Higher numbers have priority. Values: Any Number

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>>`¹	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>>`¹	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>>`¹	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>>`¹	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>>`¹	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

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:
      - default: streaming
        template_variables:
          originals_only: true
          use_peacock: false
          weight_netflix: 100