amp-video-iframe
描述
嵌入包含视频播放器的 iframe。
必需脚本
<script async custom-element="amp-video-iframe" src="https://cdn.ampproject.org/v0/amp-video-iframe-0.1.js"></script>
何时应该使用它?
如果你已经构建了自己的基于 Javascript 的视频播放器,并想将其嵌入到 AMP 文档中,或者你的播放器由 AMP 组件库不支持的第三方提供,则此组件非常有用。
-
如果你想在 AMP 文档中直接包含视频,则应使用
amp-video
。 -
如果你使用 常见的第三方(如 Youtube、Vimeo 或 AMP 中支持的其他第三方),则应使用其支持的组件(例如,
amp-youtube
、amp-vimeo
)。 -
如果你已经构建了 自定义播放器 或正在使用 不受支持的第三方 提供的播放器,则应该使用
amp-video-iframe
。这与使用amp-iframe
不同,因为它启用了 AMP 上的视频功能。有关更多详细信息,请参阅下面的 行为。 -
如果你是 第三方视频供应商,则可以使用
amp-video-iframe
来 为作者提供一种嵌入视频的简单方法。
行为
amp-video-iframe
与普通 iframe 和 amp-iframe
有几个重要的区别。
-
默认情况下,
amp-video-iframe
是沙盒化的。 -
amp-video-iframe
实现了所有 视频功能,如自动播放、最小化到角落和旋转到全屏。 -
amp-video-iframe
只能通过 HTTPS 请求资源。 -
amp-video-iframe
不可滚动。
简而言之,amp-video-iframe
将 AMP 视频功能插入到托管视频播放器的嵌入文档中。
将 amp-video-iframe 用于广告
不得 将 amp-video-iframe
用于显示广告的主要目的。将 amp-video-iframe
用于显示视频是允许的,其中一部分视频是广告。此 AMP 政策可能会通过不呈现相应的 iframe 来执行。
广告用例应改为使用 amp-ad
。
此政策的原因是
-
amp-video-iframe
强制执行沙盒化,并且沙盒也应用于子 iframe。这意味着,即使广告本身看起来可以正常工作,着陆页也可能会损坏。 -
amp-video-iframe
没有受控的大小调整机制。
属性
src(必需) | src 属性的行为主要类似于标准 iframe,但有一个例外:#amp=1 片段会添加到 URL 中,以允许源文档知道它们嵌入在 AMP 上下文中。仅当 src 指定的 URL 尚未具有片段时,才会添加此片段。 |
poster | 视频加载时显示的图像的 URL。建议始终设置此属性以获得最佳的感知性能。 |
autoplay | 如果存在此属性,并且浏览器支持自动播放,则视频将在可见后立即自动播放。该组件需要满足一些播放条件,这些条件在 AMP 中的视频规范中进行了概述。 |
通用属性 | 此元素包括 扩展到 AMP 组件的通用属性。 |
dock | 需要 amp-video-docking 扩展。 如果存在此属性,并且视频正在手动播放,则当用户滚动出视频组件的可视区域时,视频将被“最小化”并固定到角落或元素。有关更多详细信息,请参阅 停靠扩展本身的文档。 |
implements-media-session | 如果 iframe 中的文档独立实现了 MediaSession API,请设置此属性。 |
implements-rotate-to-fullscreen | 如果 iframe 中的文档独立实现了旋转到全屏,请设置此属性。 |
referrerpolicy | 要在 iframe 元素上设置的 referrerpolicy 。 |
data-param-* | 所有 data-param-* 属性都作为查询参数添加到 iframe 的 src 。它们可用于将自定义值传递到播放器文档。键和值将进行 URI 编码。键将使用驼峰命名法。
|
用法
在 AMP 文档中包含 amp-video-iframe
<amp-video-iframe layout="responsive" width="16" height="9" src="/my-video-player.html" poster="/my-video-poster.jpg" > </amp-video-iframe>
my-video-player.html
是在框架内加载的内部文档,用于播放视频。此文档必须包含并引导 集成脚本,以便包含 <amp-video-iframe>
的 AMP 文档可以协调视频的播放。
第三方视频供应商
如果你是不提供 自定义视频播放器组件的供应商,则可以使用 amp-video-iframe
配置的形式与 AMP 集成,以便作者可以嵌入通过你的服务提供的视频。
作为供应商,你可以提供一个通用 集成文档,该文档通过 URL 参数引用提供的视频。使用你的视频服务的 AMP 作者只需在其文档中包含 <amp-video-iframe>
标记
<!-- data-param-* attributes are added to src and poster, so this would use the following composed urls: src: https://vendor.example/amp-video-iframe ?videoid=MY_VIDEO_ID &channelid=MY_CHANNEL_ID poster: https://vendor.example/poster.jpg ?videoid=MY_VIDEO_ID &channelid=MY_CHANNEL_ID --> <amp-video-iframe layout="responsive" width="16" height="9" src="https://vendor.example/amp-video-iframe" poster="https://vendor.example/poster.jpg" data-param-videoid="MY_VIDEO_ID" data-param-channelid="MY_CHANNEL_ID" > </amp-video-iframe>
src
和 poster
URL 将附加 data-param-*
属性作为查询字符串。
/amp-video-iframe
文档引导 集成脚本,以便 AMP 文档可以与播放器协调。
在框架内集成
为了使视频集成正常工作,嵌入式文档(例如 my-video-player.html
)必须包含一个小型库
<script async src="https://cdn.ampproject.org/video-iframe-integration-v0.js" ></script> <!-- Wait for API to initialize --> <script> (window.AmpVideoIframe = window.AmpVideoIframe || []).push( onAmpIntegrationReady ); function onAmpIntegrationReady(ampIntegration) { // `ampIntegration` is an object containing the tools required to integrate. // This callback specifies how the AMP document and the iframed video document // talk to each other. // YOU NEED TO IMPLEMENT THIS. See below. } </script>
请注意,此库与扩展代码 (amp-video-iframe-0.1.js
) 是分开的,因为它位于 iframe 的非 AMP 文档上。
提供的回调函数指定了 AMP 文档和 iframe 视频文档之间如何通信。你需要实现一组播放方法和事件分发器来将它们连接在一起。对于常见的视频框架,集成脚本 提供了现成的播放支持,但如果你没有使用任何可用的工具,你也可以 自己编写自定义集成。
autoplay
属性的 amp-video-iframe
标签。AMP 组件将自动向你的 iframe 发送必要的信号以进行自动播放,从而获得更好的用户体验。现成的集成
如果你正在使用像 JW Player 或 Video.js 这样的常见视频框架,你可以调用 listenTo()
进行基本的、现成的集成。当框架提供时,这些集成支持所有播放和 UI 控件,请查看每个集成以了解支持的方法。
listenTo
方法。请阅读以下具体 API。
适用于 JW Player
默认支持的事件:ad_end
/ad_start
、canplay
、error
、muted
/unmuted
、pause
/playing
默认支持的方法:pause
/play
、mute
/unmute
、hidecontrols
/showcontrols
、fullscreenenter
/fullscreenexit
amp
对象知道如何通过使用 listenTo('jwplayer')
来设置 JwPlayer 实例。如果你 使用特定于视频的脚本 嵌入播放器,你只需要注册 Jwplayer 的使用即可
<script src="https://cdn.jwplayer.com/players/UVQWMA4o-kGWxh33Q.js"></script> <script> (window.AmpVideoIframe = window.AmpVideoIframe || []).push(function ( ampIntegration ) { ampIntegration.listenTo('jwplayer'); }); </script>
否则,通过签名 amp.listenTo('jwplayer', instance)
传入你的 JwPlayer 实例
(window.AmpVideoIframe = window.AmpVideoIframe || []).push(function ( ampIntegration ) { ampIntegration.listenTo('jwplayer', jwplayer('my-video')); });
适用于 Video.js
默认支持的事件:canplay
、ended
、muted
/unmuted
、pause
/playing
默认支持的方法:pause
/play
、mute
/unmute
、hidecontrols
/showcontrols
、fullscreenenter
/fullscreenexit
通过签名 ampIntegration.listenTo('videojs', myVideo)
传入你的 <video>
元素。Video.js 重载此元素以提供 ampIntegration
对象用于设置播放器的方法。
function onAmpIntegrationReady(ampIntegration) { var myVideo = document.querySelector('#my-video'); ampIntegration.listenTo('videojs', myVideo); }
如果需要,listenTo
会在 <video>
元素上初始化 Video.js 实例。默认情况下,它使用全局的 videojs
函数。如果你的页面以不同的方式提供初始化器,你必须将其作为第三个参数传入
function onAmpIntegrationReady(ampIntegration) { var myVideo = document.querySelector('#my-video'); // ampIntegration initializes player with `myVideojsInitializer(myVideo)` ampIntegration.listenTo('videojs', myVideo, myVideojsInitializer); }
自定义集成
如果你没有使用任何 默认支持的视频框架,你必须编写自定义实现来与 AMP 的视频管理进行通信。
以下是可用的通信方法
method
控制播放。postEvent
向宿主文档通知播放事件。getIntersection
获取视频在宿主文档中的可见性。getMetadata
获取有关宿主文档的信息。
如果你使用受支持的框架,则可以使用这些相同的方法对默认实现进行更精细的控制。
method(name, callback)
实现一个在视频上调用播放功能的方法。例如
ampIntegration.method('play', function () { myVideo.play(); });
以下是应该实现的方法
play
pause
mute
unmute
showcontrols
hidecontrols
fullscreenenter
fullscreenexit
你可以选择仅部分实现此接口,但有一些注意事项
-
播放 操作 或自动播放需要
play
和pause
中的一个或全部。 -
自动播放需要
mute
和unmute
。 -
为了获得最佳用户体验,需要
showcontrols
和hidecontrols
。例如,当将视频最小化到角落时,会显示自定义控件叠加层。如果你不提供隐藏和显示控件的方法,则可能会同时显示两组控件,这会带来糟糕的用户体验。 -
为了获得最佳用户体验,需要
fullscreenenter
和fullscreenexit
。例如,对于rotate-to-fullscreen
或最小化视频上的全屏按钮。
postEvent(name)
向框架发布播放事件。例如
myVideoElement.addEventListener('pause', function () { ampIntegration.postEvent('pause'); });
有效的事件如下。
事件 | 描述 |
canplay | 当你的播放器准备就绪时触发。此事件必须在播放器变为可交互之前发布。 |
playing | 当你的播放器在加载或暂停后开始播放视频时触发。 |
pause | 当你的视频已暂停时触发。 |
ended | 当你的视频已结束播放时触发。请注意,你还必须同时发布 pause 事件和 ended 事件。 |
muted | 当你的视频已静音时触发。 |
unmuted | 当你的视频已取消静音时触发。 |
ad_start | 当播放前贴片/中贴片/后贴片广告时触发。这会隐藏在视频上显示的自动播放占位符。 |
ad_end | 当一个前贴片/中贴片/后贴片广告结束时触发。如果用户尚未与视频交互,则会重新显示自动播放占位符。 |
postAnalyticsEvent(eventType[, vars])
发布一个由 amp-analytics
消费的自定义分析事件。eventType
必须以 video-custom-
为前缀,以防止与其他分析事件类型发生命名冲突。
此方法采用可选的 vars
参数,该参数应定义一个包含要记录的自定义变量的对象。这些变量可用作 VIDEO_STATE
,键名以 custom_
为前缀,即对象 {myVar: 'foo'}
将可用作 {'custom_myVar': 'foo'}
。
getConsentData(callback)
当宿主文档使用 amp-consent
时,iframe 文档可以请求用户同意数据。
data-block-on-consent
属性,而不是调用 getConsentData()
传递给该函数的 callback
将使用包含以下属性的对象执行
{ "consentMetadata": { "consentStringType": 2, "additionalConsent": "additional-consent-string", "gdprApplies": true, "purposeOne": true }, "consentString": "accept-string", "consentPolicyState": 1, "consentPolicySharedData": { "tfua": true, "coppa": true } }
例如,可以阻止视频加载,直到 consentPolicyState
可用为止
// Create and listen to video once consent is given on the parent page: integration.getConsentData(function(consent) { if ( consent.consentPolicyState !== /* SUFFICIENT */ 1 && consent.consentPolicyState !== /* UNKNOWN_NOT_REQUIRED */ 3 ) { integration.postEvent('error'); return; } // You can use other consent values to map video consent logic as well. console.log(consent); // Initialize video and integration once consent is available. var video = document.createElement(video); video.style = "width: 100vw; height: 100vh"; video.src = document.body.getAttribute('data-videoid'); document.body.appendChild(video); integration.method('play', function() { video.play(); }); // etc... });
一个完整的 使用 getConsentData
的示例也可用。
getIntersection(callback)
获取视频元素的交叉率(介于 0 和 1 之间)。这对于可见性信息非常有用,例如:
// Will log intersection every 2 seconds setInterval(function () { integration.getIntersection(function (intersection) { console.log('Intersection ratio:', intersection.intersectionRatio); }); }, 2000);
传递给该函数的 callback
将使用如下所示的对象执行
{"time": 33333.33, "intersectionRatio": 0.761}
⚠ 这应被视为低保真读数。目前,只要视频的可见度低于 50%,intersectionRatio
的值将为 0。此值随时可能更改,并且回调可能会延迟或去抖动。
getMetadata()
返回一个包含有关宿主文档的元数据的对象
{ "canonicalUrl": "https://example.com/canonical.html", "sourceUrl": "https://example.com/amp.html", "title": "My host document's title", "lang": "en" }
-
canonicalUrl
是规范网址。 -
sourceUrl
是 AMPHTML 网址。 -
title
是在初始化<amp-video-iframe>
时源网址的文档标题。当组件在阴影根中加载时为null
。 -
lang
是在<html ⚡️ lang="en">
中指定的源网址的语言。当组件在阴影根中加载时为null
。 -
jsonLd
包含 JSON-LD 标签的已解析内容(如果存在)。
你已经阅读本文档很多次了,但它并没有真正涵盖你的所有问题?也许其他人也有同样的感觉:在 Stack Overflow 上联系他们。
转到 Stack Overflow 发现错误或缺少功能?AMP 项目强烈鼓励你的参与和贡献!我们希望你能成为我们开源社区的长期参与者,但我们也欢迎你对你特别感兴趣的问题做出一次性贡献。
转到 GitHub