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

# Streaming Collections

The `streaming` Default Collection File is used to dynamically create collections based on the streaming Services that your media is available on.

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

## Requirements & Recommendations

Supported Library Types: Movie, Show

## Collections Section 030

| Collection                 | Key           | Description                                                                    |
|:---------------------------|:--------------|:-------------------------------------------------------------------------------|
| `Streaming Collections`    | `separator`   | [Separator Collection](../separators.md) to denote the Section of Collections. |
| `All 4 Movies/Shows`       | `all4`        | Collection of Movies/Shows Streaming on All 4.                                 |
| `Apple TV+ Movies/Shows`   | `appletv`     | Collection of Movies/Shows Streaming on Apple TV+.                             |
| `BET+ Movies/Shows`        | `bet`         | Collection of Movies/Shows Streaming on BET+.                                  |
| `BritBox Movies/Shows`     | `britbox`     | Collection of Movies/Shows Streaming on BritBox.                               |
| `Crave Movies/Shows`       | `crave`       | Collection of Movies/Shows Streaming on Crave.                                 |
| `Crunchyroll Shows`        | `crunchyroll` | Collection of Shows Streaming on Crunchyroll.                                  |
| `discovery+ Shows`         | `discovery`   | Collection of Shows Streaming on discovery+.                                   |
| `Disney+ Movies/Shows`     | `disney`      | Collection of Movies/Shows Streaming on Disney+.                               |
| `hayu Shows`               | `hayu`        | Collection of Shows Streaming on hayu.                                         |
| `Max Movies/Shows`         | `max`         | Collection of Movies/Shows Streaming on Max.                                   |
| `Hulu Movies/Shows`        | `hulu`        | Collection of Movies/Shows Streaming on Hulu.                                  |
| `Netflix Movies/Shows`     | `netflix`     | Collection of Movies/Shows Streaming on Netflix.                               |
| `NOW Movies/Shows`         | `now`         | Collection of Movies/Shows Streaming on NOW.                                   |
| `Paramount+ Movies/Shows`  | `paramount`   | Collection of Movies/Shows Streaming on Paramount+.                            |
| `Peacock Movies/Shows`     | `peacock`     | Collection of Movies/Shows Streaming on Peacock.                               |
| `Prime Video Movies/Shows` | `amazon`      | Collection of Movies/Shows Streaming on Prime Video.                           |
| `Showtime Movies/Shows`    | `showtime`    | Collection of Movies/Shows Streaming on Showtime.                              |

## Config

The below YAML in your config.yml will create the collections:

```yaml
libraries:
  Movies:
    collection_files:
      - pmm: streaming
  TV Shows:
    collection_files:
      - pmm: streaming
```

## Template Variable Default Values

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.

This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.

| Variable                        | Description & Values                                                                                                                                                                                                                                                                                                         |
|:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `limit`                         | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0                                                                                                                                                                                                      |
| `limit_<<key>>`<sup>1</sup>     | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0                                                                                                                                                                                   |
| `sort_by`                       | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../builders/smart.md#sort-options)                                                                                                                  |
| `sort_by_<<key>>`<sup>1</sup>   | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../builders/smart.md#sort-options)                                                                                                                            |
| `sync_mode`                     | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table>                             |
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table>                             |
| `exclude`                       | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Service Keys                                                                                                                                                                                          |
| `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 lists to only show original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` |
| `name_format`                   | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it.                                                                                                                                          |
| `summary_format`                | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string.                                                                                                                                                    |

1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

{%
   include-markdown "../collection_variables.md"
%}

## 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 collections will use regional variant lists to ensure the lists populate with what is available in the region specified             |
| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused                                |
| any besides `ca` | `crave`                          | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused                            |
| `ca`             | `max`, `showtime`                | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada |


### Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.

???+ tip

    Anywhere you see this icon:
   
    > :fontawesome-solid-circle-plus:
   
    That's a tooltip, you can press them to get more information.

```yaml
libraries:
  Movies:
    collection_files:
      - pmm: streaming
        template_variables:
          region: fr #(1)!
          sep_style: amethyst #(2)!
          visible_library_disney: true #(3)!
          visible_home_disney: true #(4)!
          visible_shared_disney: true #(5)!
          sonarr_add_missing_hulu: true #(6)!
          radarr_add_missing_amazon: true #(7)!
          sort_by: random #(8)!
```

