ScreenCaptureConfiguration

Screen capture configuration.

export class ScreenCaptureConfiguration {
  
  isCaptureWindow?: boolean;
  
  displayId?: number;
  
  screenRect?: Rectangle;
  
  windowId?: any;
  
  params?: ScreenCaptureParameters;
  
  regionRect?: Rectangle;
}

Properties

isCaptureWindow

Whether to capture a window on the screen:

true: Capture the window.
false: (Default) Capture the screen, not the window.

displayId

(macOS only) Display ID of the screen.

Note: Use this parameter only when capturing the screen on Mac devices.

screenRect

(Windows only) Position of the screen to be shared relative to the virtual screen.

Note: Use this parameter only when capturing the screen on Windows devices.

windowId

Window ID.

Note: Use this parameter only when capturing a window.

params

Encoding parameter configuration for the screen sharing stream. See ScreenCaptureParameters.

regionRect

Position of the region to be shared relative to the entire screen. See Rectangle. If not specified, the entire screen is shared. If the specified region exceeds the screen boundaries, only the content within the screen is shared. If the width or height in Rectangle is set to 0, the entire screen is shared.