VideoFrame: metadata() method
Note: This feature is available in Dedicated Web Workers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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:
rtpTimestampOptional-
The RTP timestamp of the corresponding encoded frame. Video frames originating from WebRTC sources will have
rtpTimestampmetadata. This allows applications using aMediaStreamTrackProcessor(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
| Specification |
|---|
| WebCodecs # dom-videoframe-metadata |