ScreenShareCaptureOptions

Options for capturing a screen share.

Properties

audio?: boolean | AudioCaptureOptions;

true to capture audio shared alongside the screen. Browser support for audio capturing in screen share is limited.

contentHint?: "detail" | "text" | "motion";

Specify the type of content.

controller?: unknown;

A CaptureController instance for further manipulation of the capture session if included.

frameRate?: number;

Target frame rate for the screen share capture.

preferCurrentTab?: boolean;

Experimental

Instructs the browser to offer the current tab as the most prominent capture source.

resolution?: VideoResolution;

Capture resolution. Defaults to 1080 for most browsers.

selfBrowserSurface?: "include" | "exclude";

Specifies whether the browser should allow the user to select the current tab for capture.

suppressLocalAudioPlayback?: boolean;

Experimental

Controls whether the audio playing in a tab will continue to be played out of a user’s local speakers when the tab is captured.

surfaceSwitching?: "include" | "exclude";

Specifies whether the browser should display a control to allow the user to dynamically switch the shared tab during screen-sharing.

systemAudio?: "include" | "exclude";

Specifies whether the browser should include the system audio among the possible audio sources offered to the user.

video?:
  | true
  | {
  displaySurface?: "window" | "browser" | "monitor";
};

true to capture video. Chrome allows additional options.