自動再生ポリシー検出

1. 導入

現在、この仕様は HTMLMediaElement (video および audio) と Web Audio API のみを扱います。この仕様は Web Speech API や アニメーション画像 (image、GIFアニメーション) には対応しません。

2. 自動再生検出API

2.1. 自動再生ポリシー列挙型

enum AutoplayPolicy {
  "allowed",
  "allowed-muted",
  "disallowed"
};

2.2. 自動再生検出メソッド

enum AutoplayPolicyMediaType { "mediaelement", "audiocontext" };

[Exposed=Window]
partial interface Navigator {
  AutoplayPolicy getAutoplayPolicy(AutoplayPolicyMediaType type);
  AutoplayPolicy getAutoplayPolicy(HTMLMediaElement element);
  AutoplayPolicy getAutoplayPolicy(AudioContext context);
};

2.2.1. メディアタイプによる照会

getAutoplayPolicy(type) メソッドが呼ばれた場合、 ユーザーエージェントは以下の手順を実行しなければなりません:

1. type が mediaelement なら、 HTMLMediaElement や HTMLVideoElement ・ HTMLAudioElement など拡張が document に存在し、 問い合わせた Navigator オブジェクトに関連付けられた Window オブジェクトの現在の状態を表す結果を返す。
2. type が audiocontext なら、 AudioContext が document に存在し、 問い合わせた Navigator オブジェクトに関連付けられた Window オブジェクトの現在の状態を表す結果を返す。

返値が allowed の場合

指定されたタイプのすべてのメディアが自動再生可能です。

返値が allowed-muted の場合

指定されたタイプのすべての音が出ないメディアは自動再生可能です。

注意: この属性は、指定されたメディアタイプが mediaelement の場合のみ返されます。 "音が出ないメディア" とは 音が出ないメディア要素 のことです。

返値が disallowed の場合

指定されたタイプの いかなるメディアも 自動再生はできません。

2.2.2. 要素による照会

返値が allowed の場合

この要素は現在の実行コンテキストで自動再生が許可されています。

返値が allowed-muted の場合

この要素は、音が出ない場合にのみ自動再生が許可されます。

注意: この属性は、指定された要素が HTMLMediaElement または HTMLVideoElement や HTMLAudioElement などの拡張の場合のみ返されます。"音が出ないメディア"は 音が出ないメディア要素 のことです。

さらに、著者が音が出ないメディア要素を再生開始直後に音が出るようにした場合は、 その要素がもはや音が出ない状態ではなくなるため、ユーザーエージェントはそのメディア要素をすぐに一時停止することが推奨されます。

返値が disallowed の場合

この要素は自動再生が許可されていません。

注意: HTMLMediaElement で play() を実行した場合、 play() から返されるPromiseは NotAllowedError 例外で拒否されます。

AudioContext の場合は、 AudioContextState が suspended 状態のままになります。

メディアタイプによる照会結果と要素による照会結果が異なる場合、 著者は後者（要素による結果）を正しいものとして扱うべきです。例2にシナリオを示します。

3. 例

if (navigator.getAutoplayPolicy("mediaelement") === "allowed") {
  // 新しいメディア要素を生成し再生する。
} else if (navigator.getAutoplayPolicy("mediaelement") === "allowed-muted") {
  // 新しいメディア要素を生成し、ミュート再生にする。
} else {
  // 自動再生不可。代わりにポスター画像を表示するなど。
}

if (navigator.getAutoplayPolicy("audiocontext") === "allowed") {
  let ac = new AudioContext();
  ac.onstatechange = function() {
    if (ac.state === "running") {
      // オーディオアプリ開始。
    }
  }
} else {
  // オーディオコンテキストは開始不可。UI表示でユーザーに開始操作を促す。ac.resume()ハンドラから実行し、'onstatechange'で準備完了を検知。
}

function handlePlaySucceeded() {
  // コントロールUIを再生中に更新。
}
function handlePlayFailed() {
  // ユーザーが明示的に動画を再生できるボタン表示 & 画像ポスターで動画を置換表示。
}

let video = document.getElementById("video");
switch (navigator.getAutoplayPolicy(video)) {
  case "allowed":
    video.src = "video.webm";
    video.play().then(handlePlaySucceeded, handlePlayFailed);
    break;
  case "allowed-muted":
    video.src = "video.webm";
    video.muted = true;
    video.play().then(handlePlaySucceeded, handlePlayFailed);
    break;
  default:
    // 自動再生不可。リソースダウンロード不要。
    handlePlayFailed();
    break;
}

let ac = new AudioContext();
if (navigator.getAutoplayPolicy(ac) === "allowed") {
  ac.onstatechange = function() {
    if (ac.state === "running") {
      // オーディオアプリ開始。
    }
  }
} else {
  // UIでユーザーにアプリ開始操作を促す。ac.resume()ハンドラから実行、'onstatechange'でスタック準備完了検知。
}

4. セキュリティとプライバシーの考慮事項

この仕様で導入されるAPIは、セキュリティおよびプライバシーへの影響が非常に低いです。 ユーザーの識別に使えるような機微情報は公開しません。 センサーやユーザーの端末の制御機能も公開しません。 オリジンに対して、ブラウズセッションをまたいで記憶される新たな状態の導入はありません。 オリジンが基盤プラットフォームにデータ送信することもできません。 新たなスクリプト実行やロード機構も導入・有効化しません。 オリジンがユーザーエージェントのネイティブUIに重ね描画することもありません。 オリジンがユーザーのプライベート閲覧か非プライベートかを検知することもありません。

5. 謝辞

編者はこの仕様への貢献者として Alastor Wu, Becca Hughes, Christoph Guttandin, Chris Needham, Chris Pearce, Dale Curtis, Eric Carlson, François Daoust, Frank Liberato, Gary Katsevman, Jean-Yves Avenard, Jer Noble, Mattias Buelens, Mounir Lamouri, Paul Adenot および Tom Jenkinson に感謝します。