Object

EmbedWebVideo

The component for adding a web video from YouTube or Vimeo.

Properties

role
string
(Required)

Always embedwebvideo or embedvideo for this component.

URL
uri
(Required)

The URL of the embeddable video to display (the YouTube or Vimeo embed link). The embed URL is usually different from the standard video URL.

A Vimeo embed URL typically looks like this: https://player.vimeo.com/video/121450839

A YouTube embed URL typically looks like this: https://www.youtube.com/embed/0qwALOOvUik

accessibilityCaption
string

A caption that describes the content of the video. The text is used for VoiceOver for iOS and VoiceOver for macOS. If accessibilityCaption is not provided, the caption value is used for VoiceOver for iOS and VoiceOver for macOS.

anchor

An object that defines vertical alignment with another component.

animation
*

An object that defines an animation to be applied to the component.

The none value is used for conditional design elements. Adding it here has no effect.

aspectRatio
number

The aspect ratio of the video: width divided by height. The aspect ratio determines the height of the video player.

When this property is omitted, the video player will have a 16:9 aspect ratio (1.777), and videos with ratios other than 16:9 will automatically be letterboxed.

behavior
*

An object that defines behavior for a component, like Parallax or Springy.

The none value is used for conditional design elements. Adding it here has no effect.

caption
string

A caption that describes the content of the video. This text is also used by VoiceOver for iOS and VoiceOver for macOS if accessibilityCaption is not provided, or it when the video cannot be played.

conditional
*

An instance or array of component properties that can be applied conditionally, and the conditions that cause them to be applied.

explicitContent
boolean

A Boolean value that indicates that the embedded web video may contain explicit content.

hidden
boolean

A Boolean value that determines whether the component is hidden.

identifier
string

An optional unique identifier for this component. If used, this identifier must be unique across the entire document. You will need an identifier for your component if you want to anchor other components to it. See Anchor.

layout
*

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout object that is defined at the top level of the document.

If layout is not defined, size and position will be based on various factors, such as the device type, the length of the content, and the role of this component.

style
*

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle object that is defined at the top level of the document.

The none value is used for conditional design elements. Adding it here has no effect.

Discussion

Use the embedwebvideo component to include a video from YouTube or Vimeo by specifying a URL for the video. Users can control playback and watch the video from inside the article. To include other types of videos in your article, use the Video component.

Example

{ "components": [ { "role": "embedwebvideo", "aspectRatio": 1.777, "URL": "https://www.youtube.com/embed/_p8AsQhaVKI", "caption": "Apple - WWDC 2015", "accessibilityCaption": "See the announcement of Apple Music, get a preview of OS X v10.11 and iOS 9, and learn what’s next for Apple Watch and developers." } ]}

Relationships

Inherits From

See Also

Audio and Video

object Audio

The component for adding a playable audio clip.

object Music

The component for adding a playable music file.

object Video

The component for adding a video.