ScreenCaptureConfiguration

The configuration of the captured screen.

struct ScreenCaptureConfiguration {
  bool isCaptureWindow;
  uint32_t displayId;
  Rectangle screenRect;
  view_t windowId;
  ScreenCaptureParameters params;
  Rectangle regionRect;

  ScreenCaptureConfiguration() : isCaptureWindow(false), displayId(0) {}
};

Attributes

isCaptureWindow

Whether to capture the window on the screen:

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

displayId

(macOS only) The display ID of the screen.

Attention: This parameter takes effect only when you want to capture the screen on macOS.

screenRect

(Windows only) The relative position of the shared screen to the virtual screen.

Attention: This parameter takes effect only when you want to capture the screen on Windows.

windowId

(For Windows and macOS only) Window ID.

Attention: This parameter takes effect only when you want to capture the window.

params

(For Windows and macOS only) The screen capture configuration. See ScreenCaptureParameters.

regionRect

(For Windows and macOS only) The relative position of the shared region to the whole screen. See Rectangle. If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in Rectangle as 0, the whole screen is shared.