ScreenCaptureParameters class

Parameter configuration for screen sharing.

Annotations

• @JsonSerializable.new(explicitToJson: true, includeIfNull: false)

Properties

bitrate → int?

Bitrate of the shared video, in Kbps. Default is 0, meaning the SDK calculates a reasonable value based on the current screen resolution.

final

captureMouseCursor → bool?

Due to macOS system limitations, setting this parameter to false has no effect when sharing the screen (no impact when sharing a window). Whether to capture the mouse cursor during screen sharing: true : (Default) Capture mouse. false : Do not capture mouse.

final

dimensions → VideoDimensions?

When setting encoding resolution in a document sharing scenario (screenScenarioDocument), choose one of the following: For optimal image quality, set the encoding resolution the same as the capture resolution. For a balance between quality, bandwidth, and performance: If capture resolution is greater than 1920 × 1080, set encoding resolution no lower than 1920 × 1080. If capture resolution is less than 1920 × 1080, set encoding resolution no lower than 1280 × 720. Video encoding resolution of the screen sharing stream. See VideoDimensions. Default is 1920 × 1080, i.e., 2073600 pixels. This pixel count is used for billing. If the aspect ratio of the shared screen resolution differs from this setting, the SDK encodes according to the following strategy. Assuming dimensions is set to 1920 × 1080: If the screen resolution is smaller than dimensions, e.g., 1000 × 1000, the SDK encodes at 1000 × 1000. If the screen resolution is larger than dimensions, e.g., 2000 × 1500, the SDK encodes at the maximum resolution within dimensions that matches the screen's aspect ratio (4:3), i.e., 1440 × 1080.

final

enableHighLight → bool?

When sharing a partial region of a window or screen, if this parameter is set to true, the SDK highlights the entire window or screen. (macOS and Windows only) Whether to highlight the shared window or screen: true : Highlight. false : (Default) Do not highlight.

final

excludeWindowCount → int?

Number of windows to exclude. On Windows, the maximum value is 24. If exceeded, window exclusion does not take effect.

final

excludeWindowList → List<int>?

List of window IDs to exclude. When calling startScreenCaptureByDisplayId to start screen sharing, you can use this parameter to exclude specific windows. You can also dynamically exclude windows by passing this parameter when calling updateScreenCaptureParameters to update screen sharing configuration.

final

frameRate → int?

Frame rate of the shared video, in fps. Default is 5. It is recommended not to exceed 15.

final

hashCode → int

The hash code for this object.

no setter, inherited

highLightColor → int?

(macOS and Windows only) On Windows, specifies the ARGB color of the highlight. Default is 0xFF8CBF26. On macOS, COLOR_CLASS refers to NSColor.

final

highLightWidth → int?

(macOS and Windows only) Width of the highlight border (px). Default is 5. Valid range is (0,50]. This parameter takes effect only when highLighted is set to true.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

windowFocus → bool?

Due to macOS system limitations, when setting this member to bring a window to the front, only the main window is brought to the front if the app has multiple windows. When calling startScreenCaptureByWindowId to share a window, whether to bring the window to the front: true : Bring to front. false : (Default) Do not bring to front.

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