Interface: VideoBlock
Description
Displays an embedded video player. A video block is designed to embed videos in all app surfaces (e.g.
link unfurls, messages, modals, App Home) — anywhere you can put blocks! To use the video block within your app, you
must have the links.embed:write scope.
See
Extends
Properties
alt_text
alt_text: string;
Description
A tooltip for the video. Required for accessibility.
Defined in
author_name?
optional author_name: string;
Description
Author name to be displayed. Must be less than 50 characters.
Defined in
block_id?
optional block_id: string;
Description
A string acting as a unique identifier for a block. If not specified, a block_id will be generated.
You can use this block_id when you receive an interaction payload to
identify the source of the action.
Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of
a message. If a message is updated, use a new block_id.
Inherited from
Defined in
description?
optional description: PlainTextElement;
Description
Description for video using a PlainTextElement object.
Defined in
provider_icon_url?
optional provider_icon_url: string;
Description
Icon for the video provider, e.g. YouTube icon.
Defined in
provider_name?
optional provider_name: string;
Description
The originating application or domain of the video, e.g. YouTube.
Defined in
thumbnail_url
thumbnail_url: string;
Description
The thumbnail image URL.
Defined in
title
title: PlainTextElement;
Description
Video title as a PlainTextElement object. text within must be less than 200 characters.
Defined in
title_url?
optional title_url: string;
Description
Hyperlink for the title text. Must correspond to the non-embeddable URL for the video. Must go to an HTTPS URL.
Defined in
type
type: "video";
Description
The type of block. For a video block, type is always video.
Overrides
Defined in
video_url
video_url: string;
Description
The URL to be embedded. Must match any existing unfurl domains within the app and point to a HTTPS URL.