運用 Media Session API 自訂媒體通知和播放控制項

如何整合硬體媒體鍵、自訂媒體通知等功能。

為了讓使用者知道目前瀏覽器正在播放的內容，且不必返回啟動它的頁面，我們導入了 Media Session API。這可讓網頁開發人員透過自訂媒體通知的中繼資料、媒體事件 (例如播放、暫停、播放、追蹤變更)，以及視訊會議事件 (例如靜音/取消靜音麥克風、開啟/關閉攝影機和掛斷) 來自訂使用體驗。這些自訂功能適用於多種情境，包括電腦媒體中心、行動裝置的媒體通知，甚至是穿戴式裝置。我們會在這篇文章中說明這些自訂項目

關於 Media Session API

Media 工作階段 API 有許多優點和功能：

• 支援硬體媒體鍵。
• 無論是行動裝置、電腦或配對的穿戴式裝置，都能自訂媒體通知。
• 您可以在電腦上使用媒體中心。
• 螢幕鎖定媒體控制選項適用於 ChromeOS 和行動裝置。
• 子母畫面視窗控制項適用於音訊播放、視訊會議和分享螢幕畫面。
• 行動裝置支援 Google 助理整合功能。

以下舉幾個例子來說明這其中幾個要點。

範例 1：如果使用者按下鍵盤的「下一首」媒體鍵，網頁開發人員便可處理此使用者動作，無論瀏覽器在前景或背景都一樣。

範例 2：如果使用者在裝置螢幕處於鎖定狀態時收聽網路上的 Podcast，使用者仍可在螢幕鎖定畫面媒體控制項中點選「向後瀏覽」圖示，讓網頁程式開發人員將播放時間倒轉幾秒鐘。

範例 3：如果使用者的分頁正在播放音訊，就可以透過電腦版媒體中心輕鬆停止播放，讓網頁開發人員有機會清除自己的狀態。

範例 4：如果使用者正在視訊通話，可以在「子母畫面」視窗中按下「切換麥克風」控制項，讓網站停止接收麥克風資料。

這些操作都是透過兩個不同的介面完成：MediaSession 介面和 MediaMetadata 介面。第一個方法可讓使用者控制正在播放的內容其二是指示 MediaSession 需要控制的項目。

請參考下圖，瞭解這些介面與特定媒體控制項之間的關係 (在本例中為行動裝置的媒體通知)。

讓使用者瞭解目前播放的內容

網站播放音訊或視訊時，使用者會在行動裝置的通知匣或電腦版媒體中心自動收到媒體通知。瀏覽器會盡可能使用文件標題和所找到的最大圖示圖片，以顯示適當的資訊。透過 Media Session API，您可以使用更豐富的媒體中繼資料來自訂媒體通知，例如標題、演出者姓名、專輯名稱和圖片，如下所示。

只有在媒體時間長度至少 5 秒時，Chrome 才會要求「完整」音訊焦點顯示媒體通知。以確保系統不會顯示通知等附帶音效。

// After media (video or audio) starts playing
await document.querySelector("video").play();

if ("mediaSession" in navigator) {
  navigator.mediaSession.metadata = new MediaMetadata({
    title: 'Never Gonna Give You Up',
    artist: 'Rick Astley',
    album: 'Whenever You Need Somebody',
    artwork: [
      { src: 'https://via.placeholder.com/96',   sizes: '96x96',   type: 'image/png' },
      { src: 'https://via.placeholder.com/128', sizes: '128x128', type: 'image/png' },
      { src: 'https://via.placeholder.com/192', sizes: '192x192', type: 'image/png' },
      { src: 'https://via.placeholder.com/256', sizes: '256x256', type: 'image/png' },
      { src: 'https://via.placeholder.com/384', sizes: '384x384', type: 'image/png' },
      { src: 'https://via.placeholder.com/512', sizes: '512x512', type: 'image/png' },
    ]
  });

  // TODO: Update playback state.
}

