ScreenCaptureConfiguration

Used to configure parameters for screen capture.

struct ScreenCaptureConfiguration {
  bool isCaptureWindow;
  int64_t displayId;
  Rectangle screenRect;
  int64_t windowId;
  ScreenCaptureParameters params;
  Rectangle regionRect;
};

Properties

isCaptureWindow

Whether to capture a window on the screen:

true: Capture a window.
false: (Default) Capture the entire screen instead of a window.

displayId

Display ID of the screen.

Note: This parameter is effective only when capturing the screen on macOS.

screenRect

Position of the shared screen relative to the virtual screen. See Rectangle.

Note: This parameter is effective only when capturing the screen on Windows.

windowId

Window ID.

Note: This parameter is effective only when capturing a window.

params

Screen capture configuration. See ScreenCaptureParameters.

regionRect

Position of the shared region relative to the entire screen. See Rectangle. If this parameter is not set, the SDK shares the entire screen. If the specified region exceeds the screen boundaries, only the portion within the screen is shared. If the width or height in Rectangle is set to 0, the entire screen is shared.