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

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

![](images/streaming.png)

## 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:

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

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](../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                                                                                                                                                                                                                                                                                                                     |
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `horizontal_offset`          | **Description:** Change the horizontal offset.<br>**Default Value:** `15`                                                                                                                                                                                                                                                                |
| `horizontal_align`           | **Description:** Change the horizontal alignment.<br>**Default Value:** `left`                                                                                                                                                                                                                                                           |
| `vertical_offset`            | **Description:** Change the vertical offset.<br>**Default Value:** `150`                                                                                                                                                                                                                                                                 |
| `vertical_align`             | **Description:** Change the vertical alignment.<br>**Default Value:** `bottom`                                                                                                                                                                                                                                                           |
| `back_color`                 | **Description:** Change the back color.<br>**Default Value:** `#00000099`                                                                                                                                                                                                                                                                |
| `back_radius`                | **Description:** Change the back (lozenge) radius .<br>**Default Value:** `30`                                                                                                                                                                                                                                                           |
| `back_width`                 | **Description:** Change the back (lozenge) width.<br>**Default Value:** `305`                                                                                                                                                                                                                                                            |
| `back_height`                | **Description:** Change the back (lozenge) height.<br>**Default Value:** `105`                                                                                                                                                                                                                                                           |
| `region`                     | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**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.<br>**Note**: Cannot be used with `region`, and only produces overlays for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false`       |
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**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 |

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:
          originals_only: true
          use_peacock: false
          weight_netflix: 100
```
[119] update overlay defaults yaml and wiki 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.

			`![](images/streaming.png)`

Standardize Defaults Requirements & Recommendations 2023-01-21 00:20:33 +00:00			`## Requirements & Recommendations`

			`Supported Overlay Level: Movie, Show`

[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00			`## Supported Streaming Services`

Update Streaming Overlay to allow for Regional variants. Add Crave and discovery overlay image. 2023-02-19 17:19:57 +00:00
[50] update max docs 2023-04-29 01:03:45 +00:00			`\| 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` \|
Add Showtime Streaming default 2022-10-28 13:17:25 +00:00
[119] update overlay defaults yaml and wiki 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.`

[2] remove templates_variables 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.
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
[191] added delete_collections operation 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.`
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
add `originals_only` to Streaming overlays 2023-04-27 13:51:24 +00:00			`\| Variable \| Description & Values \|`
			`\|:-----------------------------\|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\| `horizontal_offset` \| Description: Change the horizontal offset.<br>Default Value: `15` \|
			\| `horizontal_align` \| Description: Change the horizontal alignment.<br>Default Value: `left` \|
			\| `vertical_offset` \| Description: Change the vertical offset.<br>Default Value: `150` \|
			\| `vertical_align` \| Description: Change the vertical alignment.<br>Default Value: `bottom` \|
			\| `back_color` \| Description: Change the back color.<br>Default Value: `#00000099` \|
			\| `back_radius` \| Description: Change the back (lozenge) radius .<br>Default Value: `30` \|
			\| `back_width` \| Description: Change the back (lozenge) width.<br>Default Value: `305` \|
			\| `back_height` \| Description: Change the back (lozenge) height.<br>Default Value: `105` \|
			\| `region` \| Description: Changes some Streaming Service lists to regional variants (see below table for more information.<br>Default: `us`<br>Values: `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` \|
[50] update max docs 2023-04-29 01:03:45 +00:00			\| `originals_only` \| Description: Changes Streaming Service overlays to only apply to original content produced by the service.<br>Note: Cannot be used with `region`, and only produces overlays for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>Default: `false`<br>Values: `true`, `false` \|
add `originals_only` to Streaming overlays 2023-04-27 13:51:24 +00:00			\| `weight_<<key>>`<sup>1</sup> \| Description: Controls the weight of the Overlay. Higher numbers have priority.<br>Values: Any Number \|
Various doc fixes 2022-10-17 12:13:48 +00:00
[167] update changelog and missing documentation to prep for 1.19 2023-04-05 15:58:46 +00:00			1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00
Update Streaming Overlay to allow for Regional variants. Add Crave and discovery overlay image. 2023-02-19 17:19:57 +00:00			`## 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:`

[167] update changelog and missing documentation to prep for 1.19 2023-04-05 15:58:46 +00:00			`\| 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 \|
[50] update max docs 2023-04-29 01:03:45 +00:00			\| `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 \|
Update Streaming Overlay to allow for Regional variants. Add Crave and discovery overlay image. 2023-02-19 17:19:57 +00:00
[119] update overlay defaults yaml and wiki 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:`
add `originals_only` to Streaming overlays 2023-04-27 13:51:24 +00:00			`originals_only: true`
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00			`use_peacock: false`
add `originals_only` to Streaming overlays 2023-04-27 13:51:24 +00:00			`weight_netflix: 100`
[119] update overlay defaults yaml and wiki 2022-10-17 06:48:08 +00:00			```