ScreenCaptureConfiguration

Screen capture configuration.

public class ScreenCaptureConfiguration
    {
        public bool isCaptureWindow;
        public long displayId;
        public Rectangle screenRect;
        public long windowId;

        public ScreenCaptureParameters @params;
        public Rectangle regionRect;

        public ScreenCaptureConfiguration()
        {
            this.isCaptureWindow = false;
            this.displayId = 0;
            this.windowId = 0;
        }

        public ScreenCaptureConfiguration(bool isCaptureWindow, long displayId, Rectangle screenRect, long windowId, ScreenCaptureParameters @params, Rectangle regionRect)
        {
            this.isCaptureWindow = isCaptureWindow;
            this.displayId = displayId;
            this.screenRect = screenRect;
            this.windowId = windowId;
            this.@params = @params;
            this.regionRect = regionRect;
        }
    }

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) The display ID of the screen.
Note: Use this parameter only when capturing the screen on Mac devices.
screenRect
(Windows only) The 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
(Windows and macOS only) The window ID.
Note: Use this parameter only when capturing a window.
parameters
(Windows and macOS only) Encoding parameter configuration for screen sharing stream. See ScreenCaptureParameters.
regionRect
(Windows and macOS only) The position of the region to be shared relative to the entire screen. See Rectangle. If not set, the entire screen is shared. If the shared 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.