VideoFrame: metadata() method

Available in workersLimited availability

The metadata() method of the VideoFrame interface returns the metadata associated with the frame.

Syntax

metadata()

Parameters

None.

Return value

An object containing metadata describing the video frame, as specified by the WebCodecs VideoFrame Metadata Registry. This can contain the following properties:

• rtpTimestamp Optional
  • : The RTP timestamp of the corresponding encoded frame. Video frames originating from WebRTC sources will have rtpTimestamp metadata. This allows applications using a MediaStreamTrackProcessor (for example, to render decoded WebRTC frames to a <canvas>) to correlate each exposed frame with its original RTP transport timestamp. This is useful for example when aligning video with audio segments or debugging latency issues.

If the video frame doesn’t have any of the listed metadata items associated with it, metadata() will return an empty object.

Examples

Basic usage

const metadata = frame.metadata();

Specifications

Browser compatibility