nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-09-19 22:35:50 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update 44.md

Browse Source 
Adding some of Vitor's suggestions, differentiating between horizontal and vertical video kinds, changing how views are kept track of, and changing some tag names.
This commit is contained in:
zmeyer44 2023-12-08 09:06:14 -05:00 committed by GitHub
parent 01035dadf4
commit a2914eed6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
44.md
View File

@ -12,21 +12,26 @@ Unlike a `kind 1` event with a video attached, Video Events are meant to contain
## Video Events
There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc).
#### Format
The format uses a parameterized replaceable event kind `34235`.
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 list of tags are as follows:
* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event.
* `title` (required) title of the video
* `src` (required) a link to the video data
* `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)
* `image` (optional) thumbnail or preview image for the video
* `image` (optional) url of preview image with same dimensions
* `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
* `content-warning` (optional) warning about content of NSFW video
* `alt` (optional) description for accessibility
* `t` (optional, repeated) hashtag to categorize video
* `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.
@ -36,20 +41,23 @@ The list of tags are as follows:
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
"created_at": <Unix timestamp in seconds>,
"kind": 34235,
"kind": 34235 | 34236,
"content": "<summary of video>",
"tags": [
["d", "<UUID>"],
["title", "<title of video>"],
["summary", "<summary of video>"],
["image", "<thumbnail image for video>"],
["thumb", "<thumbnail image for video>"],
["image", "<preview image for video>"],
["alt", <description>],
// Video Data
["src", "<url>"],
["url", "<url>"],
["m", "<MIME type>"],
["text-track", "<url>", "<text track type>", "<optional language>"],
["content-warning", "<reason>"],
["dim", <size of video in pixels>],
// Participants
["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
@ -72,14 +80,14 @@ A video event view is a response to a video event to track a user's view or prog
### Format
The format uses a parameterized replaceable event kind `34236`.
The format uses a parameterized replaceable event kind `34237`.
The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user.
The list of tags are as follows:
* `a` (required) reference tag to kind `34235` video event being viewed
* `d` (required) universally unique identifier. Generated by the client creating the video event view
* `progress` (optional) timestamp of the user's progress in format `HH:MM:SS.sss`
* `a` (required) reference tag to kind `34235` or `34236` video event being viewed
* `d` (required) same as `a` reference tag value
* `viewed` (optional, repeated) timestamp of the user's start time in `HH:MM:SS.sss`, timestamp of the user's end time in `HH:MM:SS.sss`
```json
@ -87,12 +95,12 @@ The list of tags are as follows:
"id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
"pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
"created_at": <Unix timestamp in seconds>,
"kind": 34236,
"kind": 34237,
"content": "<note>",
"tags": [
["a", "<34235>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"],
["d", "<UUID>"],
["progress", "00:08:31.520"],
["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"],
["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"],
["viewed", <start>, <end>],
]
}
```