Video block

Use a video block to show a link to a hosted video or a video file. You can add a caption and set the player’s alignment, width, and aspect ratio.

Configuration

PropertyTypeRequiredDefaultValidation and behavior
typestringYes—Must be video. Selects the block.
urlstringYes—At least 1 character. Links to a hosted video or video file.
captionstringNoNoneAny text. Shown under the video.
alignmentstringNocenterleft, center, or right. Sets horizontal position.
sizestringNofulltiny (160 px), xs (240 px), small (320 px), medium (640 px), large (960 px), or full (100% of form width). Sets the largest player width.
maxWidthnumberNoNone; size sets the widthPixels. When set, replaces size.
aspectRatiostringNo16:916:9, 4:3, or 1:1. Sets the player shape.
visible_ifcondition arrayNoNoneSame conditions as fields. Shows the block when true.
hide_ifcondition arrayNoNoneSame conditions as fields. Hides the block when true.

Where you can use it

Add the block to the ui array of a start page, question page, or end page. End pages accept display blocks only. Visibility conditions work on layout blocks.

A video block collects no answer, so it has no submission value.

JSON example

{ "type": "video", "url": "https://media.example.com/videos/product-tour.mp4", "caption": "A two-minute tour of the product", "alignment": "center", "size": "large", "aspectRatio": "16:9" }