Plugins#
audio_extract#
Extracts audio from a video file.
- Usage:
audio_extract:
codec: "mp3"
quality: 128
codec
- expected type:
String
- description:
The codec to output after extracting the audio. Supported codecs are aac, flac, mp3, m4a, opus, vorbis, wav, and best to grab the best possible format at runtime.
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
quality
- expected type:
Float
- description:
Optional. Specify ffmpeg audio quality. Insert a value between
0
(better) and9
(worse) for variable bitrate, or a specific bitrate like128
for 128k.
chapters#
Embeds chapters to video files if they are present. Additional options to add SponsorBlock chapters and remove specific ones. Can also remove chapters using regex.
- Usage:
chapters:
# Embedded Chapter Fields
embed_chapters: True
allow_chapters_from_comments: False
remove_chapters_regex:
- "Intro"
- "Outro"
# Sponsorblock Fields
sponsorblock_categories:
- "outro"
- "selfpromo"
- "preview"
- "interaction"
- "sponsor"
- "music_offtopic"
- "intro"
remove_sponsorblock_categories: "all"
force_key_frames: False
allow_chapters_from_comments
- expected type:
Optional[Boolean]
- description:
Defaults to False. If chapters do not exist in the video/description itself, attempt to scrape comments to find the chapters.
embed_chapters
- expected type:
Optional[Boolean]
- description:
Defaults to True. Embed chapters into the file.
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
force_key_frames
- expected type:
Optional[Boolean]
- description:
Defaults to False. Force keyframes at cuts when removing sections. This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts.
remove_chapters_regex
- expected type:
Optional[List[RegexString]
- description:
List of regex patterns to match chapter titles against and remove them from the entry.
remove_sponsorblock_categories
- expected type:
Optional[List[String]]
- description:
List of SponsorBlock categories to remove from the output file. Can only remove categories that are specified in
sponsorblock_categories
or “all”, which removes everything specified insponsorblock_categories
.
sponsorblock_categories
- expected type:
Optional[List[String]]
- description:
List of SponsorBlock categories to embed as chapters. Supports “sponsor”, “intro”, “outro”, “selfpromo”, “preview”, “filler”, “interaction”, “music_offtopic”, “poi_highlight”, or “all” to include all categories.
date_range#
Only download files uploaded within the specified date range. Dates must adhere to a yt-dlp datetime. From their docs:
A string in the format YYYYMMDD or
(now|today|yesterday|date)[+-][0-9](microsecond|second|minute|hour|day|week|month|year)(s)
Valid examples are now-2weeks
or 20200101
. Can use override variables in this.
Note that yt-dlp will round times to the closest day, meaning that day is the lowest
granularity possible.
- Usage:
date_range:
before: "now"
after: "today-2weeks"
after
- expected type:
Optional[OverridesFormatter]
- description:
Only download videos after this datetime.
before
- expected type:
Optional[OverridesFormatter]
- description:
Only download videos before this datetime.
breaks
- expected type:
Optional[OverridesFormatter]
- description:
Toggle to enable breaking subsequent metadata downloads if an entry’s upload date is out of range. Defaults to True.
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
download#
Sets the URL(s) to download from. Can be used in many forms, including
- Single URL:
download: "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
- Multi URL:
download:
- "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
- "https://www.youtube.com/watch?v=3BFTio5296w"
- Thumbnails + Variables:
All variables must be defined for the top-most url. All subsequent URL variables can be either overwritten or default to the top-most value.
If an entry is returned from more than one URL, it will use the variables in the bottom-most URL.
download:
# required
urls:
- url: "youtube.com/channel/UCsvn_Po0SmunchJYtttWpOxMg"
variables:
season_index: "1"
season_name: "Uploads"
playlist_thumbnails:
- name: "poster.jpg"
uid: "avatar_uncropped"
- name: "fanart.jpg"
uid: "banner_uncropped"
- name: "season{season_index}-poster.jpg"
uid: "latest_entry"
- url: "https://www.youtube.com/playlist?list=UCsvn_Po0SmunchJYtttWpOxMg"
variables:
season_index: "2"
season_name: "Playlist as Season"
ytdl_options:
break_on_existing: False
playlist_thumbnails:
- name: "season{season_index}-poster.jpg"
uid: "latest_entry"
embed_thumbnail#
Whether to embed thumbnails to the audio/video file or not.
- Usage:
embed_thumbnail: True
file_convert#
Converts video files from one extension to another.
- Usage:
file_convert:
convert_to: "mp4"
Also supports custom ffmpeg conversions:
- Usage:
file_convert:
convert_to: "mkv"
convert_with: "ffmpeg"
ffmpeg_post_process_args: >
-bitexact
-vcodec copy
-acodec copy
-scodec mov_text
convert_to
- expected type:
String
- description:
Convert to a desired file type. Supports
Video: avi, flv, mkv, mov, mp4, webm
Audio: aac, flac, mp3, m4a, opus, vorbis, wav
convert_with
- expected type:
Optional[String]
- description:
Supports
yt-dlp
andffmpeg
.yt-dlp
will convert files within yt-dlp whereasffmpeg
specifies it will be converted using a custom command specified withffmpeg_post_process_args
. Defaults toyt-dlp
.
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
ffmpeg_post_process_args
- expected type:
Optional[OverridesFormatter]
- description:
ffmpeg args to post-process an entry file with. The args will be inserted in the form of
ffmpeg -i input_file.ext {ffmpeg_post_process_args) output_file.output_ext
.The output file will use the extension specified in
convert_to
. Post-processing args can still be set withconvert_with
set toyt-dlp
.
filter_exclude#
Applies a conditional OR on any number of filters comprised of either variables or scripts. If any filter evaluates to True, the entry will be excluded.
- Usage:
filter_exclude:
- >-
{ %contains( %lower(title), '#short' ) }
- >-
{ %contains( %lower(description), '#short' ) }
filter_include#
Applies a conditional AND on any number of filters comprised of either variables or scripts. If all filters evaluate to True, the entry will be included.
- Usage:
filter_include:
- >-
{description}
- >-
{
%regex_search_any(
title,
[
"Full Episode",
"FULL",
]
)
}
format#
Set --format
to pass into yt-dlp to download a specific format quality.
Uses the same syntax as yt-dlp.
Usage:
format: "(bv*[height<=1080]+bestaudio/best[height<=1080])"
match_filters#
Set --match-filters
to pass into yt-dlp to filter entries from being downloaded.
Uses the same syntax as yt-dlp. An entry will be downloaded if any one of the filters are met.
For logical AND’s between match filters, use the &
operator in a single match filter.
- Usage:
match_filters:
filters:
- "age_limit<?18 & like_count>?100"
# Other common match-filters
# - "original_url!*=/shorts/ & !is_live"
# - "availability=?public"
output_options#
Defines where to output files and thumbnails after all post-processing has completed.
- Usage:
presets:
my_example_preset:
output_options:
# required
output_directory: "/path/to/videos_or_music"
file_name: "{title_sanitized}.{ext}"
# optional
thumbnail_name: "{title_sanitized}.{thumbnail_ext}"
info_json_name: "{title_sanitized}.{info_json_ext}"
download_archive_name: ".ytdl-sub-{subscription_name}-download-archive.json"
migrated_download_archive_name: ".ytdl-sub-{subscription_name_sanitized}-download-archive.json"
maintain_download_archive: True
keep_files_before: now
keep_files_after: 19000101
download_archive_name
- expected type:
Optional[OverridesFormatter]
- description:
The file name to store a subscriptions download archive placed relative to the output directory. Defaults to
.ytdl-sub-{subscription_name}-download-archive.json
file_name
- expected type:
EntryFormatter
- description:
The file name for the media file. This can include directories such as
"Season {upload_year}/{title}.{ext}"
, and will be placed in the output directory.
info_json_name
- expected type:
Optional[EntryFormatter]
- description:
The file name for the media’s info json file. This can include directories such as
"Season {upload_year}/{title}.{info_json_ext}"
, and will be placed in the output directory. Can be set to empty string or null to disable info json writes.
keep_files_after
- expected type:
Optional[OverridesFormatter]
- description:
Requires
maintain_download_archive
set to True. Uses the same syntax as thedate_range
plugin.Only keeps files that are uploaded after this datetime. By default, ytdl-sub will keep files after
19000101
, which implies all files. Can be used in conjunction withkeep_max_files
.
keep_files_before
- expected type:
Optional[OverridesFormatter]
- description:
Requires
maintain_download_archive
set to True. Uses the same syntax as thedate_range
plugin.Only keeps files that are uploaded before this datetime. By default, ytdl-sub will keep files before
now
, which implies all files. Can be used in conjunction withkeep_max_files
.
keep_max_files
- expected type:
Optional[OverridesFormatter]
- description:
Requires
maintain_download_archive
set to True.Only keeps N most recently uploaded videos. If set to <= 0,
keep_max_files
will not be applied. Can be used in conjunction withkeep_files_before
andkeep_files_after
.
maintain_download_archive
- expected type:
Optional[Boolean]
- description:
Maintains a download archive file in the output directory for a subscription. It is named
.ytdl-sub-{subscription_name}-download-archive.json
, stored in the output directory.The download archive contains a mapping of ytdl IDs to downloaded files. This is used to create a ytdl download-archive file when invoking a download on a subscription. This will prevent ytdl from redownloading media already downloaded.
Defaults to False.
migrated_download_archive_name
- expected type:
Optional[OverridesFormatter]
- description:
Intended to be used if you are migrating a subscription with either a new subscription name or output directory. It will try to load the archive file using this name first, and fallback to
download_archive_name
. It will always save to this file and remove the originaldownload_archive_name
.
output_directory
- expected type:
OverridesFormatter
- description:
The output directory to store all media files downloaded.
thumbnail_name
- expected type:
Optional[EntryFormatter]
- description:
The file name for the media’s thumbnail image. This can include directories such as
"Season {upload_year}/{title}.{thumbnail_ext}"
, and will be placed in the output directory. Can be set to empty string or null to disable thumbnail writes.
overrides#
Allows you to define variables that can be used in any EntryFormatter or OverridesFormatter.
- Usage:
presets:
my_example_preset:
overrides:
output_directory: "/path/to/media"
custom_file_name: "{upload_date_standardized}.{title_sanitized}"
# Then use the override variables in the output options
output_options:
output_directory: "{output_directory}"
file_name: "{custom_file_name}.{ext}"
thumbnail_name: "{custom_file_name}.{thumbnail_ext}"
Override variables can contain explicit values and other variables, including both override and source variables.
In addition, any override variable defined will automatically create a sanitized
variable
for use. In the example above, output_directory_sanitized
will exist and perform
sanitization on the value when used.
regex#
Attention
This plugin will eventually be deprecated and replaced by scripting functions. You can replicate the example below using the following.
# Only includes videos with 'Official Video'
filter_include:
- >-
{ %contains( %lower(title), "official video" ) }
# Excludes videos with '#short' in its description
filter_exclude:
- >-
{ %contains( %lower(description), '#short' ) }
# Creates a capture array with defaults, and assigns
# each capture group to its own variable
overrides:
description_date_capture: >-
{
%regex_capture_many_with_defaults(
description,
[ "([0-9]{4})-([0-9]{2})-([0-9]{2})" ],
[ upload_year, upload_month, upload_day ]
)
}
captured_upload_year: >-
{ %array_at(description_date_capture, 1) }
captured_upload_month: >-
{ %array_at(description_date_capture, 2) }
captured_upload_day: >-
{ %array_at(description_date_capture, 3) }
Performs regex matching on an entry’s source or override variables. Regex can be used to filter entries from proceeding with download or capture groups to create new source variables.
NOTE that YAML differentiates between single-quote ('
) and double-quote ("
), which can
affect regex. Double-quote implies string literals, i.e. "\n"
is the literal chars \n
,
whereas single-quote, '\n'
gets evaluated to a new line. To escape \
when using
single-quote, use \\
. This is necessary if you want your regex to be something like
\d\n
to match a number and adjacent new-line. It must be written as \\d\n
.
If you want to regex-search multiple source variables to create a logical OR effect, you can
create an override variable that contains the concatenation of them, and search that with regex.
For example, creating the override variable "title_and_description": "{title} {description}"
and using title_and_description
can regex match/exclude from either title
or
description
.
- Usage:
regex:
# By default, if any match fails and has no defaults, the entry will
# be skipped. If False, ytdl-sub will error and stop all downloads
# from proceeding.
skip_if_match_fails: True
from:
# For each entry's `title` value...
title:
# Perform this regex match on it to act as a filter.
# This will only download videos with "[Official Video]" in it. Note that we
# double backslash to make YAML happy
match:
- '\\[Official Video\\]'
# For each entry's `description` value...
description:
# Match with capture groups and defaults.
# This tries to scrape a date from the description and produce new
# source variables
match:
- '([0-9]{4})-([0-9]{2})-([0-9]{2})'
# Exclude any entry where the description contains #short
exclude:
- '#short'
# Each capture group creates these new source variables, respectively,
# as well a sanitized version, i.e. `captured_upload_year_sanitized`
capture_group_names:
- "captured_upload_year"
- "captured_upload_month"
- "captured_upload_day"
# And if the string does not match, use these as respective default
# values for the new source variables.
capture_group_defaults:
- "{upload_year}"
- "{upload_month}"
- "{upload_day}"
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
skip_if_match_fails
- expected type:
Optional[Boolean]
- description:
Defaults to True. If True, when any match fails and has no defaults, the entry will be skipped. If False, ytdl-sub will error and all downloads will not proceed.
split_by_chapters#
Splits a file by chapters into multiple files. Each file becomes its own entry with the new variables
chapter_title
chapter_index
chapter_index_padded
chapter_count
Note that when using this plugin and performing dry-run, it assumes embedded chapters are being used with no modifications.
- Usage:
split_by_chapters:
when_no_chapters: "pass"
when_no_chapters
- expected type:
String
- description:
Behavior to perform when no chapters are present. Supports
“pass” (continue processing),
“drop” (exclude it from output)
“error” (stop processing for everything).
If a file has no chapters and is set to “pass”, then
chapter_title
is set to the entry’s title andchapter_index
,chapter_count
are both set to 1.
subtitles#
Defines how to download and store subtitles. Using this plugin creates two new variables:
lang
and subtitles_ext
. lang
is dynamic since you can download multiple subtitles.
It will set the respective language to the correct subtitle file.
- Usage:
subtitles:
subtitles_name: "{title_sanitized}.{lang}.{subtitles_ext}"
subtitles_type: "srt"
embed_subtitles: False
languages:
- "en" # supports multiple languages
- "de"
allow_auto_generated_subtitles: False
allow_auto_generated_subtitles
- expected type:
Optional[Boolean]
- description:
Defaults to False. Whether to allow auto generated subtitles.
embed_subtitles
- expected type:
Optional[Boolean]
- description:
Defaults to False. Whether to embed the subtitles into the video file. Note that webm files can only embed “vtt” subtitle types.
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
languages
- expected type:
Optional[List[String]]
- description:
Language code(s) to download for subtitles. Supports a single or list of multiple language codes. Defaults to only “en”.
subtitles_name
- expected type:
Optional[EntryFormatter]
- description:
The file name for the media’s subtitles if they are present. This can include directories such as
"Season {upload_year}/{title_sanitized}.{lang}.{subtitles_ext}"
, and will be placed in the output directory.lang
is dynamic since you can download multiple subtitles. It will set the respective language to the correct subtitle file.
subtitles_type
- expected type:
Optional[String]
- description:
Defaults to “srt”. One of the subtitle file types “srt”, “vtt”, “ass”, “lrc”.
throttle_protection#
Provides options to make ytdl-sub look more ‘human-like’ to protect from throttling. For range-based values, a random number will be chosen within the range to avoid sleeps looking scripted.
- Usage:
presets:
my_example_preset:
throttle_protection:
sleep_per_download_s:
min: 2.2
max: 10.8
sleep_per_subscription_s:
min: 9.0
max: 14.1
max_downloads_per_subscription:
min: 10
max: 36
subscription_download_probability: 1.0
enable
- expected type:
Optional[OverridesFormatter]
- description:
Can typically be left undefined to always default to enable. For preset convenience, this field can be set using an override variable to easily toggle whether this plugin is enabled or not via Boolean.
max_downloads_per_subscription
- expected type:
Optional[Range]
- description:
Number of downloads to perform per subscription.
sleep_per_download_s
- expected type:
Optional[Range]
- description:
Number in seconds to sleep between each download. Does not include time it takes for ytdl-sub to perform post-processing.
sleep_per_subscription_s
- expected type:
Optional[Range]
- description:
Number in seconds to sleep between each subscription.
subscription_download_probability
- expected type:
Optional[Float]
- description:
Probability to perform any downloads, recomputed for each subscription. This is only recommended to set if you run ytdl-sub in a cron-job, that way you are statistically guaranteed over time to eventually download the subscription.
ytdl_options#
Allows you to add any ytdl argument to ytdl-sub’s downloader. The argument names can differ slightly from the command-line argument names. See this docstring for more details.
- Usage:
presets:
my_example_preset:
ytdl_options:
# Ignore any download related errors and continue
ignoreerrors: True
# Stop downloading additional metadata/videos if it
# exists in your download archive
break_on_existing: True
# Path to your YouTube cookies file to download 18+ restricted content
cookiefile: "/path/to/cookies/file.txt"
# Only download this number of videos/audio
max_downloads: 10
# Download and use English title/description/etc YouTube metadata
extractor_args:
youtube:
lang:
- "en"
where each key is a ytdl argument. Include in the example are some popular ytdl_options.