Filters¶
Filters allow for you to filter every item added to the collection/overlay/playlist from every builder using the filters
attribute.
Using Filters¶
Filters cannot do anything alone they require the use of at least one Builder to function.
You can have multiple filters in each set but an item must match at least one value from each filter to not be ignored. The values for each must match what Plex has including special characters in order to match.
filters:
genre: Action
country: Germany
Anything that doesn’t have both the Genre Action
and the Country Germany
will be ignored.
Multiple Filter Sets can be given as a list. With multiple sets only one of the sets must pass for the item to not be ignored.
filters:
- genre: Action
country: Germany
- genre: Comedy
country: France
Anything that doesn’t have either both the Genre Action
and the Country Germany
or the Genre Comedy
and the Country France
will be ignored.
All filter options are listed below. To display items filtered out add show_filtered: true
to the definition.
You can use the plex_all: true
builder to filter from your entire library.
Filters can be very slow. Try to build or narrow your items using Plex Search or another Builder if possible.
Table Annotations¶
1 Filters using the special episodes
/tracks
filter with the default percent.
2 Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the count
modifiers.
3 You can use current_year
to have PMM use the current years value. This can be combined with a -#
at the end to subtract that number of years. i.e. current-2
4 The actual numbers are pulled from the PMM-Mediastingers Repo.
5 Also is a Tag Filter and can use all of those modifiers.
String Filters¶
String filters can be used with either no modifier or with .not
, .is
, .isnot
, .begins
, .ends
, or .regex
.
String filters can take multiple values only as a list.
Modifier¶
String Modifier |
Description |
---|---|
No Modifier |
Matches every item where the attribute contains the given string |
|
Matches every item where the attribute does not contain the given string |
|
Matches every item where the attribute exactly matches the given string |
|
Matches every item where the attribute does not exactly match the given string |
|
Matches every item where the attribute begins with the given string |
|
Matches every item where the attribute ends with the given string |
|
Matches every item where the attribute matches the regex given |
Attribute¶
String Filter |
Description |
Movies |
Shows |
Seasons |
Episodes |
Artists |
Albums |
Track |
---|---|---|---|---|---|---|---|---|
|
Uses the title attribute to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the title from TMDb to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the summary attribute to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the studio attribute to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the edition attribute to match |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the record label attribute to match |
❌ |
❌ |
❌ |
❌ |
❌ |
✅ |
❌ |
|
Uses the item’s folder to match |
❌ |
✅ |
❌ |
❌ |
✅ |
❌ |
❌ |
|
Uses the item’s filepath to match |
✅ |
✅1 |
✅1 |
✅ |
✅1 |
✅1 |
✅ |
|
Uses the audio track titles to match |
✅ |
✅1 |
✅1 |
✅ |
✅1 |
✅1 |
✅ |
|
Uses the subtitle track titles to match |
✅ |
✅1 |
✅1 |
✅ |
✅1 |
✅1 |
✅ |
|
Uses the video codec tags to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the video profile tags to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the audio codec tags to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the audio profile tags to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
Tag Filters¶
Tag filters can be used with either no modifier or with .not
.
Tag filters can take multiple values as a list or a comma-separated string.
Modifier¶
Tag Modifier |
Description |
---|---|
No Modifier |
Matches every item where the attribute matches the given string |
|
Matches every item where the attribute does not match the given string |
|
Matches every item where one value of this attribute matches the regex. |
|
Matches every item where the attribute count is less than the given number |
|
Matches every item where the attribute count is less than the given number |
|
Matches every item where the attribute count is greater than the given number |
|
Matches every item where the attribute count is greater than or equal to the given number |
Attribute¶
Tag Filters |
Description |
Movies |
Shows |
Seasons |
Episodes |
Artists |
Albums |
Track |
---|---|---|---|---|---|---|---|---|
|
Uses the actor tags to match |
✅ |
✅ |
❌ |
✅ |
❌ |
❌ |
❌ |
|
Uses the collection tags to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the content rating tags to match |
✅ |
✅ |
❌ |
✅ |
❌ |
❌ |
❌ |
|
Uses the network tags to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the country tags to match |
✅ |
❌ |
❌ |
❌ |
✅ |
❌ |
❌ |
|
Uses the director tags to match |
✅ |
❌ |
❌ |
✅ |
❌ |
❌ |
❌ |
|
Uses the genre tags to match |
✅ |
✅ |
❌ |
❌ |
✅ |
✅ |
❌ |
|
Uses the label tags to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the actor tags to match |
✅ |
❌ |
❌ |
✅ |
❌ |
❌ |
❌ |
|
Uses the year tag to match |
✅ |
✅ |
✅ |
✅ |
❌ |
✅ |
✅ |
|
Uses the writer tags to match |
✅ |
❌ |
❌ |
✅ |
❌ |
❌ |
❌ |
|
Uses the resolution tag to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the audio language tags to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the subtitle language tags to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the genres from TMDb to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the keywords from TMDb to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses TMDb origin country ISO 3166-1 alpha-2 codes to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the keywords from IMDb to match See Special for more attributes |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
Boolean Filters¶
Boolean Filters have no modifiers.
Attribute¶
Boolean Filters |
Description |
Movies |
Shows |
Seasons |
Episodes |
Artists |
Albums |
Track |
---|---|---|---|---|---|---|---|---|
|
Matches every item that has or does not have a collection |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Matches every item that has or does not have an edition |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Matches every item that has a media stinger (After/During Credits Scene) |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Matches every item that has or does not have a dolby vision |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Matches every item that has or does not have an overlay |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
❌ |
Date Filters¶
Date filters can be used with either no modifier or with .not
, .before
, .after
, or .regex
.
Date filters can NOT take multiple values.
Modifier¶
Date Modifier |
Description |
Format |
---|---|---|
No Modifier |
Matches every item where the date attribute is in the last X days |
Format: number of days |
|
Matches every item where the date attribute is not in the last X days |
Format: number of days |
|
Matches every item where the date attribute is before the given date |
Format: MM/DD/YYYY or |
|
Matches every item where the date attribute is after the given date |
Format: MM/DD/YYYY or |
|
Matches every item where the attribute matches the regex given |
N/A |
Attribute¶
Date Filters |
Description |
Movies |
Shows |
Seasons |
Episodes |
Artists |
Albums |
Track |
---|---|---|---|---|---|---|---|---|
|
Uses the release date attribute (originally available) to match |
✅ |
✅ |
❌ |
✅ |
❌ |
✅ |
❌ |
|
Uses the date added attribute to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the date last played attribute to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the first episode aired date to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the last episode aired date to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Similar to |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
Number Filters¶
Number filters must use .gt
, .gte
, .lt
, or .lte
as a modifier.
Number filters can NOT take multiple values.
Modifier¶
Number Modifier |
Description |
Format |
---|---|---|
No Modifier |
Matches every item where the number attribute is equal to the given number |
Format: number |
|
Matches every item where the number attribute is not equal to the given number |
Format: number |
|
Matches every item where the number attribute is greater than the given number |
Format: number |
|
Matches every item where the number attribute is greater than or equal to the given number |
Format: number |
|
Matches every item where the number attribute is less than the given number |
Format: number |
|
Matches every item where the number attribute is less than or equal to the given number |
Format: number |
Attribute¶
Number Filters |
Description |
Movies |
Shows |
Seasons |
Episodes |
Artists |
Albums |
Track |
---|---|---|---|---|---|---|---|---|
|
Uses the year attribute to match |
✅ |
✅ |
✅ |
✅ |
❌ |
✅ |
✅ |
Uses the year on TMDb to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
|
Uses the critic rating attribute to match |
✅ |
✅ |
❌ |
✅ |
❌ |
✅ |
❌ |
|
Uses the audience rating attribute to match |
✅ |
✅ |
❌ |
✅ |
❌ |
❌ |
❌ |
|
Uses the user rating attribute to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the tmdb vote count to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the tmdb vote average rating to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the plays attribute to match |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
✅ |
|
Uses the duration attribute to match using minutes |
✅ |
✅ |
❌ |
✅ |
❌ |
❌ |
✅ |
|
Uses the audio channels attribute to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the height attribute to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the width attribute to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the aspect attribute to match |
✅ |
✅1 |
✅1 |
✅ |
❌ |
❌ |
❌ |
|
Uses the number of versions found to match |
✅ |
✅1 |
✅1 |
✅ |
✅1 |
✅1 |
✅ |
|
Uses the media stinger rating to match. The media stinger rating is if the after/during credits scene is worth staying for. |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
❌ |
Special Filters¶
Special Filters each have their own set of rules for how they’re used.
Attribute¶
Special Filters |
Description |
Movies |
Shows |
Seasons |
Episodes |
Artists |
Albums |
Track |
---|---|---|---|---|---|---|---|---|
|
Uses the release date attribute (originally available) to match dates throughout history |
✅ |
✅ |
❌ |
✅ |
❌ |
✅ |
❌ |
|
Uses the item’s episodes attributes to match |
❌ |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
|
Uses the item’s seasons attributes to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the item’s tracks attributes to match |
❌ |
❌ |
❌ |
❌ |
✅ |
✅ |
❌ |
|
Uses the item’s albums attributes to match |
❌ |
❌ |
❌ |
❌ |
✅ |
❌ |
❌ |
Uses TMDb original language ISO 639-1 codes to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses TMDb Status to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses TMDb Type to match |
❌ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
|
Uses the keywords from IMDb to match |
✅ |
✅ |
❌ |
❌ |
❌ |
❌ |
❌ |
Collection Filter Examples¶
A few examples are listed below:
collections:
1080p Documentaries:
plex_search:
all:
genre: Documentary
summary: A collection of 1080p Documentaries
filters:
resolution: 1080
collections:
Daniel Craig only James Bonds:
imdb_list: https://www.imdb.com/list/ls006405458/
filters:
actor: Daniel Craig
collections:
French Romance:
plex_search:
all:
genre: Romance
filters:
audio_language: Français
collections:
Romantic Comedies:
plex_search:
all:
genre: Romance
filters:
genre: Comedy
collections:
9.0 Movies:
plex_all: true
filters:
rating.gte: 9
collections:
Summer 2020 Movies:
plex_all: true
filters:
release.after: 5/1/2020
release.before: 8/31/2020
collections:
Movies Released in the Last 180 Days:
plex_all: true
filters:
release: 180
collections:
Good Adam Sandler Romantic Comedies:
plex_search:
all:
genre: Romance
actor: Adam Sandler
filters:
genre: Comedy
rating.gte: 7
collections:
Movies with Commentary:
plex_all: true
filters:
audio_track_title: Commentary