From c31be5b009f0565f8fcea6037e9f51e4245b6c7d Mon Sep 17 00:00:00 2001 From: pukkandan Date: Tue, 3 Aug 2021 01:33:51 +0530 Subject: [PATCH] [docs] Document which fields `--add-metadata` adds to the file :ci skip all --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 667e728bf..7fb2c0874 100644 --- a/README.md +++ b/README.md @@ -1328,8 +1328,30 @@ The metadata obtained the the extractors can be modified by using `--parse-metad Note that any field created by this can be used in the [output template](#output-template) and will also affect the media file's metadata added when using `--add-metadata`. This option also has a few special uses: -* You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a `meta_` prefix. For example, any value you set to `meta_description` field will be added to the `description` field in the file. You can use this to set a different "description" and "synopsis", for example * You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field `additional_urls` to the URL that you want to download. Eg: `--parse-metadata "description:(?Phttps?://www\.vimeo\.com/\d+)` will download the first vimeo video found in the description +* You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a `meta_` prefix. For example, any value you set to `meta_description` field will be added to the `description` field in the file. For example, you can use this to set a different "description" and "synopsis" + +For reference, these are the fields yt-dlp adds by default to the file metadata: + +Metadata fields|From +:---|:--- +`title`|`track` or `title` +`date`|`upload_date` +`description`, `synopsis`|`description` +`purl`, `comment`|`webpage_url` +`track`|`track_number` +`artist`|`artist`, `creator`, `uploader` or `uploader_id` +`genre`|`genre` +`album`|`album` +`album_artist`|`album_artist` +`disc`|`disc_number` +`show`|`series` +`season_number`|`season_number` +`episode_id`|`episode` or `episode_id` +`episode_sort`|`episode_number` +`language` of each stream|From the format's `language` +**Note**: The file format may not support some of these fields + ## Modifying metadata examples