CaptureController: decreaseZoomLevel() 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 decreaseZoomLevel()
method decreases the captured display surface's zoom percentage to the next level down.
Syntax
decreaseZoomLevel()
Parameters
None.
Return value
Exceptions
InvalidStateError
DOMException
-
The captured display surface is already at its minimum supported zoom level.
NotAllowedError
DOMException
-
The operation is disallowed by a
captured-surface-control
Permissions Policy.
Examples
Basic decreaseZoomLevel()
usage
The following snippet adds an event listener to a button so that when it is clicked, the decreaseZoom()
function is called. This in turn calls the decreaseZoomLevel()
method, zooming the captured surface out.
// Create controller and start capture
const controller = new CaptureController();
videoElem.srcObject = await navigator.mediaDevices.getDisplayMedia({
controller,
});
// ...
decBtn.addEventListener("click", decreaseZoom);
async function decreaseZoom() {
try {
controller.decreaseZoomLevel();
} catch (e) {
console.log(e);
}
}
It is generally a best practice to call decreaseZoomLevel()
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-decreasezoomlevel |