5
Setting Details
meisnate12 edited this page 2 years ago
All the following attributes serve various functions as how the collection/playlist functions inside of Plex Meta Manager.
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|---|---|---|---|---|
| Collection/Playlist Name | name |
Used to specify the name off the collection/playlist in Plex as different then the mapping name. | Any String | ✔️ |
| Template | template |
Used to specify a template and template variables to use for this collection/playlist. | template mapping details |
✔️ |
| Run Again | run_again |
Used to try and add all the missing items to the collection/playlist again after the daily run Default Mode: false |
boolean: true or false |
✔️ |
| Sync Mode | sync_mode |
Used to change how builders sync with this collection/playlist Default Mode: settings library value |
append: Only Add Items to the Collectionsync: Add & Remove Items from the Collection |
✔️ |
| Minimum Items | minimum_items |
Minimum items that must be found to add to a collection/playlist. Default: settings library value |
number greater then 0 | ✔️ |
| Delete Below Minimum | delete_below_minimum |
Deletes the collection/playlist if below the minimum. Default: settings library value |
boolean: true or false |
✔️ |
| Delete Not Scheduled | delete_not_scheduled |
Deletes the collection/playlist if its skipped because its not scheduled. Default: settings library value |
boolean: true or false |
✔️ |
| Validate Builders | validate_builders |
When set to false the collection/playlist will not fail if one builder fails Default Mode: true |
boolean: true or false |
✔️ |
| Build Collection | build_collection |
When set to false the collection won't be created but items can still be added to Radarr/Sonarr Default Mode: true |
boolean: true or false |
❌ |
| Server Pre-Roll | server_preroll |
Used to set the Movie pre-roll video Text box in Plex under Settings -> Extras |
Any String | ✔️ |
| Missing Only Released | missing_only_released |
Collection/Playlist Level missing_only_released toggleDefault: settings library value |
boolean: true or false |
|
| Only Filter Missing | only_filter_missing |
Collection/Playlist Level only_filter_missing toggleDefault: settings library value |
boolean: true or false |
✔️ |
| Show Filtered Items | show_filtered |
Collection/Playlist level show_filtered toggleDefault: settings library value |
boolean: true or false |
✔️ |
| Show Missing Items | show_missing |
Collection/Playlist level show_missing toggleDefault: settings library value |
boolean: true or false |
✔️ |
| Save Missing Items | save_missing |
Collection/Playlist level save_missing toggleDefault: settings library value |
boolean: true or false |
✔️ |
| Ignore IDs | ignore_ids |
Collection/Playlist level ignore_ids which is combined with the library and global ignore_idsDefault: settings library value |
List or comma-separated String of TMDb/TVDb IDs | ✔️ |
| Ignore IMDb IDs | ignore_imdb_ids |
Collection/Playlist level ignore_imdb_ids which is combined with the library and global ignore_imdb_idsDefault: settings library value |
List or comma-separated String of IMDb IDs | ✔️ |
| Name Mapping | name_mapping |
Used to specify the folder name in the Image Assets Directory | Folder Name In Assets Directory | ✔️ |
| Test Mode | test |
When running in Test Mode (--run-tests option) only collections/playlists with test: true will be runDefault: false |
boolean: true or false |
✔️ |
| Changes Webhooks | changes_webhooks |
Used to specify a collection/playlist changes webhook for just this collection/playlist. | List of webhooks | ✔️ |
- Name Mapping: If your collection/playlist name contains characters that are not allowed in file paths (i.e. for windows
<,>,:,",/,\,|,?,*cannot be in the file path), but you want them in your collection name you can use thename_mappingattribute to specific this collection's name in the file system. - Server Pre-Roll: You can run this with a schedule to change the pre-rolls automatically.