RTCTrackEvent

RTCTrackEvent()

Creates and returns a new RTCTrackEvent object. You will probably not need to create new track events yourself, since they're typically created by the WebRTC infrastructure and sent to the connection's ontrack event handler.

Since RTCTrackEvent is based on Event, its properties are also available.

receiver Read only

The RTCRtpReceiver used by the track that's been added to the RTCPeerConnection.

streams Read only Optional

An array of MediaStream objects, each representing one of the media streams to which the added track belongs. By default, the array is empty, indicating a streamless track.

track Read only

The MediaStreamTrack which has been added to the connection.

transceiver Read only

The RTCRtpTransceiver being used by the new track.

There is only one type of track event.

The track event is sent to the RTCPeerConnection when a new track has been added to the connection. By the time the track event is delivered to the RTCPeerConnection's ontrack handler, the new media has completed its negotiation for a specific RTCRtpReceiver (which is specified by the event's receiver property).

In addition, the MediaStreamTrack specified by the receiver's track is the same one specified by the event's track, and the track has been added to any associated remote MediaStream objects.

You can add a track event listener to be notified when the new track is available so that you can, for example, attach its media to a <video> element, using either RTCPeerConnection.addEventListener() or the ontrack event handler property.

This simple example creates an event listener for the track event which sets the srcObject of the <video> element with the ID video-box to the first stream in the list passed in the event's streams array.

peerConnection.addEventListener(
  "track",
  (e) => {
    let videoElement = document.getElementById("video-box");
    videoElement.srcObject = e.streams[0];
  },
  false,
);