CaptureController: resetZoomLevel() method

Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

TheCaptureController interface'sresetZoomLevel() method resets the captured display surface's zoom to its initial level, which is100.

TheresetZoomLevel() method must be invoked viatransient 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

resetZoomLevel()

Parameters

None.

Return value

APromise that fulfills withundefined.

Exceptions

InvalidStateErrorDOMException

An attempt is made to invokeresetZoomLevel() without transient activation.

NotAllowedErrorDOMException

Thrown when:

The page'scaptured-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.

Examples

Basic`resetZoomLevel()` usage

The following snippet adds an event listener to a button so that when it is clicked, theresetZoom() function is called. This in turn calls theresetZoomLevel() method, resetting the captured surface's zoom level to100.

// Create controller and start captureconst controller = new CaptureController();videoElem.srcObject = await navigator.mediaDevices.getDisplayMedia({  controller,});// ...resetBtn.addEventListener("click", resetZoom);async function resetZoom() {  await controller.resetZoomLevel();}

SeeUsing the Captured Surface Control API for a full working example.