aboutsummaryrefslogtreecommitdiff
path: root/scripts/ytdlp_flatten.md
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/ytdlp_flatten.md')
-rw-r--r--scripts/ytdlp_flatten.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/scripts/ytdlp_flatten.md b/scripts/ytdlp_flatten.md
index e69de29..97ffb39 100644
--- a/scripts/ytdlp_flatten.md
+++ b/scripts/ytdlp_flatten.md
@@ -0,0 +1,22 @@
+# yt-dlp Playlist Flattener
+
+Transforms a playlist-like object into the media items that make it up.
+
+Currently supported task kinds are `youtube-channel` and `bilibili-channel`.
+Where task ids are the ids assigned by the respective platform.
+
+## Configuration
+
+- `ytdlp_flatten`
+ - `filters`: Map from flag to filter. Flags are taken from the `flag`
+ attribute in task data. Filters are passed straight to yt-dlp's
+ `--match-filter` flag.
+
+Sample configuration:
+
+```yaml
+ytdlp_flatten:
+ filters:
+ notlive: live_status=not_live
+ short: duration<300
+```