Video
Video
An embedded video launched from a poster image.
Properties
aspectRatio
string
Player proportions; unsupported values use 16:9.
class
string
Optional styling hook.
image
object
Image used by the owning object.
alt — string [REQUIRED]
Accessible text alternative.
caption — object
Structured media caption.
credit — string
Image credit text.
subtitle — string
Supporting text associated with the heading.
title — string
Visible heading or display name.
src — string [REQUIRED]
Image URL or site-relative path.
width — number
Maximum responsive source width.
privacyMode
boolean
Uses YouTube's privacy-enhanced host; defaults on.
provider
enum
Hosting service used for the embed.
"youtube" | "vimeo"
startSeconds
number
Playback offset; invalid or negative values are ignored.
type
string
Identifies the Element type represented by this object.
"video"
videoId
string
Provider-specific video identifier.
Example
Required
{
"image": {
"alt": "Neutral poster for the Merlin Bird ID guide",
"src": "/gallery-study.svg"
},
"provider": "youtube",
"type": "video",
"videoId": "krk8RCREK38"
}
Full
{
"aspectRatio": "example",
"class": "example",
"image": {
"alt": "Neutral poster for the Merlin Bird ID guide",
"caption": {
"credit": "example",
"subtitle": "A video poster with a structured caption.",
"title": "Master Merlin Bird ID"
},
"src": "/gallery-study.svg",
"width": 0
},
"privacyMode": false,
"provider": "youtube",
"startSeconds": 0,
"type": "video",
"videoId": "krk8RCREK38"
}
examples are generated from the schema.