video_frame_metadata_registry.src.html

<pre class='metadata'>
Title: WebCodecs VideoFrame Metadata Registry
Repository: w3c/webcodecs
Status: ED
Shortname: webcodecs-video-frame-metadata-registry
Level: none
Group: mediawg
ED: https://w3c.github.io/webcodecs/video_frame_metadata_registry.html
TR: https://www.w3.org/TR/webcodecs-video-frame-metadata-registry/
Editor: Youenn Fablet, w3cid 96458, Apple Inc., youenn@apple.com

Boilerplate: omit conformance

Abstract: This registry is intended to enumerate the metadata fields that can be attached
    to {{VideoFrame}} objects via the {{VideoFrameMetadata}} dictionary.

Markup Shorthands:css no, markdown yes, dfn yes
!Participate: <a href="https://github.com/w3c/webcodecs">Git Repository.</a>
!Participate: <a href="https://github.com/w3c/webcodecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/w3c/webcodecs/commits">https://github.com/w3c/webcodecs/commits</a>
</pre>


Registration Entry Requirements {#registration-entry-requirements}
==================================================================

To register an entry, file an issue in the
[WebCodecs GitHub issue tracker](https://github.com/w3c/webcodecs/issues/)
so it can be discussed and evaluated for compliance before being added to
the registry.

For the entry to be included, there needs to be interest from at least
one implementer in either the Media Working Group or the Working Group that
originated the registration entry specification. If the Media Working Group
reaches consensus to accept the candidate entry, send a pull request
(either by editors or by the party requesting the candidate registration)
that meets the following requirements:

1. Each metadata entry is defined as a separate {{VideoFrameMetadata}}
    dictionary member.
2. Each metadata entry must be serializable.
3. Each metadata entry must be defined by a W3C specification that has
    reached consensus in the originating Working Group.
4. The specification defining each metadata entry must provide clearly defined
    semantics. In particular, interactions with the media processing pipeline
    (encoders, decoders, renderers, etc.) should be well defined.

Once consensus is reached by the Media Working Group, the registry editors
will review and merge the pull request.

Existing entries may be changed after being published, through the same
process as candidate entries. Possible changes include modification of the
link to the public specification.

Existing entries may be deprecated. This requires Media Working Group
consensus, and if still active, consensus of the Working Group that
originated the registration entry specification.


VideoFrameMetadata members {#videoframemetadata-members}
========================================================

<table class='data'>
  <tr>
    <td>**member name**</td>
    <td>**public specification**</td>
  </tr>
  <tr>
    <td>segments</td>
    <td>[Human face segmentation](https://w3c.github.io/mediacapture-extensions/#human-face-segmentation)</td>
  </tr>
  <tr>
    <td>captureTime</td>
    <td>[Capture time](https://w3c.github.io/mediacapture-extensions/#dom-videoframemetadata-capturetime)</td>
  </tr>
  <tr>
    <td>receiveTime</td>
    <td>[Receive time](https://w3c.github.io/mediacapture-extensions/#dom-videoframemetadata-receivetime)</td>
  </tr>
  <tr>
    <td>rtpTimestamp</td>
    <td>[RTP timestamp](https://w3c.github.io/mediacapture-extensions/#dom-videoframemetadata-rtptimestamp)</td>
  </tr>
  <tr>
    <td>backgroundBlur</td>
    <td>[Background blur effect status](https://w3c.github.io/mediacapture-extensions/#background-blur-effect-status)</td>
  </tr>
  <tr>
    <td>backgroundSegmentationMask</td>
    <td>[Background segmentation mask](https://w3c.github.io/mediacapture-extensions/#background-segmentation-mask)</td>
  </tr>
</table>


Privacy Considerations {#privacy-considerations}
================================================

Please refer to the section [[WEBCODECS#privacy-considerations|Privacy
Considerations]] in [[WEBCODECS]].

Security Considerations {#security-considerations}
==================================================

Please refer to the section [[WEBCODECS#security-considerations|Security
Considerations]] in [[WEBCODECS]].