nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-12-22 16:35:52 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update 44.md

Browse Source 
Updating to reference NIP-94 file metadata event
This commit is contained in:
zmeyer44 2023-12-09 12:55:25 -05:00 committed by GitHub
parent a2914eed6d
commit cec99e7b13
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
44.md
View File

@ -6,9 +6,9 @@ Video Events
`draft` `optional` `draft` `optional`
This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and deletable per [NIP-09](09.md). This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and deletable per [NIP-09](09.md). The content of a video event is the stringified JSON of a `kind 1063` File metadata event as described in [NIP-94](94.md).
Unlike a `kind 1` event with a video attached, Video Events are meant to contain all necessary metadata concerning the media and to be surfaced in media specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a YouTube like nostr client where the video itself is at the center of the experience. Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience.
## Video Events ## Video Events
@ -18,23 +18,20 @@ There are two types of video events represented by different kinds: horizontal a
The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos.
The `.content` of these events is optional and should be a summary of the video's contents. The `.content` of these events is the stringified JSON of a `kind 1063` file metadata event.
The list of tags are as follows: The list of tags are as follows:
* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. * `d` (required) universally unique identifier (UUID). Generated by the client creating the video event.
* `e` (required, repeated) reference tag to kind 1063 file metadata event being posted, optional relay information for the file metadata event, optional quality value (low|medium|high)
* `title` (required) title of the video * `title` (required) title of the video
* `url` (required) a link to the video data
* `m` (optional) the MIME type of the video data in the `src` tag
* `summary` (optional) summary/description of the video (same as content) * `summary` (optional) summary/description of the video (same as content)
* `image` (optional) url of preview image with same dimensions * `url` (optional) a default link to the video data
* `thumb` (optional) url of thumbnail with same aspect ratio
* `dim` (optional) size of file in pixels in the form <width>x<height>
* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code
* `thumb` (optional) url of thumbnail with same aspect ratio
* `content-warning` (optional) warning about content of NSFW video * `content-warning` (optional) warning about content of NSFW video
* `alt` (optional) description for accessibility
* `t` (optional, repeated) hashtag to categorize video * `t` (optional, repeated) hashtag to categorize video
* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL
* `r` (optional, repeated) references / links to web pages. * `r` (optional, repeated) references / links to web pages
```json ```json
{ {
@ -42,22 +39,19 @@ The list of tags are as follows:
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
"created_at": <Unix timestamp in seconds>, "created_at": <Unix timestamp in seconds>,
"kind": 34235 | 34236, "kind": 34235 | 34236,
"content": "<summary of video>", "content": "<stringified JSON of kind 1063 event>",
"tags": [ "tags": [
["d", "<UUID>"], ["d", "<UUID>"],
["e", "<hex-id>", "<relay-url>", "<optional quality value>"],
["title", "<title of video>"], ["title", "<title of video>"],
["summary", "<summary of video>"], ["summary", "<summary of video>"],
["thumb", "<thumbnail image for video>"], ["thumb", "<thumbnail image for video>"],
["image", "<preview image for video>"],
["alt", <description>],
// Video Data // Video Data
["url", "<url>"], ["url", "<optional recommended url>"]
["m", "<MIME type>"],
["text-track", "<url>", "<text track type>", "<optional language>"], ["text-track", "<url>", "<text track type>", "<optional language>"],
["content-warning", "<reason>"], ["content-warning", "<reason>"],
["dim", <size of video in pixels>],
// Participants // Participants
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],