1
0
mirror of https://codeberg.org/polarisfm/youtube-dl synced 2024-11-26 18:34:32 +01:00

Update internal documentation to reflect the new behaviour

This commit is contained in:
Ricardo Garcia 2009-04-23 22:34:58 +02:00
parent 6f21f68629
commit 2851b2ca18

View File

@ -65,9 +65,10 @@ class FileDownloader(object):
For this, file downloader objects have a method that allows For this, file downloader objects have a method that allows
InfoExtractors to be registered in a given order. When it is passed InfoExtractors to be registered in a given order. When it is passed
a URL, the file downloader handles it to the first InfoExtractor it a URL, the file downloader handles it to the first InfoExtractor it
finds that reports being able to handle it. The InfoExtractor returns finds that reports being able to handle it. The InfoExtractor extracts
all the information to the FileDownloader and the latter downloads the all the information about the video or videos the URL refers to, and
file or does whatever it's instructed to do. asks the FileDownloader to process the video information, possibly
downloading the video.
File downloaders accept a lot of parameters. In order not to saturate File downloaders accept a lot of parameters. In order not to saturate
the object constructor with arguments, it receives a dictionary of the object constructor with arguments, it receives a dictionary of
@ -360,9 +361,10 @@ class InfoExtractor(object):
Information extractors are the classes that, given a URL, extract Information extractors are the classes that, given a URL, extract
information from the video (or videos) the URL refers to. This information from the video (or videos) the URL refers to. This
information includes the real video URL, the video title and simplified information includes the real video URL, the video title and simplified
title, author and others. It is returned in a list of dictionaries when title, author and others. The information is stored in a dictionary
calling its extract() method. It is a list because a URL can refer to which is then passed to the FileDownloader. The FileDownloader
more than one video (think of playlists). The dictionaries must include processes this information possibly downloading the video to the file
system, among other possible outcomes. The dictionaries must include
the following fields: the following fields:
id: Video identifier. id: Video identifier.