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 |
|
|
Prime Video |
|
|
Disney+ |
|
|
Max |
|
|
Crunchyroll |
|
|
YouTube |
|
|
Hulu |
|
|
Paramount+ |
|
|
AppleTV |
|
|
Peacock |
|
|
Showtime |
|
|
discovery+ |
|
|
Crave |
|
|
NOW |
|
|
All 4 |
|
|
britbox |
|
|
BET+ |
|
|
hayu |
|
|
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 template_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 |
Description & Values |
---|---|
|
Description: Change the horizontal offset. |
|
Description: Change the horizontal alignment. |
|
Description: Change the vertical offset. |
|
Description: Change the vertical alignment. |
|
Description: Change the back color. |
|
Description: Change the back (lozenge) radius . |
|
Description: Change the back (lozenge) width. |
|
Description: Change the back (lozenge) height. |
|
Description: Changes some Streaming Service lists to regional variants (see below table for more information. |
|
Description: Changes Streaming Service overlays to only apply to original content produced by the service. |
|
Description: Controls the weight of the Overlay. Higher numbers have priority. |
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 |
|
These overlays will use regional variant lists to ensure the overlays are applied to what is available in the region specified |
any besides |
|
These overlays will not be used if the region is not |
any besides |
|
These overlays will not be used if the region is not |
|
|
These overlays will not be used if the region is |
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:
originals_only: true
use_peacock: false
weight_netflix: 100