ImageCapture: grabFrame() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("Image Capture API")}}
The **grabFrame()** method of the {{domxref("ImageCapture")}} interface takes a snapshot of the live video in a {{domxref("MediaStreamTrack")}} and returns a {{jsxref("Promise")}} that resolves with an {{domxref("ImageBitmap")}} containing the snapshot.
Syntax
grabFrame()Parameters
None.
Return value
A {{jsxref("Promise")}} that resolves to an {{domxref("ImageBitmap")}} object.
Exceptions
InvalidStateError{{domxref("DOMException")}}- : Thrown if
readyStateproperty of theMediaStreamTrackpassing in the constructor is notlive. UnknownError{{domxref("DOMException")}}- : Thrown if the operation can't complete for any reason.
Examples
This example is extracted from this Simple Image Capture demo. It shows how to use the {{jsxref("Promise")}} returned by grabFrame() to copy the returned frame to a {{htmlelement("canvas")}} element. For simplicity it does not show how to instantiate the {{domxref("ImageCapture")}} object.
let grabFrameButton = document.querySelector("button#grabFrame");
let canvas = document.querySelector("canvas");
grabFrameButton.onclick = grabFrame;
function grabFrame() {
imageCapture
.grabFrame()
.then((imageBitmap) => {
console.log("Grabbed frame:", imageBitmap);
canvas.width = imageBitmap.width;
canvas.height = imageBitmap.height;
canvas.getContext("2d").drawImage(imageBitmap, 0, 0);
canvas.classList.remove("hidden");
})
.catch((error) => {
console.error("grabFrame() error: ", error);
});
}Specifications
{{Specifications}}
Browser compatibility
{{Compat}}