Streaming Collections¶
The streaming
Default Metadata File is used to dynamically create collections based on the streaming Services that your media is available on.
Requirements & Recommendations¶
Supported Library Types: Movie, Show
Collections Section 030¶
Collection |
Key |
Description |
---|---|---|
|
|
Separator Collection to denote the Section of Collections. |
|
|
Collection of Movies/Shows Streaming on All 4. |
|
|
Collection of Movies/Shows Streaming on Apple TV+. |
|
|
Collection of Movies/Shows Streaming on BET+. |
|
|
Collection of Movies/Shows Streaming on BritBox. |
|
|
Collection of Movies/Shows Streaming on Crave. |
|
|
Collection of Shows Streaming on Crunchyroll. |
|
|
Collection of Shows Streaming on discovery+. |
|
|
Collection of Movies/Shows Streaming on Disney+. |
|
|
Collection of Shows Streaming on hayu. |
|
|
Collection of Movies/Shows Streaming on Max. |
|
|
Collection of Movies/Shows Streaming on Hulu. |
|
|
Collection of Movies/Shows Streaming on Netflix. |
|
|
Collection of Movies/Shows Streaming on NOW. |
|
|
Collection of Movies/Shows Streaming on Paramount+. |
|
|
Collection of Movies/Shows Streaming on Peacock. |
|
|
Collection of Movies/Shows Streaming on Prime Video. |
|
|
Collection of Movies/Shows Streaming on Showtime. |
Config¶
The below YAML in your config.yml will create the collections:
libraries:
Movies:
metadata_path:
- pmm: streaming
TV Shows:
metadata_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 Collection Variables are available as well as the additional Variables below which can be used to customize the file.
This file contains a Separator so all Shared Separator Variables are available as well.
Variable |
Description & Values |
||||
---|---|---|---|---|---|
|
Description: Changes the Builder Limit for all collections in a Defaults file. |
||||
|
Description: Changes the Builder Limit of the specified key’s collection. |
||||
|
Description: Changes the Smart Filter Sort for all collections in a Defaults file. |
||||
|
Description: Changes the Smart Filter Sort of the specified key’s collection. |
||||
|
Description: Changes the Sync Mode for all collections in a Defaults file.
|
||||
|
Description: Changes the Sync Mode of the specified key’s collection.
|
||||
|
Description: Exclude these Streaming Services from creating a Dynamic Collection. |
||||
|
Description: Changes some Streaming Service lists to regional variants (see below table for more information. |
||||
|
Description: Changes Streaming Service lists to only show original content produced by the service. |
||||
|
Description: Changes the title format of the Dynamic Collections. |
||||
|
Description: Changes the summary format of the Dynamic Collections. |
Each default collection has a
key
that when calling to effect a specific collection 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 collections will use regional variant lists to ensure the lists populate with what is available in the region specified |
any besides |
|
These collections will not be created if the region is not |
any besides |
|
These collections will not be created if the region is not |
|
|
These collections will not be created 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:
metadata_path:
- pmm: streaming
template_variables:
region: fr
use_separator: false
sep_style: stb
visible_library_disney: true
visible_home_disney: true
visible_shared_disney: true
sonarr_add_missing_hulu: true
radarr_add_missing_amazon: true
sort_by: random