HTMLVideoElement: cancelVideoFrameCallback() method

Baseline 2024

Newly available

Since ⁨October 2024⁩, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

ThecancelVideoFrameCallback() method of theHTMLVideoElement 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 correspondingHTMLVideoElement.requestVideoFrameCallback call.

Return value

None (undefined).

Examples

Canceling a video frame callback

This example shows how to usecancelVideoFrameCallback() 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 framevideoCallbackId = video.requestVideoFrameCallback(updateCanvas);// …// Cancel video frame callback using the latest videoCallbackIdif (videoCallbackId !== null) {  video.cancelVideoFrameCallback(videoCallbackId);}