Skip to content

Commit

Permalink
[docs] Improve docstring of download_ranges (yt-dlp#4340)
Browse files Browse the repository at this point in the history
Authored by: FirefoxMetzger
  • Loading branch information
FirefoxMetzger authored Jul 12, 2022
1 parent 7a7eeb1 commit 0f44636
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions yt_dlp/YoutubeDL.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down

0 comments on commit 0f44636

Please sign in to comment.