Skip to content
Permalink
Branch: master
Find file Copy path
88 lines (58 sloc) 4.18 KB

Video in AMP

Most video player components in AMP implement the VideoInterface API. This means that a set of features is available in all of these components, either completely or partially.

This document describes all the features (work in progress, incomplete) that these players implement.

These players include:

Analytics

See video analytics.

Autoplay

attribute: autoplay

If this attribute is present, and the browser supports autoplay:

  • the video is automatically muted before autoplay starts
  • when the video is scrolled out of view, the video is paused
  • when the video is scrolled into view, the video resumes playback
  • when the user taps the video, the video is unmuted
  • if the user has interacted with the video (e.g., mutes/unmutes, pauses/resumes, etc.), and the video is scrolled in or out of view, the state of the video remains as how the user left it. For example, if the user pauses the video, then scrolls the video out of view and returns to the video, the video is still paused.

For an example, visit AMP By Example.

Docking (minimize to corner)

attribute: dock

This attribute is currently only supported for amp-brightcove, amp-dailymotion, amp-delight-player, amp-ima-video, amp-video, amp-video-iframe and amp-youtube.

If this attribute is present and the video is playing manually, the video will be "minimized" and fixed to a corner when the user scrolls out of the video component's visual area.

  • The video can be dragged and repositioned by the user on a different corner.
  • Multiple videos on the same page can be docked.

In order to use this attribute, the amp-video-docking extension script must be present:

<script async custom-element="amp-video-docking" src="https://cdn.ampproject.org/v0/amp-video-docking-0.1.js"></script>

For more details, see documentation on the docking extension itself.

Rotate-to-fullscreen

attribute: rotate-to-fullscreen

This attribute is currently only supported for amp-video, amp-ima-video and amp-dailymotion.

If this attribute is present and a video is playing manually (i.e. user initiated playback, or tapped on the video after autoplay), the video displays fullscreen after the user rotates their device into landscape mode, provided that the video is visible.

When multiple videos with the rotate-to-fullscreen attribute set are visible at the same time, heuristics are employed to select which video to display in fullscreen. These heuristics are applied as follows, in descending priority:

  1. If a video is playing manually (i.e. user initiated playback, or tapped on the video after autoplay)
  2. If the visible percentage of the video is higher.
  3. If a video is closer to the center of the viewport.
  4. Everything else failing, select the video that is closest to the top of the viewport.
You can’t perform that action at this time.