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

如何整合硬體媒體金鑰、自訂媒體通知等等。

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

關於 Media Session API

媒體工作階段 API 提供許多優點和功能：

• 支援硬體媒體按鍵。
• 媒體通知是針對行動裝置、電腦和配對的穿戴式裝置自訂。
• 你可以在電腦上使用媒體中心。
• 螢幕鎖定媒體控制項適用於 ChromeOS 和行動裝置。
• 子母畫面視窗控制項適用於音訊播放、視訊會議和播放投影片。
• Google 助理行動版已可使用。

以下列舉幾個例子來說明其中部分要點。

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

範例 2：如果使用者在裝置螢幕鎖定時在網路上收聽 Podcast，仍可在螢幕鎖定媒體控制項中點選「倒轉」圖示，以便網頁開發人員將播放時間往前幾秒。

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

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

您可以透過兩個不同的介面完成這項作業：MediaSession 介面和 MediaMetadata 介面。第一個選項可讓使用者控制正在播放的內容，第二項是如何告知 MediaSession 需要控制的項目。

下圖為您說明這些介面與特定媒體控制項之間的關係，在本例中為行動裝置上的媒體通知。

讓使用者知道正在播放的音樂

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

Chrome 會要求「完整」音訊焦點，僅在媒體時間長度至少為 5 秒時顯示媒體通知。這樣可確保語音等附帶聲響不會顯示通知。

// 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> 指定)，媒體通知會使用這張圖片。
• Chrome for Android 的通知圖片目標大小為 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>

讓使用者控制正在播放的內容

媒體工作階段動作是指使用者與目前媒體播放內容互動時，網站可以處理的動作 (例如「播放」或「暫停」)。動作類似於事件，運作方式也與事件大同小異。與事件一樣，如要實作動作，就必須在適當物件 (即 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 範例。

資源

• 媒體工作階段規格：wicg.github.io/mediasession
• 規格問題：github.com/WICG/mediasession/issues
• Chrome 錯誤：crbug.com