amp-audio

1.0 0.1

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

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

用法

使用 amp-audio 组件与直接 HTML5 音频文件嵌入。

amp-audio 组件在由运行时确定的时间加载其 src 属性指定的音频资源。它可以像标准 HTML5 audio 标记一样进行控制。与 AMP 文件中的所有嵌入式外部资源一样，音频是“延迟”加载的，仅当 amp-audio 元素位于视口中或视口附近时才加载

amp-audio 组件最多接受三种独特类型的 HTML 节点作为子级

• source 标记：就像在 HTML <audio> 标记中一样，您可以添加 <source> 标记子级以指定要播放的不同源媒体文件。
• 音频开始前的一个占位符：一个或零个直接子节点可以具有 placeholder 属性。如果存在，此节点及其子节点将形成一个占位符，该占位符将显示在音频的替代位置。在 amp-audio 容器内的任何地方单击或轻触都会将占位符替换为音频本身。
• 如果浏览器不支持 HTML5 音频，则使用后备：一个或零个直接子节点可以具有 fallback 属性。如果存在，此节点及其子节点将形成内容，如果用户的浏览器不支持 HTML5 音频，则显示该内容。

例如

<amp-audio
  width="400"
  height="300"
  src="https://yourhost.com/audios/myaudio.mp3"
>
  <div fallback>
    <p>Your browser doesn’t support HTML5 audio</p>
  </div>
  <source type="audio/mpeg" src="foo.mp3" />
  <source type="audio/ogg" src="foo.ogg" />
</amp-audio>

属性

src

如果不存在 <source> 子级，则必需。必须是 HTTPS。

preload

如果存在，则在 html <audio> 标记中设置 preload 属性，该属性指定作者认为是否应在页面加载时加载音频文件。

autoplay

如果存在，则该属性表示音频将在准备就绪后立即开始播放。

loop

如果存在，则音频在播放到结尾时将自动循环回到开头。

muted

如果存在，则默认将音频静音。

controlsList

与 HTML5 音频元素的 controlsList 属性相同。仅受某些浏览器支持。有关详细信息，请参阅 https://mdn.org.cn/en-US/docs/Web/API/HTMLMediaElement/controlsList。

媒体会话属性

amp-audio 实施 媒体会话 API，使开发者能够指定有关正在播放的音频文件的更多信息，以便显示在用户设备的通知中心（以及播放/暂停控件）。

示例

<amp-audio
  width="400"
  height="300"
  src="https://yourhost.com/audios/myaudio.mp3"
  artwork="https://yourhost.com/artworks/artwork.png"
  title="Awesome music"
  artist="Awesome singer"
  album="Amazing album"
>
  <source type="audio/mpeg" src="foo.mp3" />
</amp-audio>

artwork

指向 PNG/JPG/ICO 图像的 URL，用作音频的插图。如果不存在，MediaSessionAPI Helper 将使用 schema.org 定义中的 image 字段、og:image 或网站的 favicon。

artist

（字符串）表示音频的作者。

album

（字符串）表示音频所属的专辑。

title

（字符串）通用属性的一部分，兼作 MediaSession 通知中显示的音频名称。如果未提供，MediaSessionAPI Helper 将使用 aria-label 属性或回退到页面的标题。

分析

AMP 音频分析收集有关用户如何与 AMP 文档中的音频进行交互的数据。AMP 音频扩展在其生命周期内发出分析事件。可以通过使用 audio-* 触发器通过分析配置报告这些事件。audio-play 和 audio-pause 是现在支持的两个分析事件。

有关 amp-analytics 配置的详细信息，请参阅 AMP Analytics 组件。

音频播放触发器（"on": "audio-play"）

当用户点击播放或从自动播放开始或恢复时，将触发 audio-play 触发器。使用这些配置为该事件触发请求。

"triggers": {
  "audioPlay": {
    "on": "audio-play",
    "request": "event",
    "selector": "#audio1"
  }
}

音频暂停触发器（"on": "audio-pause"）

当用户点击暂停、从自动播放暂停或音频播放到结尾时，将触发 audio-pause 触发器。使用这些配置为该事件触发请求。

"triggers": {
  "audioPause": {
    "on": "audio-pause",
    "request": "event",
    "selector": "#audio1"
  }
}

验证

请参阅 AMP 验证器规范中的 amp-audio 规则。