HTMLMediaElement: load() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

HTMLMediaElementload() メソッドは、メディア要素をその初期状態にリセットし、再生を開始する準備としてメディアソースを選択してメディアを読み込むプロセスを開始します。

先読みされるメディアデータの量は、要素の preload 属性の値によって決まります。

このメソッドは通常、要素の src 属性を変更するか、メディア要素自体の中にネストされている <source> 要素を追加または削除することによって、メディア要素に使用可能な一連のソースを動的に変更した場合にのみ役立ちます。 load() は要素をリセットして利用可能なソースを再スキャンし、それによって変更を有効にします。

構文

js
load()

引数

なし。

返値

なし (undefined)。

使用上のメモ

load() を呼び出すと、このメディア要素を含む進行中のすべての操作が中止され、<audio> 要素または <video> 要素で指定されたオプションとその src 属性または子の <source> 要素を指定して適切なメディアリソースの選択と読み込みのプロセスが開始されます。 これについては、動画と音声のコンテンツで詳しく説明しています。

進行中のアクティビティを中止するプロセスにより、 play() によって返された未処理のプロミス (Promise) が、新しいメディアの読み込みが開始される前に、そのステータスに基づいて適切に解決または拒否されます。保留中の再生用のプロミスは、 "AbortError" DOMException で中止されます。

読み込みプロセスが進むにつれて、次のように適切なイベントがメディア要素自体に送信されます。

  • 要素がすでにメディアの読み込み処理中の場合、その読み込み処理は中止され、 abort イベントが送信されます。
  • 要素がすでにメディアで初期化されている場合は、 emptied イベントが送信されます。
  • 再生位置をメディアの先頭にリセットすると、実際に再生位置が変更された場合(つまり、まだ先頭になっていない場合)、 timeupdate イベントが送信されます。
  • メディアが選択され、読み込みの開始準備が整うと、 loadstart イベントが配信されます。
  • これ以降は、メディアの読み込みと同じようにイベントが送信されます。

この例では、文書内の <video> 要素を見つけて、load() を呼び出してそれをリセットします。

js
const mediaElem = document.querySelector("video");
mediaElem.load();

仕様書

Specification
HTML Standard
# dom-media-load-dev

ブラウザーの互換性

BCD tables only load in the browser