播放結束後，您不需要「釋出」媒體工作階段，因為通知會自動消失。請注意，下一次播放時會使用 navigator.mediaSession.metadata。因此，請務必在媒體播放來源變更時進行更新，以確保媒體通知能顯示相關資訊。

關於媒體中繼資料，需要注意幾件事。

• 通知圖片陣列支援 blob 網址和資料網址。
• 如未定義圖片，且沒有使用 <link rel=icon> 指定大小的圖示圖片，則媒體通知會使用該圖片。
• Android 版 Google Chrome 的通知圖片目標大小為 512x512。如果是低階裝置，則為 256x256。
• 媒體 HTML 元素的 title 屬性會用於「現正播放」macOS 小工具。
• 如果媒體資源嵌入了 (例如 iframe)，Media Session API 資訊必須從嵌入環境設定。請查看下列程式碼片段。

<iframe id="iframe">
  <video>...</video>
</iframe>
<script>
  iframe.contentWindow.navigator.mediaSession.metadata = new MediaMetadata({
    title: 'Never Gonna Give You Up',
    ...
  });
</script>

你也可以在媒體中繼資料中新增個別章節資訊，例如章節標題、時間戳記和螢幕截圖圖片。方便使用者瀏覽媒體內容。

navigator.mediaSession.metadata = new MediaMetadata({
  // title, artist, album, artwork, ...
  chapterInfo: [{
    title: 'Chapter 1',
    startTime: 0,
    artwork: [
      { src: 'https://via.placeholder.com/128', sizes: '128x128', type: 'image/png' },
      { src: 'https://via.placeholder.com/512', sizes: '512x512', type: 'image/png' },
    ]
  }, {
    title: 'Chapter 2',
    startTime: 42,
    artwork: [
      { src: 'https://via.placeholder.com/128', sizes: '128x128', type: 'image/png' },
      { src: 'https://via.placeholder.com/512', sizes: '512x512', type: 'image/png' },
    ]
  }]
});

讓使用者自行操控正在播放的內容

媒體工作階段動作是指網站可在使用者與目前媒體播放內容互動時處理的動作 (例如「播放」或「暫停」)。動作與事件相似，運作方式也大同小異。與事件一樣，動作是在適當物件 (在本例中為 MediaSession 例項) 上設定處理常式來實作。當使用者按下耳機、其他遠端裝置或鍵盤的按鈕，或與媒體通知互動時，就會觸發某些動作。

由於系統可能不支援部分媒體工作階段動作，因此建議您在設定時使用 try…catch 區塊。

const actionHandlers = [
  ['play',          () => { /* ... */ }],
  ['pause',         () => { /* ... */ }],
  ['previoustrack', () => { /* ... */ }],
  ['nexttrack',     () => { /* ... */ }],
  ['stop',          () => { /* ... */ }],
  ['seekbackward',  (details) => { /* ... */ }],
  ['seekforward',   (details) => { /* ... */ }],
  ['seekto',        (details) => { /* ... */ }],
  /* Video conferencing actions */
  ['togglemicrophone', () => { /* ... */ }],
  ['togglecamera',     () => { /* ... */ }],
  ['hangup',           () => { /* ... */ }],
  /* Presenting slides actions */
  ['previousslide', () => { /* ... */ }],
  ['nextslide',     () => { /* ... */ }],
];

for (const [action, handler] of actionHandlers) {
  try {
    navigator.mediaSession.setActionHandler(action, handler);
  } catch (error) {
    console.log(`The media session action "${action}" is not supported yet.`);
  }
}

取消媒體工作階段動作處理常式就像設為 null 一樣簡單。

try {
  // Unset the "nexttrack" action handler at the end of a playlist.
  navigator.mediaSession.setActionHandler('nexttrack', null);
} catch (error) {
  console.log(`The media session action "nexttrack" is not supported yet.`);
}

