2022-10-17 06:48:08 +00:00
# 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.
2023-01-21 00:20:33 +00:00
## Requirements & Recommendations
Supported Overlay Level: Movie, Show
2022-10-17 06:48:08 +00:00
## Supported Streaming Services
2022-11-16 14:30:04 +00:00
| Streaming Service | Key | Weight |
|:------------------|:--------------|:-------|
| Netflix | `netflix` | `160` |
| Prime Video | `amazon` | `150` |
| Disney+ | `disney` | `140` |
| HBO Max | `hbomax` | `130` |
2022-10-31 00:48:07 +00:00
| Crunchyroll | `Crunchyroll` | `120` |
2022-11-16 14:30:04 +00:00
| YouTube | `youtube` | `110` |
| Hulu | `hulu` | `100` |
| Paramount+ | `paramount` | `90` |
| AppleTV | `appletv` | `80` |
| Peacock | `peacock` | `70` |
| Showtime | `showtime` | `60` |
| NOW | `now` | `50` |
| All 4 | `all4` | `40` |
| britbox | `britbox` | `30` |
| BET+ | `bet` | `20` |
| hayu | `hayu` | `10` |
2022-10-28 13:17:25 +00:00
2022-10-17 06:48:08 +00:00
## Config
The below YAML in your config.yml will create the overlays:
```yaml
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.
2023-01-04 19:46:04 +00:00
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.
2022-10-17 06:48:08 +00:00
2022-11-08 20:59:23 +00:00
All [Shared Overlay Variables ](../overlay_variables ) are available with the default values below as well as the additional Variables below which can be used to customize the file.
2022-10-17 06:48:08 +00:00
2022-11-16 14:30:04 +00:00
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
2022-10-17 06:48:08 +00:00
| `back_color` | `#00000099` |
2022-11-16 14:30:04 +00:00
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
2022-10-17 06:48:08 +00:00
2022-10-17 14:00:48 +00:00
| Variable | Description & Values |
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------|
| `weight_<<key>>` < sup > 1</ sup > | **Description:** Controls the weight of the Overlay. Higher numbers have priority.< br > **Values:** Any Number |
2022-10-17 12:13:48 +00:00
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
2022-10-17 06:48:08 +00:00
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: streaming
template_variables:
use_peacock: false
use_youtube: false
weight_youtube: 5
```
