Clarify that all VideoFrameMetadata members are optional
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.3k
- Forks
- 194
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
The spec says:
dictionary VideoFrameMetadata {
// Possible members are recorded in the VideoFrame Metadata Registry.
};
But the [webcodecs-video-frame-metadata-registry] does not say whether members are optional or required.
Since dictionary members are optional by default, readers will hopefully infer (correctly) that they're optional, since neither spec mentions required.
Readers might also infer this from VideoFrameInit where metadata is not required, if I'm not mistaken.
Still, it might be good to call this out, since a single required member would mean the VideoFrame constructor would suddenly require this input and no longer be backwards compatible.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the VideoFrameMetadata dictionary definition and the VideoFrame Metadata Registry in the linked WebCodecs specification, then check the VideoFrameInit metadata member for consistency. Done means the specification explicitly states that all VideoFrameMetadata members are optional without changing the intended constructor behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100