]> jfr.im git - yt-dlp.git/commitdiff
[docs] Improve docstring of `download_ranges` (#4340)
authorSebastian Wallkötter <redacted>
Tue, 12 Jul 2022 13:51:41 +0000 (15:51 +0200)
committerGitHub <redacted>
Tue, 12 Jul 2022 13:51:41 +0000 (19:21 +0530)
Authored by: FirefoxMetzger

yt_dlp/YoutubeDL.py

index e812f47750efa41118d138f993651e99074394eb..a52e8b6688ac1c8d0e2f61664815fbfa7bc1ad93 100644 (file)
@@ -430,13 +430,15 @@ class YoutubeDL:
     retry_sleep_functions: Dictionary of functions that takes the number of attempts
                        as argument and returns the time to sleep in seconds.
                        Allowed keys are 'http', 'fragment', 'file_access'
-    download_ranges:   A function that gets called for every video with the signature
-                       (info_dict, *, ydl) -> Iterable[Section].
-                       Only the returned sections will be downloaded. Each Section contains:
+    download_ranges:   A callback function that gets called for every video with
+                       the signature (info_dict, ydl) -> Iterable[Section].
+                       Only the returned sections will be downloaded.
+                       Each Section is a dict with the following keys:
                        * start_time: Start time of the section in seconds
                        * end_time: End time of the section in seconds
                        * title: Section title (Optional)
                        * index: Section number (Optional)
+    force_keyframes_at_cuts: Re-encode the video when downloading ranges to get precise cuts
 
     The following parameters are not used by YoutubeDL itself, they are used by
     the downloader (see yt_dlp/downloader/common.py):