CaptureController: setFocusBehavior() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

See full compatibility

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 setFocusBehavior() method controls whether the captured tab or window will be focused when an associated MediaDevices.getDisplayMedia() Promise fulfills, or whether the focus will remain with the tab containing the capturing app.

You can set this behavior multiple times before the MediaDevices.getDisplayMedia() call, or once immediately after its Promise resolves. After that, the focus behavior is said to be finalized, and can't be changed.

Syntax

setFocusBehavior(focusBehavior)

Parameters

focusBehavior: An enumerated value that describes whether the user agent should transfer focus to the captured display surface, or keep the capturing app focused. Possible values are focus-captured-surface (transfer focus) and no-focus-change (keep focus on the capturing app).

Return value

None (undefined).

Exceptions

InvalidStateError DOMException

Thrown if:

The capture stream has been stopped.
The user chose to share a screen (displaySurface type monitor) rather than a browser tab or window — you can't focus a monitor. In this case the exception is thrown after the MediaDevices.getDisplayMedia() Promise resolves.
Enough time has elapsed after the MediaDevices.getDisplayMedia() Promise fulfills that the focus behavior has been finalized.

Examples

Basic `setFocusBehavior()` usage

// Create a new CaptureController instance
const controller = new CaptureController();

// Prompt the user to share a tab, window, or screen.
const stream = await navigator.mediaDevices.getDisplayMedia({ controller });

// Query the displaySurface value of the captured video track
const [track] = stream.getVideoTracks();
const displaySurface = track.getSettings().displaySurface;

if (displaySurface === "browser") {
  // Focus the captured tab.
  controller.setFocusBehavior("focus-captured-surface");
} else if (displaySurface === "window") {
  // Do not move focus to the captured window.
  // Keep the capturing page focused.
  controller.setFocusBehavior("no-focus-change");
}

Specifications

Specification
Screen Capture # dom-capturecontroller-setfocusbehavior

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`setFocusBehavior` Experimental	Chrome – Full support Chrome 109 (Release date: 2023-01-10) footnote Full support	Edge – Full support Edge 109 (Release date: 2023-01-12) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 95 (Release date: 2023-02-01) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – No support Chrome Android footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – No support Opera Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – No support Samsung Internet footnote No support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: Experimental. Expect behavior to change in the future.

CaptureController: setFocusBehavior() method

Legend