ScreenCaptureConfiguration class

The configuration of the captured screen.

Annotations
  • @JsonSerializable(explicitToJson: true, includeIfNull: false)

Properties

displayId int?
(macOS only) The display ID of the screen. This parameter takes effect only when you want to capture the screen on macOS.
final
hashCode int
The hash code for this object.
no setterinherited
isCaptureWindow bool?
Whether to capture the window on the screen: true : Capture the window. false : (Default) Capture the screen, not the window.
final
params ScreenCaptureParameters?
(For Windows and macOS only) The screen capture configuration. See ScreenCaptureParameters.
final
regionRect Rectangle?
(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.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
screenRect Rectangle?
(Windows only) The relative position of the shared screen to the virtual screen. This parameter takes effect only when you want to capture the screen on Windows.
final
windowId int?
(For Windows and macOS only) Window ID. This parameter takes effect only when you want to capture the window.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited