Important: this documentation is not applicable to your currently selected format ads!

amp-youtube

Experimental

Bento

Description

Displays a YouTube video.

Required Scripts

AMP Bento (Standalone)

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

<script async custom-element="amp-youtube" src="https://cdn.ampproject.org/v0/amp-youtube-1.0.js"></script>
<link rel="stylesheet" href="https://cdn.ampproject.org/v0/amp-youtube-1.0.css">

Supported Layouts

fill fixed fixed-height flex-item nodisplay responsive

Usage

Displays a YouTube video.

With the responsive layout, the width and height from the example should yield correct layouts for 16:9 aspect ratio videos:

<amp-youtube
  data-videoid="mGENRKrdoGY"
  layout="responsive"
  width="480"
  height="270"
></amp-youtube>

<amp-youtube
  id="myLiveChannel"
  data-live-channelid="UCB8Kb4pxYzsDsHxzBfnid4Q"
  width="358"
  height="204"
  layout="responsive"
>
  <amp-img
    src="https://i.ytimg.com/vi/Wm1fWz-7nLQ/hqdefault_live.jpg"
    placeholder
    layout="fill"
  />
</amp-youtube>

Standalone use outside valid AMP documents

Bento AMP allows you to use AMP components in non-AMP pages without needing to commit to fully valid AMP. You can take these components and place them in implementations with frameworks and CMSs that don't support AMP. Read more in our guide Use AMP components in non-AMP pages.

<head>
  <script async src="https://cdn.ampproject.org/v0.js"></script>
  <link rel="stylesheet" type="text/css" href="https://cdn.ampproject.org/v0/amp-youtube-1.0.css">
  <script async custom-element="amp-youtube" src="https://cdn.ampproject.org/v0/amp-youtube-1.0.js"></script>
</head>
<body>
  <amp-youtube
    style="aspect-ratio: 16/9"
    id="my-youtube-video"
    data-videoid="mGENRKrdoGY"
  ></amp-youtube>
  <script>
    (async () => {
      const video = document.querySelector('#my-youtube-video');
      await customElements.whenDefined('amp-youtube');
      const videoHandle = await video.getApi();

      // programatically call playback actions
      videoHandle.play();
      videoHandle.pause();
      videoHandle.requestFullscreen();
      videoHandle.mute();
      videoHandle.unmute();

      // get video state
      console.log({
        autoplay: videoHandle.autoplay,
        controls: videoHandle.controls,
        duration: videoHandle.duration,
        currentTime: videoHandle.currentTime,
        loop: videoHandle.loop,
      })
    })();
  </script>
</body>

Interactivity and API usage

Bento are highly interactive through their API. In Bento standalone use, the element's API replaces AMP Actions and events and amp-bind.

The amp-youtube component API is accessible by including the following script tag in your document:

await customElements.whenDefined('amp-youtube');
const videoHandle = await video.getApi();

Actions

The amp-youtube API allows you to perform the following actions:

`play()`

Plays the video.

videoHandle.play();

`pause()`

Pauses the video.

videoHandle.pause();

`mute()`

Mutes the video.

videoHandle.mute();

`unmute()`

Unmutes the video.

videoHandle.unmute();

`requestFullscreen()`

Expands the video to fullscreen when possible.

videoHandle.requestFullscreen();

Properties

It also exposes the following read-only properties:

`currentTime` (`number`)

The current playback time in seconds.

console.log(videoHandle.currentTime);

`duration` (`number`)

The video's duration in seconds, when it's known (e.g. is not a livestream).

console.log(videoHandle.duration);

`autoplay` (`boolean`)

Whether the video autoplays.

console.log(videoHandle.autoplay);

`controls` (`boolean`)

Whether the video shows controls.

console.log(videoHandle.controls);

`loop` (`boolean`)

Whether the video loops.

console.log(videoHandle.loop);

Migrating from 0.1

The experimental 1.0 version of amp-youtube does not automatically convert data-param-controls to controls. Instead it takes controls directly as an attribute.

Attributes

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.

loop

If this attribute is present, the video or playlist will play again (from the beginning) once it ends.

data-videoid

The YouTube video id found in every YouTube video page URL.

For example, in this URL: https://www.youtube.com/watch?v=Z1q71gFeRqM, Z1q71gFeRqM is the video id.

data-live-channelid

The Youtube channel id that provides a stable livestream url. For example, in this URL: https://www.youtube.com/embed/live_stream?channel=UCB8Kb4pxYzsDsHxzBfnid4Q, UCB8Kb4pxYzsDsHxzBfnid4Q is the channel id. You can provide a data-live-channelid instead of a data-videoid attribute to embed a stable url for a live stream instead of a video. Channels do not come with default placeholders. You can provide a placeholder for the video per example 2 above.

data-param-*

All data-param-* attributes (with the exception of data-param-autoplay and data-param-loop) will be added as query parameter to the YouTube iframe src. This may be used to pass custom values through to YouTube plugins, such as whether to show controls.

Keys and values will be URI encoded. Keys will be camel cased

controls

See YouTube Embedded Player Parameters for more parameter options for YouTube.

Use the autoplay attribute instead of data-param-autoplay and the loop attribute instead of data-param-loop since both the autoplay and looping behaviors are handled internally by AMP instead of the Youtube player.

credentials (optional)

Defines a credentials option as specified by the Fetch API.

Supported values: omit, include
Default: include

If you want to use the YouTube player in privacy-enhanced mode, pass the value of omit.

Usually YouTube sets its cookies when the player is loaded. In privacy-enhanced mode cookies are set when the user has clicked on the player.

title (optional)

Define a title attribute for the component to propagate to the underlying <iframe> element. The default value is "YouTube video".

common attributes

This element includes common attributes extended to AMP components.

需要更多帮助？

您已多次阅读本文档，但它仍未能涵盖您的所有问题？也许其他人也这么觉得：在 Stack Overflow 上与他们联系。

前往 Stack Overflow

发现错误或缺少功能？

AMP 项目强烈鼓励您参与并做出贡献！我们希望您能成为我们开放源代码社区的持续参与者，但我们也欢迎您对所热衷问题做出一次性贡献。

前往 GitHub