HTMLMediaElement.play()

HTMLMediaElementplay() メソッドは、メディアの再生を開始しようとします。 再生が正常に開始されると解決するプロミス (Promise) を返します。

パーミッションの問題など、何らかの理由で再生を開始しなかった場合、そのプロミスは拒否されます。

構文

play()

引数

なし。

返値

再生が開始されたときに解決される、または何らかの理由で再生を開始できない場合は拒否されるプロミス (Promise) です。

メモ: 古いブラウザーは play() から値を返さない可能性があります。

例外

プロミスの拒否ハンドラーは,唯一の引数として渡された例外名で呼び出されます(従来の例外が投げられるのとは対照的です)。想定されるエラーは以下の通りです。

NotAllowedError DOMException

ユーザーエージェント(ブラウザー)またはオペレーティングシステムが、現在のコンテキストまたは状況においてメディアの再生を許可しない場合に提供さ れます。これは、例えば、ユーザーが「再生」ボタンをクリックして明示的にメディアの再生を開始することを要求している場合に発生する可能性があります。

NotSupportedError DOMException

メディアソース(例えば MediaStream, MediaSource, Blob, または File として指定可能)が、対応しているメディア形式を表していない場合に提供されます。

ブラウザーの実装の詳細、メディアプレーヤーの実装などによっては、他の例外が報告されることがあります。

使用上のメモ

「自動再生 (autoplay)」という用語は通常、読み込まれるとすぐにメディアの再生を開始するページを指すと考えられていますが、ウェブブラウザーの自動再生ポリシーは、play() の呼び出しを含むスクリプト起動によるメディアの再生にも適用されます。

ユーザーエージェントが自動またはスクリプト起動によるメディアの再生を許可しないように設定されている場合、play() を呼び出すと返されたプロミスが直ちに NotAllowedError で拒否されます。 ウェブサイトはこの状況に対処する準備をしておくべきです。 例えば、サイトには再生が自動的に開始されたことを前提としたユーザーインターフェイスを表示するのではなく、返されたプロミスが解決されたか拒否されたかに基づいて UI を更新する必要があります。 詳しくは、以下のを参照してください。

メモ: play() メソッドを使用すると、ユーザーはメディアの再生を許可するように要求され、返されたプロミスが解決されるまでに遅延が生じる可能性があります。 コードが即座の応答を期待していないことを確認してください。

自動再生および自動再生のブロックの詳細については、メディアおよびウェブオーディオ API の自動再生ガイドを参照してください。

この例では、再生が開始されたことを確認する方法と、ブロックされた自動再生を適切に処理する方法を示します。

let videoElem = document.getElementById("video");
let playButton = document.getElementById("playbutton");

playButton.addEventListener("click", handlePlayButton, false);
playVideo();

async function playVideo() {
  try {
    await videoElem.play();
    playButton.classList.add("playing");
  } catch(err) {
    playButton.classList.remove("playing");
  }
}

function handlePlayButton() {
  if (videoElem.paused) {
    playVideo();
  } else {
    videoElem.pause();
    playButton.classList.remove("playing");
  }
}

この例では、動画の再生は非同期 (async) 関数によってオンとオフをトグル切り替えします。動画を再生しようとし、成功した場合は playButton 要素のクラス名を "playing"(再生中)に設定します。 再生が開始されない場合、playButton 要素のクラスはクリアされ、既定の外観に戻ります。 これは、play() によって返されたプロミス (Promise) の解決または拒否を監視することによって、再生ボタンが実際の再生状態と一致することを保証します。

この例が実行されると、再生のオンとオフを切り替えるために使用する <video> 要素への参照を <button> と同様に収集することから始めます。 次に、再生トグルボタンの click イベントのイベントハンドラーを設定し、playVideo() を呼び出して自動的に再生を開始しようとします。

この例を Glitch でリアルタイムで試したり、リミックスしたりすることができます。

仕様書

Specification
HTML Standard
# dom-media-play-dev

ブラウザーの互換性

BCD tables only load in the browser

関連情報