Plex Prerolls

Plex Prerolls configuration

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/plex-prerolls/latest.json
Source https://raw.githubusercontent.com/nwithan8/plex-prerolls/main/.schema/config.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

plex object required

Settings for the Plex server

2 nested properties
url string required
pattern=^(https?://)?[a-zA-Z0-9.-]+(:[0-9]{1,5})?$
token string required
advanced object required

Advanced configuration options

1 nested properties
auto_generation object

Settings for auto-generating prerolls

2 nested properties
plex_path string required

The path for the Plex Media Server to use to access auto-generated prerolls

recently_added object required

Settings for auto-generating prerolls from recently added media

3 nested properties
enabled boolean required

Whether the feature is enabled

count integer required
min=1
trailer_cutoff_year integer
min=1
run object

Settings for running the application

2 nested properties
schedule string

Cron expression in the format: minute hour day month weekday

pattern=^([0-5]?\d) ([01]?\d|2[0-3]) ([1-9]|[12]\d|3[01]) ([1-9]|1[012]) ([0-6])$
dry_run boolean

Whether to run in dry run mode (don't actually make changes to Plex)

Default: false
always object

Configuration for always-included prerolls

5 nested properties
enabled boolean required

Whether the feature is enabled

paths videoFilePath[]
path_globbing object

Settings for path globbing

2 nested properties
enabled boolean

Whether the feature is enabled

pairs object[]

The pairs of paths to match and replace

weight positiveInteger

The weight of the preroll for this range

count integer
min=1
date_range object

Configuration for date range-based prerolls

2 nested properties
enabled boolean required

Whether the feature is enabled

ranges object[] required

Date ranges for which to include prerolls

weekly object

Configuration for weekly-based prerolls

2 nested properties
enabled boolean required

Whether the feature is enabled

weeks object[] required

Configuration for weekly-based prerolls

monthly object

Configuration for monthly-based prerolls

2 nested properties
enabled boolean required

Whether the feature is enabled

months object[] required

Configuration for monthly-based prerolls

Definitions

date string
cron string

Cron expression in the format: minute hour day month weekday

positiveInteger integer
emptyString string
emptyableString emptyString | string
hostWithIpAndOptionalPort string
plexToken string
weekNumber integer

The week of the year number

monthNumber integer
enabled boolean

Whether the feature is enabled

countryCode string
startDate string
endDate string
holiday object

Configuration for the floating holiday

name string required

Case-insensitive name of the holiday. Will be used to look up the date

country string required
pattern=^[A-Z]{2}$
subdivision string

Optional subdivision code to use for looking up the holiday date (e.g., state or province)

offset_start integer

Number of days to offset the start date by (can be negative)

Default: 0
offset_end integer

Number of days to offset the end date by (can be negative)

Default: 0
disableAlways boolean

Whether to disable always prerolls when this schedule is active

weight integer
videoFilePath string

A path to a media file

paths videoFilePath[]
globPattern string

A glob pattern to match files

pathGlobbing object

Settings for path globbing

enabled boolean

Whether the feature is enabled

pairs object[]

The pairs of paths to match and replace