Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add docs for *VideoFrameCallback() methods #31762

Merged

Conversation

chrisdavidmills
Copy link
Contributor

@chrisdavidmills chrisdavidmills commented Jan 17, 2024

Description

HTMLVideoElement.requestVideoFrameCallback() and HTMLVideoElement.cancelVideoFrameCallback() have been supported in Chrome since version 83, and Safari since 15.4, but we haven't yet published docs for them.

This PR fixes that.

See https://web.dev/articles/requestvideoframecallback-rvfc for a useful test demo.

Motivation

Additional details

Related issues and pull requests

@chrisdavidmills chrisdavidmills requested a review from a team as a code owner January 17, 2024 14:39
@chrisdavidmills chrisdavidmills requested review from Elchi3 and removed request for a team January 17, 2024 14:39
@github-actions github-actions bot added the Content:WebAPI Web API docs label Jan 17, 2024
@chrisdavidmills chrisdavidmills changed the title Add docs for *VideoFrameCallback() methods feat: Add docs for *VideoFrameCallback() methods Jan 17, 2024
@github-actions github-actions bot added the size/xl [PR only] >1000 LoC changed label Jan 17, 2024
Copy link
Contributor

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

Copy link
Contributor

github-actions bot commented Jan 17, 2024

Preview URLs

Flaws (7)

Note! 2 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/HTMLVideoElement
Title: HTMLVideoElement
Flaw count: 7

  • macros:
    • /en-US/docs/Web/API/HTMLVideoElement/poster does not exist
    • /en-US/docs/Web/API/HTMLVideoElement/mozParsedFrames does not exist
    • /en-US/docs/Web/API/HTMLVideoElement/mozDecodedFrames does not exist
    • /en-US/docs/Web/API/HTMLVideoElement/mozPresentedFrames does not exist
    • /en-US/docs/Web/API/HTMLVideoElement/mozPaintedFrames does not exist
    • and 2 more flaws omitted
External URLs (3)

URL: /en-US/docs/Web/API/HTMLVideoElement/requestVideoFrameCallback
Title: HTMLVideoElement: requestVideoFrameCallback() method


URL: /en-US/docs/Web/API/HTMLVideoElement/cancelVideoFrameCallback
Title: HTMLVideoElement: cancelVideoFrameCallback() method

(comment last updated: 2024-01-25 18:12:13)

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as outdated.

Copy link
Contributor

@tomayac tomayac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-owner LGTM with the suggestions applied.

Copy link
Contributor

@tomayac tomayac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to go, with one remark and one suggestion.

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @chrisdavidmills, I've done a readthrough and left a few suggestions.

@chrisdavidmills
Copy link
Contributor Author

Thank you so much for the thorough and helpful review, @dipikabh! I think I've fixed everything; let me know if you think it needs anything else.

@chrisdavidmills chrisdavidmills removed the request for review from Elchi3 January 25, 2024 11:32
Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All fixes look good, @chrisdavidmills. Thanks for taking the time to leave your responses :)

There's just two minor things, but the pages are looking in good shape. Feel free to merge when ready. Thank you for adding the docs!

@chrisdavidmills chrisdavidmills merged commit 66c21fa into mdn:main Jan 25, 2024
8 checks passed
@chrisdavidmills chrisdavidmills deleted the add-videoframecallback-methods branch January 25, 2024 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/xl [PR only] >1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants