Skip to content

Latest commit

 

History

History
118 lines (94 loc) · 5.09 KB

71.md

File metadata and controls

118 lines (94 loc) · 5.09 KB
Raw

NIP-71

Video Events

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.

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

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 for horizontal videos and 34236 for vertical videos.

The .content of these events is a summary or description on the video content.

The list of tags are as follows:

  • d (required) universally unique identifier (UUID). Generated by the client creating the video event.
  • url (required) the url to the video file
  • m a string indicating the data type of the file. The MIME types format must be used, and they should be lowercase.
  • title (required) title of the video
  • "published_at", for the timestamp in unix seconds (stringified) of the first time the video was published
  • x containing the SHA-256 hexencoded string of the file.
  • size (optional) size of file in bytes
  • dim (optional) size of file in pixels in the form <width>x<height>
  • duration (optional) video duration in seconds
  • magnet (optional) URI to magnet file
  • i (optional) torrent infohash
  • 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
  • image (optional) url of preview image with same dimensions
  • content-warning (optional) warning about content of NSFW video
  • alt (optional) description for accessibility
  • segment (optional, repeated) start timestamp in format HH:MM:SS.sss, end timestamp in format HH:MM:SS.sss, chapter/segment title, chapter thumbnail-url
  • 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
{
  "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 | 34236,
  "content": "<summary / description of video>",
  "tags": [
    ["d", "<UUID>"],

    ["title", "<title of video>"],
    ["thumb", "<thumbnail image for video>"],
    ["published_at", "<unix timestamp>"],
    ["alt", <description>],

    // Video Data
    ["url",<string with URI of file>],
    ["m", <MIME type>],
    ["x",<Hash SHA-256>],
    ["size", <size of file in bytes>],
    ["duration", <duration of video in seconds>],
    ["dim", <size of file in pixels>],
    ["magnet",<magnet URI> ],
    ["i",<torrent infohash>],
    ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"],
    ["content-warning", "<reason>"],
    ["segment", <start>, <end>, "<title>", "<thumbnail URL>"],

    // Participants
    ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
    ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],

    // Hashtags
    ["t", "<tag>"],
    ["t", "<tag>"],

    // Reference links
    ["r", "<url>"],
    ["r", "<url>"]
  ]
}

Video View

A video event view is a response to a video event to track a user's view or progress viewing the video.

Format

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 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 seconds, timestamp of the user's end time in seconds
{
  "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": 34237,
  "content": "<note>",
  "tags": [
    ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"],
    ["e", "<event-id", "<relay-url>"]
    ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"],
    ["viewed", <start>, <end>],
  ]
}