diff options
| author | Sergey M․ <dstftw@gmail.com> | 2015-12-31 03:10:44 +0600 |
|---|---|---|
| committer | Sergey M․ <dstftw@gmail.com> | 2015-12-31 03:10:44 +0600 |
| commit | 7109903e6140e01b5d5980fc80c6ef1b6c86797a (patch) | |
| tree | f1a2c56df01b6228dc5c8bfd0362f753fca97b25 | |
| parent | 3092fc4035dd3a0841a92227e9bd80b7b9e4d871 (diff) | |
[extractor/common] Document chapter and series fields
| -rw-r--r-- | youtube_dl/extractor/common.py | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/youtube_dl/extractor/common.py b/youtube_dl/extractor/common.py index 655207447..c443daf20 100644 --- a/youtube_dl/extractor/common.py +++ b/youtube_dl/extractor/common.py @@ -200,6 +200,26 @@ class InfoExtractor(object): end_time: Time in seconds where the reproduction should end, as specified in the URL. + The following fields should only be used when the video belongs to some logical + chapter or section: + + chapter: Name or title of the chapter the video belongs to. + chapter_id: Number or id of the chapter the video belongs to, as an integer + or unicode string. + + The following fields should only be used when the video is an episode of some + series or programme: + + series: Title of the series or programme the video episode belongs to. + season: Title of the season the video episode belongs to. + season_id: Number or id of the season the video episode belongs to, as an + integer or unicode string. + episode: Title of the video episode. Unlike mandatory video title field, + this field should denote the exact title of the video episode + without any kind of decoration. + episode_id: Number or id of the video episode within a season, as an integer + or unicode string. + Unless mentioned otherwise, the fields should be Unicode strings. Unless mentioned otherwise, None is equivalent to absence of information. |