HTML DOM
The cancelVideoFrameCallback() method of the HTMLVideoElement interface cancels a previously-registered video frame callback.
Syntax
cancelVideoFrameCallback(id)
Parameters
id- : A number representing the ID of the video frame callback you want to cancel. This will be the value returned by the corresponding HTMLVideoElement.requestVideoFrameCallback call.
Return value
None (undefined).
Examples
Canceling a video frame callback
This example shows how to use cancelVideoFrameCallback() to cancel a previously-registered video frame callback.
let videoCallbackId = null;
function updateCanvas(now, metadata) {
// Do something with the frame
// …
// Re-register the callback to run on the next frame
// It's important to update the videoCallbackId on each iteration
// so you can cancel the callback successfully
videoCallbackId = video.requestVideoFrameCallback(updateCanvas);
}
// Initial registration of the callback to run on the first frame
videoCallbackId = video.requestVideoFrameCallback(updateCanvas);
// …
// Cancel video frame callback using the latest videoCallbackId
if (videoCallbackId !== null) {
video.cancelVideoFrameCallback(videoCallbackId);
}
Specifications
Browser compatibility
See also
- The video element
- HTMLVideoElement.requestVideoFrameCallback()
- Perform efficient per-video-frame operations on video with
requestVideoFrameCallback()on developer.chrome.com (2023)
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
