RTCVideoSourceStats

Baseline2023 *

Since May 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

* Some parts of this feature may have varying levels of support.

TheRTCVideoSourceStats dictionary of theWebRTC API provides statistics information about a video track (MediaStreamTrack) that is attached to one or more senders (RTCRtpSender).

These statistics can be obtained by iterating theRTCStatsReport returned byRTCRtpSender.getStats() orRTCPeerConnection.getStats() until you find a report with thetype ofmedia-source and akind ofvideo.

Note:For video information about remotely sourced tracks (that are being received), seeRTCInboundRtpStreamStats.

Instance properties

framesOptional: A positive number that indicates the total number of frames originating from this video source.
framesPerSecondOptional: A positive number that represents the number of frames originating from this video source in the last second.This property is not defined on this stats object for the first second of its existence.
heightOptional: A number that represents the height, in pixels, of the last frame originating from this source.This property is not defined on this stats object until after the first frame has been produced.
widthOptional: A number that represents the width, in pixels, of the most recent frame originating from this source.This property is not defined on this stats object until after the first frame has been produced.

Common media-source properties

The following properties are present in bothRTCVideoSourceStats andRTCAudioSourceStats:

trackIdentifier: A string that contains theid value of theMediaStreamTrack associated with the video source.
kind: A string indicating whether this object represents stats for a video source or a media source. For anRTCVideoSourceStats this will always bevideo.

Common instance properties

The following properties are common to all statistics objects.

id: A string that uniquely identifies the object that is being monitored to produce this set of statistics.
timestamp: ADOMHighResTimeStamp object indicating the time at which the sample was taken for this statistics object.
type: A string with the value"media-source", indicating that the object is an instance of eitherRTCAudioSourceStats orRTCVideoSourceStats.

The interface provides statistics about a video media source attached to one or more senders.The information includes a identifier for the associatedMediaStreamTrack, along with the height and width of the last frame sent from the source, the number of frames sent from the source, and the frame rate.

Examples

This example shows how you might iterate the stats object returned fromRTCRtpSender.getStats() to get the video-specific media-source stats.

// where sender is an RTCRtpSenderconst stats = await sender.getStats();let videoSourceStats = null;stats.forEach((report) => {  if (report.type === "media-source" && report.kind==="video") {    videoSourceStats = report;    break;  }});// videoSourceStats will be null if the report did not include video source statsconst frames = videoSourceStats?.frames;const fps = videoSourceStats?.framesPerSecond;const width = videoSourceStats?.width;const height = videoSourceStats?.height;