Interface VideoBlock

An NPF video type content block.

interface VideoBlock {
    attribution?: Attribution;
    can_autoplay_on_cellular?: boolean;
    duration?: number;
    embed_html?: string;
    embed_iframe?: IFrame;
    embed_url?: string;
    media?: VisualMedia;
    metadata?: Record<string, unknown>;
    poster?: VisualMedia[];
    provider?: string;
    type: "video";
    url?: string;
}

Properties

attribution?: Attribution

Optional attribution information about where the video came from.

can_autoplay_on_cellular?: boolean

Whether this video can be played on a cellular connection.

duration?: number

The video duration in milliseconds.

embed_html?: string

HTML code that could be used to embed this video into a webpage.

embed_iframe?: IFrame

An IFrame used for constructing video iframes.

embed_url?: string

A URL to the embeddable content to use as an iframe.

media?: VisualMedia

The Media to use for the video block. Either this, url, or both will always be set.

metadata?: Record<string, unknown>

Optional provider-specific metadata about the video.

poster?: VisualMedia[]

An image media object to use as a "poster" for the video, usually a single frame.

provider?: string

The provider of the audio source, whether it's tumblr for native audio or a trusted third party.

type
url?: string

The URL to use for the video block. Either this, media, or both will always be set.