aboutsummaryrefslogtreecommitdiff
path: root/scripts/ytdlp_download.md
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/ytdlp_download.md')
-rw-r--r--scripts/ytdlp_download.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/scripts/ytdlp_download.md b/scripts/ytdlp_download.md
index e69de29..c9f695a 100644
--- a/scripts/ytdlp_download.md
+++ b/scripts/ytdlp_download.md
@@ -0,0 +1,30 @@
+# yt-dlp Media Downloader
+
+Downloads media with yt-dlp.
+
+Currently supported task kinds are `youtube` and `bilibili`.
+
+The output directory is the tasks `output` data attribute which must be present.
+Additional yt-dlp arguments are added based on the task's `profile` attribute.
+
+## Configuration
+
+- `ytdlp_download`
+ - `profiles`: Map from profile name to list of arguments passed to yt-dlp.
+
+Sample configuration:
+
+```yaml
+ytdlp_download:
+ profiles:
+ video:
+ - -f
+ - bestvideo+bestaudio
+ - --embed-metadata
+ - --remux=mkv
+ audio:
+ - -f
+ - bestaudio
+ - --embed-metadata
+ - --remux=mka
+```