1.  Use French region lists where possible
2.  Use the amethyst [Separator Style](../separators.md#separator-styles)
3.  Pin the "Disney+ Movies/Shows" collection to the Recommended tab of the library
4.  Pin the "Disney+ Movies/Shows" collection to the home screen of the server owner
5.  Pin the "Disney+ Movies/Shows" collection to the home screen of other users of the server
6.  Add missing shows in your library from the "Hulu Shows" list to your Sonarr
7.  Add missing movies in your library from the "Prime Video Movies" list to your Radarr
8.  Sort all the collections created by this file randomly
[109] finished both wiki updates 2 years ago			`# Streaming Collections`
[57] Yozora update 2 years ago
[48] split metadata and collection files with their own attributes 11 months ago			The `streaming` Default Collection File is used to dynamically create collections based on the streaming Services that your media is available on.
[57] Yozora update 2 years ago
add content_rating_cs and fix images on defaults wiki pages within the "both" folder 2 years ago			`![](../images/streaming.png)`
[57] Yozora update 2 years ago
Standardize Defaults Requirements & Recommendations 2 years ago			`## Requirements & Recommendations`

			`Supported Library Types: Movie, Show`

Rework Collections Sections 2 years ago			`## Collections Section 030`
[109] finished both wiki updates 2 years ago
[56] doc formatting 11 months ago			`\| Collection \| Key \| Description \|`
			`\|:---------------------------\|:--------------\|:-------------------------------------------------------------------------------\|`
[24] move to mkdocs 1 year ago			\| `Streaming Collections` \| `separator` \| [Separator Collection](../separators.md) to denote the Section of Collections. \|
[56] doc formatting 11 months ago			\| `All 4 Movies/Shows` \| `all4` \| Collection of Movies/Shows Streaming on All 4. \|
			\| `Apple TV+ Movies/Shows` \| `appletv` \| Collection of Movies/Shows Streaming on Apple TV+. \|
			\| `BET+ Movies/Shows` \| `bet` \| Collection of Movies/Shows Streaming on BET+. \|
			\| `BritBox Movies/Shows` \| `britbox` \| Collection of Movies/Shows Streaming on BritBox. \|
			\| `Crave Movies/Shows` \| `crave` \| Collection of Movies/Shows Streaming on Crave. \|
			\| `Crunchyroll Shows` \| `crunchyroll` \| Collection of Shows Streaming on Crunchyroll. \|
			\| `discovery+ Shows` \| `discovery` \| Collection of Shows Streaming on discovery+. \|
			\| `Disney+ Movies/Shows` \| `disney` \| Collection of Movies/Shows Streaming on Disney+. \|
			\| `hayu Shows` \| `hayu` \| Collection of Shows Streaming on hayu. \|
			\| `Max Movies/Shows` \| `max` \| Collection of Movies/Shows Streaming on Max. \|
			\| `Hulu Movies/Shows` \| `hulu` \| Collection of Movies/Shows Streaming on Hulu. \|
			\| `Netflix Movies/Shows` \| `netflix` \| Collection of Movies/Shows Streaming on Netflix. \|
			\| `NOW Movies/Shows` \| `now` \| Collection of Movies/Shows Streaming on NOW. \|
			\| `Paramount+ Movies/Shows` \| `paramount` \| Collection of Movies/Shows Streaming on Paramount+. \|
			\| `Peacock Movies/Shows` \| `peacock` \| Collection of Movies/Shows Streaming on Peacock. \|
			\| `Prime Video Movies/Shows` \| `amazon` \| Collection of Movies/Shows Streaming on Prime Video. \|
			\| `Showtime Movies/Shows` \| `showtime` \| Collection of Movies/Shows Streaming on Showtime. \|
[109] finished both wiki updates 2 years ago
			`## Config`

[59] typo fixes 2 years ago			`The below YAML in your config.yml will create the collections:`
[109] finished both wiki updates 2 years ago
[57] Yozora update 2 years ago			```yaml
			`libraries:`
			`Movies:`
[48] split metadata and collection files with their own attributes 11 months ago			`collection_files:`
[57] Yozora update 2 years ago			`- pmm: streaming`
[109] finished both wiki updates 2 years ago			`TV Shows:`
[48] split metadata and collection files with their own attributes 11 months ago			`collection_files:`
[109] finished both wiki updates 2 years ago			`- pmm: streaming`
[57] Yozora update 2 years ago			```

use markdown-include to include shared variables on each Defaults page rather than linking to the third page 11 months ago			`## Template Variable Default Values`
[57] Yozora update 2 years ago
[109] finished both wiki updates 2 years ago			`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.`
[57] Yozora update 2 years ago
[24] move to mkdocs 1 year ago			`This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.`
[183] finalize wiki for 1.18.0 2 years ago
[50] update max docs 2 years ago			`\| Variable \| Description & Values \|`
			`\|:--------------------------------\|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
greater than 0 1 year ago			\| `limit` \| Description: Changes the Builder Limit for all collections in a Defaults file.<br>Values: Number Greater than 0 \|
			\| `limit_<<key>>`<sup>1</sup> \| Description: Changes the Builder Limit of the specified key's collection.<br>Default: `limit`<br>Values: Number Greater than 0 \|
[56] doc formatting 11 months ago			\| `sort_by` \| Description: Changes the Smart Filter Sort for all collections in a Defaults file.<br>Default: `release.desc`<br>Values: [Any `smart_filter` Sort Option](../../builders/smart.md#sort-options) \|
			\| `sort_by_<<key>>`<sup>1</sup> \| Description: Changes the Smart Filter Sort of the specified key's collection.<br>Default: `sort_by`<br>Values: [Any `smart_filter` Sort Option](../../builders/smart.md#sort-options) \|
[50] update max docs 2 years ago			\| `sync_mode` \| Description: Changes the Sync Mode for all collections in a Defaults file.<br>Default: `sync`<br>Values:<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> \|
			\| `sync_mode_<<key>>`<sup>1</sup> \| Description: Changes the Sync Mode of the specified key's collection.<br>Default: `sync_mode`<br>Values:<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> \|
			\| `exclude` \| Description: Exclude these Streaming Services from creating a Dynamic Collection.<br>Values: List of Streaming Service Keys \|
			\| `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 lists to only show original content produced by the service.<br>Note: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>Default: `false`<br>Values: `true`, `false` \|
			\| `name_format` \| Description: Changes the title format of the Dynamic Collections.<br>Default: `<<key_name>> <<library_translationU>>s`<br>Values: Any string with `<<key_name>>` in it. \|
			\| `summary_format` \| Description: Changes the summary format of the Dynamic Collections.<br>Default: `<<library_translationU>>s streaming on <<key_name>>.`<br>Values: Any string. \|
[57] Yozora update 2 years ago
Various doc fixes 2 years ago			1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

use markdown-include to include shared variables on each Defaults page rather than linking to the third page 11 months ago			`{%`
			`include-markdown "../collection_variables.md"`
			`%}`

FML 2 years ago			`## 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 collections will use regional variant lists to ensure the lists populate with what is available in the region specified \|
			\| any besides `uk` \| `all4`, `britbox`, `hayu`, `now` \| These collections will not be created if the region is not `uk` as these streaming services are UK-focused \|
			\| any besides `ca` \| `crave` \| These collections will not be created if the region is not `ca` as these streaming services are Canada-focused \|
[50] update max docs 2 years ago			\| `ca` \| `max`, `showtime` \| These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada \|
FML 2 years ago

WIP adding tooltips to template variable examples highlighting what each template variable does. 12 months ago			`### Example Template Variable Amendments`

[106] finished charts on the wiki 2 years ago			`The below is an example config.yml extract with some Template Variables added in to change how the file works.`
[57] Yozora update 2 years ago
WIP adding tooltips to template variable examples highlighting what each template variable does. 12 months ago			`???+ tip`

			`Anywhere you see this icon:`

			`> :fontawesome-solid-circle-plus:`

			`That's a tooltip, you can press them to get more information.`

[57] Yozora update 2 years ago			```yaml
			`libraries:`
			`Movies:`
[48] split metadata and collection files with their own attributes 11 months ago			`collection_files:`
[57] Yozora update 2 years ago			`- pmm: streaming`
			`template_variables:`
WIP adding tooltips to template variable examples highlighting what each template variable does. 12 months ago			`region: fr #(1)!`
			`sep_style: amethyst #(2)!`
			`visible_library_disney: true #(3)!`
			`visible_home_disney: true #(4)!`
			`visible_shared_disney: true #(5)!`
			`sonarr_add_missing_hulu: true #(6)!`
			`radarr_add_missing_amazon: true #(7)!`
			`sort_by: random #(8)!`
			```

[56] doc formatting 11 months ago			`1. Use French region lists where possible`
WIP adding tooltips to template variable examples highlighting what each template variable does. 12 months ago			`2. Use the amethyst [Separator Style](../separators.md#separator-styles)`
			`3. Pin the "Disney+ Movies/Shows" collection to the Recommended tab of the library`
finish adding tooltips to Defaults Collections 12 months ago			`4. Pin the "Disney+ Movies/Shows" collection to the home screen of the server owner`
			`5. Pin the "Disney+ Movies/Shows" collection to the home screen of other users of the server`
WIP adding tooltips to template variable examples highlighting what each template variable does. 12 months ago			`6. Add missing shows in your library from the "Hulu Shows" list to your Sonarr`
			`7. Add missing movies in your library from the "Prime Video Movies" list to your Radarr`
[56] doc formatting 11 months ago			`8. Sort all the collections created by this file randomly`