設定完成後，媒體工作階段動作處理常式會在媒體播放期間持續存在。這與事件監聽器模式類似，差別在於處理事件代表瀏覽器停止執行任何預設行為，並將這個信號做為網站支援媒體動作的信號。因此，你必須設定適當的動作處理常式，系統才會顯示媒體動作控制項。

播放 / 暫停

"play" 動作表示使用者想要繼續播放媒體，而 "pause" 表示想要暫時停止播放。

媒體通知一律會顯示「播放/暫停」圖示，瀏覽器會自動處理相關媒體事件。如要覆寫其預設行為，請處理「播放」和「暫停」媒體動作，如下所示。

舉例來說，瀏覽器在尋找或載入時，可能會認定網站並未播放媒體。在這種情況下，請將 navigator.mediaSession.playbackState 設為 "playing" 或 "paused" 來覆寫此行為，確保網站 UI 與媒體通知控制項保持同步。

const video = document.querySelector('video');

navigator.mediaSession.setActionHandler('play', async () => {
  // Resume playback
  await video.play();
});

navigator.mediaSession.setActionHandler('pause', () => {
  // Pause active playback
  video.pause();
});

video.addEventListener('play', () => {
  navigator.mediaSession.playbackState = 'playing';
});

video.addEventListener('pause', () => {
  navigator.mediaSession.playbackState = 'paused';
});

播放上一首曲目

"previoustrack" 動作表示在播放媒體的內容沒有開始概念時，使用者可選擇從頭開始播放目前媒體內容；如果播放媒體沒有播放清單的概念，則使用者會移至播放清單中的上一個項目。

navigator.mediaSession.setActionHandler('previoustrack', () => {
  // Play previous track.
});

播放下一首曲目

"nexttrack" 動作表示在播放媒體有播放清單概念時，使用者想要將媒體播放移至播放清單中的下一個項目。

navigator.mediaSession.setActionHandler('nexttrack', () => {
  // Play next track.
});

停止

"stop" 動作表示使用者想要停止播放媒體，並視情況清除狀態。

navigator.mediaSession.setActionHandler('stop', () => {
  // Stop playback and clear state if appropriate.
});

倒轉 / 快轉

"seekbackward" 動作表示使用者想將媒體播放時間倒轉短時間，而 "seekforward" 表示希望將媒體播放時間往前移動。在這兩種情況下，短時間代表幾秒鐘。

動作處理常式中提供的 seekOffset 值是媒體播放時間的移動時間 (以秒為單位)。如果未提供時間值 (例如 undefined)，則應使用合理的時間 (例如 10 至 30 秒)。

const video = document.querySelector('video');
const defaultSkipTime = 10; /* Time to skip in seconds by default */

navigator.mediaSession.setActionHandler('seekbackward', (details) => {
  const skipTime = details.seekOffset || defaultSkipTime;
  video.currentTime = Math.max(video.currentTime - skipTime, 0);
  // TODO: Update playback state.
});

navigator.mediaSession.setActionHandler('seekforward', (details) => {
  const skipTime = details.seekOffset || defaultSkipTime;
  video.currentTime = Math.min(video.currentTime + skipTime, video.duration);
  // TODO: Update playback state.
});

跳轉至特定時間

"seekto" 動作表示使用者想將媒體播放時間移至特定時間。

動作處理常式中提供的 seekTime 值是媒體播放時間的移動時間 (以秒為單位)。

如果要在序列中多次呼叫動作，且不是該序列中的最後一個呼叫，動作處理常式中提供的 fastSeek 布林值即為 true。

const video = document.querySelector('video');

navigator.mediaSession.setActionHandler('seekto', (details) => {
  if (details.fastSeek && 'fastSeek' in video) {
    // Only use fast seek if supported.
    video.fastSeek(details.seekTime);
    return;
  }
  video.currentTime = details.seekTime;
  // TODO: Update playback state.
});

