HTMLVideoElement: cancelVideoFrameCallback() メソッド

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.

cancelVideoFrameCallback()HTMLVideoElement インターフェイスのメソッドで、以前登録された映像フレームコールバックを取り消します。

構文

js
cancelVideoFrameCallback(id)

引数

id

数値で、取り消そうとしている映像フレームコールバックの ID を表します。これは、対応する HTMLVideoElement.requestVideoFrameCallback 呼び出しによって返される値です。

返値

なし (undefined)。

映像フレームコールバックの取り消し

この例では、以前に登録した映像フレームコールバックを取り消すために、cancelVideoFrameCallback() を使用する方法を示しています。

js
const updateCanvas = (now, metadata) => {
  // フレームで何かを行う

  // ...

  // 次のフレームで動作するようにコールバックを再登録する
  // 動画コールバック ID を反復処理するごとに更新することが重要
  // そうすることで、コールバックを正常に取り消すことができる
  videoCallbackId = video.requestVideoFrameCallback(updateCanvas);
};

// 最初のフレームで実行するコールバックの初期登録
let videoCallbackId = video.requestVideoFrameCallback(updateCanvas);

// ...

// 最新の videoCallbackId を使用して映像フレームコールバックをキャンセルする
video.cancelVideoFrameCallback(videoCallbackId);

仕様書

Specification
HTMLVideoElement.requestVideoFrameCallback()
# dom-htmlvideoelement-cancelvideoframecallback

ブラウザーの互換性

BCD tables only load in the browser

関連情報