AMP

重要:此文件不適用於您目前選擇的格式 email!

amp-audio

實驗性
Bento

描述

取代 HTML5 audio 標籤。

 

必要腳本

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

支援的版面配置

用法

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://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/controlsList

媒體工作階段屬性

amp-audio 實作了 Media Session 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

做為音訊 artwork 的 PNG/JPG/ICO 圖片網址。如果不存在,MediaSessionAPI Helper 會使用 schema.org 定義中的 image 欄位、og:image 或網站的 favicon。

artist

(字串) 表示音訊的作者。

album

(字串) 表示音訊取自的專輯。

title

(字串) 通用屬性的一部分,同時作為 MediaSession 通知中顯示的音訊名稱。如果未提供,MediaSessionAPI Helper 將使用 aria-label 屬性或回退到頁面標題。

分析

AMP 音訊分析收集使用者與 AMP 文件中音訊互動方式的資料。AMP 音訊擴充功能在其生命週期中發出分析事件。這些事件可以使用 audio-* 觸發器透過分析設定回報。目前支援 audio-playaudio-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 規則

需要更多協助嗎?

您已閱讀此文件十幾次,但它仍然沒有涵蓋您所有的問題?也許其他人也有同樣的感覺:在 Stack Overflow 上與他們聯繫。

前往 Stack Overflow
發現錯誤或缺少功能?

AMP 專案非常鼓勵您的參與和貢獻!我們希望您能成為我們開放原始碼社群的持續參與者,但我們也歡迎針對您特別感興趣的問題提供一次性貢獻。

前往 GitHub