CaptureController: decreaseZoomLevel() method

{{APIRef("Screen Capture API")}}{{SeeCompatTable}}{{SecureContext_Header}}

The {{domxref("CaptureController")}} interface's decreaseZoomLevel() method decreases the captured display surface's zoom level by one increment.

The decreaseZoomLevel() 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

decreaseZoomLevel()

Parameters

None.

Return value

A {{jsxref("Promise")}} that fulfills with {{jsxref("undefined")}}.

Exceptions

• InvalidStateError {{domxref("DOMException")}}
  • : Thrown when:
    • The captured display surface is already at its minimum supported zoom level.
    • An attempt is made to invoke decreaseZoomLevel() without transient activation.
• NotAllowedError {{domxref("DOMException")}}
  • : Thrown when:
    • The page's {{HTTPHeader("Permissions-Policy/captured-surface-control", "captured-surface-control")}} Permissions 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 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 {
    await 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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Screen Capture API
• {{domxref("MediaDevices.getDisplayMedia()")}}
• Using the Captured Surface Control API