Document: exitPictureInPicture() メソッド

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

exitPictureInPicture() はDocument インターフェイスのメソッドで、この文書に含まれ、現在浮動している動画をピクチャインピクチャモードから外し、画面の前回状態に戻すようリクエストします。これは通常、HTMLVideoElement.requestPictureInPicture() を前回呼び出したときの効果を逆転させます。

構文

exitPictureInPicture()

返値

プロミス (Promise) で、ユーザーエージェントがピクチャインピクチャモードを終了した時点で解決されます。全画面モードを終了しようとしてエラーが発生した場合、プロミスのcatch() ハンドラーが呼び出されます。

例外

InvalidStateErrorDOMException: document.pictureInPictureElement がnull の場合に発生します。

例

この例では、現在の文書内でマウスボタンがクリックされるたびに、ピクチャインピクチャモードを終了させます。

document.onclick = (event) => {  if (document.pictureInPictureElement) {    document      .exitPictureInPicture()      .then(() => console.log("Document Exited from Picture-in-Picture mode"))      .catch((err) => console.error(err));  } else {    video.requestPictureInPicture();  }};

ページ上のどの動画が現在ピクチャインピクチャモードで再生されているかを追跡する予定であれば、HTMLVideoElement 要素上のenterpictureinpicture とexitpictureinpicture イベントを待ち受けなければならないことに注意してください。あるいは、Document.pictureInPictureElement が現在のHTMLVideoElement 要素を参照しているかどうかを調べることもできます。