大网数据广告活动
Web 标准与前端开发

RTCEncodedVideoFrame: getMetadata() method

· 52CE 我爱测

The **`getMetadata()`** method of the RTCEncodedVideoFrame interface returns an object containing the metadata associated with the frame.

WebRTCwindow_and_dedicated

The getMetadata() method of the RTCEncodedVideoFrame interface returns an object containing the metadata associated with the frame.

This includes information about the frame, such as its size, video encoding, other frames needed to construct a full image, timestamp, and other information.

Syntax

getMetadata()

Parameters

None.

Return value

An object with the following properties:

  • contributingSources
    • : An Array of sources (ssrc) that have contributed to the frame. Consider the case of a conferencing application that combines the audio and video from multiple users. The synchronizationSource would include the ssrc of the application, while contributingSources would include the ssrc values of all the individual video and audio sources.
  • dependencies
    • : An Array of positive integers indicating the frameIds of frames on which this frame depends. For a key frame this will be empty, as a key frame contains all the information it needs to construct the image. For a delta frame this will list all the frames needed to render this frame. The type of frame can be determined using RTCEncodedVideoFrame.type.
  • frameId
    • : A positive integer value indicating the id of this frame.
  • height
    • : A positive integer indicating the height of the frame. The maximum value is 65535.
  • mimeType
    • : A string containing the MIME type of the codec used, such as "video/VP8".
  • payloadType
    • : A positive integer value in the range from 0 to 127 that describes the format of the RTP payload. The mappings of values to formats is defined in RFC3550.
  • receiveTime
    • : A DOMHighResTimeStamp indicating the timestamp of the last received packet of an incoming frame (from an RTCRtpReceiver) used to produce this media frame, relative to Performance.timeOrigin.
  • rtpTimestamp
    • : A positive integer that reflects the sampling instant of the first octet in the RTP data packet (see 3550).
  • spatialIndex
    • : A positive integer indicating the spatial index of the frame. Some codecs allow generation of layers of frames with different layers of resolutions. Frames in higher layers can be selectively dropped in order to reduce bit rate when needed, while maintaining acceptable video quality.
  • synchronizationSource
    • : A positive integer value indicating synchronization source ("ssrc") of the stream of RTP packets that are described by this encoded video frame. A source might be something like a camera or microphone, or some kind of mixer app that combines multiple sources. All packets from the same source share the same time source and sequence space, and so can be ordered relative to each other. Note two frames with the same value refer to the same source (for more information see RTCInboundRtpStreamStats.ssrc).
  • temporalIndex
    • : A positive integer indicating the temporal index of the frame. Some codecs group frames in layers, based on whether dropping a frame will prevent others from being decoded. Frames in higher layers can be selectively dropped in order to reduce bit rate when needed, while maintaining acceptable video quality.
  • width
    • : A positive integer indicating the width of the frame. The maximum value is 65535.

Examples

This example WebRTC encoded transform implementation shows how you might get the frame metadata in a transform() function and log it.

addEventListener("rtctransform", (event) => {
  const transform = new TransformStream({
    async transform(encodedFrame, controller) {
      // Get the metadata and log
      const frameMetaData = encodedFrame.getMetadata();
      console.log(frameMetaData);

      // Enqueue the frame without modifying
      controller.enqueue(encodedFrame);
    },
  });
  event.transformer.readable
    .pipeThrough(transform)
    .pipeTo(event.transformer.writable);
});

The resulting object from a local webcam might look like the one shown below. Note that there are no contributing sources because there is just one source.

{
  "contributingSources": [],
  "mimeType": "video/VP8",
  "payloadType": 96,
  "rtpTimestamp": 2503280194,
  "synchronizationSource": 1736709460,
  "dependencies": [],
  "frameId": 1,
  "height": 240,
  "spatialIndex": 0,
  "temporalIndex": 0,
  "width": 320
}

Specifications

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。