From 0f44636597636cfa9065ee2fa4b7308b203c6a8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Wallk=C3=B6tter?= Date: Tue, 12 Jul 2022 15:51:41 +0200 Subject: [PATCH] [docs] Improve docstring of `download_ranges` (#4340) Authored by: FirefoxMetzger --- yt_dlp/YoutubeDL.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/yt_dlp/YoutubeDL.py b/yt_dlp/YoutubeDL.py index e812f4775..a52e8b668 100644 --- a/yt_dlp/YoutubeDL.py +++ b/yt_dlp/YoutubeDL.py @@ -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):