HTMLCanvasElement: captureStream() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("Media Capture and Streams")}}
The **captureStream()** method of the {{domxref("HTMLCanvasElement")}} interface returns a {{domxref("MediaStream")}} which includes a {{domxref("CanvasCaptureMediaStreamTrack")}} containing a real-time video capture of the canvas's contents.
Syntax
captureStream()
captureStream(frameRate)Parameters
frameRate{{optional_inline}}- : A double-precision floating-point value that indicates the rate of capture of each
frame. If not set, a new frame will be captured each time the canvas changes; if set to 0, frames will not be captured automatically; instead, they will only be captured when the returned track's {{domxref("CanvasCaptureMediaStreamTrack.requestFrame", "requestFrame()")}} method is called.
Return value
A reference to a {{domxref("MediaStream")}} object, which has a single {{domxref("CanvasCaptureMediaStreamTrack")}} in it.
Exceptions
NotSupportedError{{domxref("DOMException")}}- : Thrown if the value of
frameRateis negative.
SecurityError{{domxref("DOMException")}}- : The canvas's bitmap is not origin clean;
at least some of its contents have or may have been loaded from a site other than the one from which the document itself was loaded.
Example
// Find the canvas element to capture
const canvasElt = document.querySelector("canvas");
// Get the stream
const stream = canvasElt.captureStream(25); // 25 FPS
// Do things to the stream
// E.g. Send it to another computer using an RTCPeerConnection
// pc is an RTCPeerConnection created elsewhere
stream.getTracks().forEach((track) => pc.addTrack(track, stream));Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- {{domxref("HTMLMediaElement.captureStream()")}}, which allows capturing a stream
from a media element.
- {{domxref("MediaStream")}}
- Media Capture and Streams API