Mirrors
/
yt-dlp
mirror of https://github.com/yt-dlp/yt-dlp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[docs] Improve docstring of `download_ranges` (#4340) 

Authored by: FirefoxMetzger
This commit is contained in:
Sebastian Wallkötter 2022-07-12 15:51:41 +02:00 committed by GitHub
parent 7a7eeb1005
commit 0f44636597
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
yt_dlp/YoutubeDL.py
View File

@ -430,13 +430,15 @@ class YoutubeDL:
retry_sleep_functions: Dictionary of functions that takes the number of attempts retry_sleep_functions: Dictionary of functions that takes the number of attempts
as argument and returns the time to sleep in seconds. as argument and returns the time to sleep in seconds.
Allowed keys are 'http', 'fragment', 'file_access' Allowed keys are 'http', 'fragment', 'file_access'
download_ranges: A function that gets called for every video with the signature download_ranges: A callback function that gets called for every video with
(info_dict, *, ydl) -> Iterable[Section]. the signature (info_dict, ydl) -> Iterable[Section].
Only the returned sections will be downloaded. Each Section contains: 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 * start_time: Start time of the section in seconds
* end_time: End time of the section in seconds * end_time: End time of the section in seconds
* title: Section title (Optional) * title: Section title (Optional)
* index: Section number (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 following parameters are not used by YoutubeDL itself, they are used by
the downloader (see yt_dlp/downloader/common.py): the downloader (see yt_dlp/downloader/common.py):