設定播放位置

在通知中準確顯示媒體播放位置，只需在適當的時間設定位置狀態，如下所示。位置狀態是媒體播放速率、時間長度和目前時間的組合。

必須提供時間長度為正數。位置必須為正數，且小於時間長度。播放速率必須大於 0。

const video = document.querySelector('video');

function updatePositionState() {
  if ('setPositionState' in navigator.mediaSession) {
    navigator.mediaSession.setPositionState({
      duration: video.duration,
      playbackRate: video.playbackRate,
      position: video.currentTime,
    });
  }
}

// When video starts playing, update duration.
await video.play();
updatePositionState();

// When user wants to seek backward, update position.
navigator.mediaSession.setActionHandler('seekbackward', (details) => {
  /* ... */
  updatePositionState();
});

// When user wants to seek forward, update position.
navigator.mediaSession.setActionHandler('seekforward', (details) => {
  /* ... */
  updatePositionState();
});

// When user wants to seek to a specific time, update position.
navigator.mediaSession.setActionHandler('seekto', (details) => {
  /* ... */
  updatePositionState();
});

// When video playback rate changes, update position state.
video.addEventListener('ratechange', (event) => {
  updatePositionState();
});

重設位置狀態就像將狀態設為 null 一樣簡單。

// Reset position state when media is reset.
navigator.mediaSession.setPositionState(null);

視訊會議動作

使用者將視訊通話放入子母畫面視窗時，瀏覽器可能會顯示麥克風和攝影機的控制項，以及掛斷電話。當使用者點選這些活動時，網站會透過下方的視訊會議動作處理這些活動。如需範例，請參閱視訊會議範例。

切換麥克風

"togglemicrophone" 動作表示使用者想要將麥克風設為靜音或取消靜音。setMicrophoneActive(isActive) 方法會告訴瀏覽器網站目前是否將麥克風視為使用中。

let isMicrophoneActive = false;

navigator.mediaSession.setActionHandler('togglemicrophone', () => {
  if (isMicrophoneActive) {
    // Mute the microphone.
  } else {
    // Unmute the microphone.
  }
  isMicrophoneActive = !isMicrophoneActive;
  navigator.mediaSession.setMicrophoneActive(isMicrophoneActive);
});

切換相機

"togglecamera" 動作表示使用者想要開啟或關閉使用中的攝影機。setCameraActive(isActive) 方法會指出瀏覽器是否將網站視為使用中。

let isCameraActive = false;

navigator.mediaSession.setActionHandler('togglecamera', () => {
  if (isCameraActive) {
    // Disable the camera.
  } else {
    // Enable the camera.
  }
  isCameraActive = !isCameraActive;
  navigator.mediaSession.setCameraActive(isCameraActive);
});

掛斷

"hangup" 動作表示使用者想要結束通話。

navigator.mediaSession.setActionHandler('hangup', () => {
  // End the call.
});

播放投影片操作

使用者將投影片簡報放入子母畫面視窗時，瀏覽器可能會顯示控制選項，方便使用者瀏覽投影片。當使用者點選這些元素時，網站就會透過 Media Session API 處理這些動作。如需範例，請參閱「進行簡報」範例。

上一張投影片

"previousslide" 動作表示使用者在簡報投影片時想返回上一張投影片。

navigator.mediaSession.setActionHandler('previousslide', () => {
  // Show previous slide.
});

下一張投影片

"nextslide" 動作表示使用者在播放投影片時想前往下一張投影片。

navigator.mediaSession.setActionHandler('nextslide', () => {
  // Show next slide.
});

範例

查看有關 Blender Foundation 和 Jan Morgenstern 作品的媒體工作階段範例。

資源

• Media Session Spec：wicg.github.io/mediasession
• 規格問題：github.com/WICG/mediasession/issues
• Chrome 錯誤：crbug.com