RTCVideoSourceStats: height property

The height property of the RTCVideoSourceStats dictionary indicates the height, in pixels, of the last frame originating from this source.

This property is not defined on the stats object until after the first frame has been produced.

Value

A positive number indicating the height, in pixels.

Examples

This example shows how you might iterate the stats object returned from RTCRtpSender.getStats() to get the video source stats, and then extract the height.

js
// where sender is an RTCRtpSender
const stats = await sender.getStats();
let videoSourceStats = null;

stats.forEach((report) => {
  if (report.type === "media-source" && report.kind==="video") {
    videoSourceStats = report;
    break;
  }
});

// Note, test is conditional in case the stats object
// does not include video source stats
const height = videoSourceStats?.height;

Specifications

Specification
Identifiers for WebRTC's Statistics API
# dom-rtcvideosourcestats-height

Browser compatibility

Report problems with this compatibility data on GitHub
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
height in 'media-source' stats for video

Tip: you can click/tap on a cell for more information.

Full support
No support