MediaStream.onaddtrack

MediaStream.onaddtrack プロパティは、event handlerであり、MediaStreamインスタンスでaddtrackイベントが発生した時に呼び出される関数です。このイベントは、メディアストリームへ新しいトラックが追加された時に発生します。このイベントはブラウザがストリームへ新しいトラックを追加した時に発生します。たとえば、RTCPeerConnectionが再交渉された時や、HTMLMediaElement.captureStream()を用いてキャプチャーが開始されたストリームが、新しいトラックを取得した時です。

JavaScriptのコードによって明示的にストリームへトラックを追加した場合(addTrack()の呼び出しによるもの)は、addtrackイベントは発生しません。

文法

MediaStream.onaddtrack = eventHandler;

どのトラックでaddtrackイベントが発生したのかを表現するためのMediaStreamTrackEvent (en-US)オブジェクトを引数として受け取る関数を設定してください。追加されたトラックは、イベントのtrackプロパティで表されます。

この例では、新しいトラックがストリームへ追加された時に、トラックのリストへ新しいアイテムを追加しています。新しいアイテムには、トラックのkind("audio"または"video")とlabelが表示されます。

stream.onaddtrack = function(event) {
  let trackList = document.getElementById("tracks");
  let label = document.createElement("li");

  label.innerHTML = event.track.kind + ": " + event.track.label;
  trackList.appendChild(label);
};

仕様

仕様 状況 コメント
Media Capture and Streams
MediaStream.onaddtrack の定義
勧告候補 初版

ブラウザ互換性

BCD tables only load in the browser

関連項目