CaptureController: increaseZoomLevel() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The CaptureController interface's increaseZoomLevel() method increases the captured display surface's zoom level by one increment.
The increaseZoomLevel() method must be invoked via transient activation. In addition, the user is asked for permission to share tabs when screen capture is first attempted; if the user denies permission the zoom level cannot be changed even with transient activation.
Syntax
increaseZoomLevel()
Parameters
None.
Return value
Exceptions
InvalidStateErrorDOMException-
Thrown when:
- The captured display surface is already at its maximum supported zoom level.
- An attempt is made to invoke
increaseZoomLevel()without transient activation.
NotAllowedErrorDOMException-
Thrown when:
- The page's
captured-surface-controlPermissions Policy does not permit the page to use the Captured Surface Control API. - Permission to capture the display surface is explicitly denied by the user.
- The page's
Examples
Basic increaseZoomLevel() usage
The following snippet adds an event listener to a button so that when it is clicked, the increaseZoom() function is called. This in turn calls the increaseZoomLevel() method, zooming the captured surface in.
// Create controller and start capture
const controller = new CaptureController();
videoElem.srcObject = await navigator.mediaDevices.getDisplayMedia({
controller,
});
// ...
incBtn.addEventListener("click", increaseZoom);
async function increaseZoom() {
try {
await controller.increaseZoomLevel();
} catch (e) {
console.log(e);
}
}
It is generally a best practice to call increaseZoomLevel() from within a try...catch block because the zoom level could be changed asynchronously by an entity other than the application, which might lead to an error being thrown. For example, the user might directly interact with the captured surface to zoom in or out.
See Using the Captured Surface Control API for a full working example.
Specifications
| Specification |
|---|
| Captured Surface Control # dom-capturecontroller-increasezoomlevel |
Browser compatibility
Loading…