ScreenCaptureParameters class
Screen sharing configurations.
- Annotations
-
- @JsonSerializable(explicitToJson: true)
Constructors
-
ScreenCaptureParameters({VideoDimensions? dimensions, int? frameRate, int? bitrate, bool? captureMouseCursor, bool? windowFocus, List<
int> ? excludeWindowList}) - Constructs the ScreenCaptureParameters.
Properties
- bitrate ↔ int?
-
The bitrate (Kbps) of the shared region. The default value is 0, which represents that the SDK works out a bitrate according to the dimensions of the current screen.
getter/setter pair
- captureMouseCursor ↔ bool?
-
getter/setter pair
- dimensions ↔ VideoDimensions?
-
The maximum dimensions of encoding the shared region.
If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions are set to 1,920 x 1,080:
If the value of the screen dimensions is lower than that of dimensions, for example, 1,000 x 1,000 pixels, the SDK uses 1,000 x 1,000 pixels
for encoding.
If the value of the screen dimensions is larger than that of dimensions, for example, 2,000 × 1,500, the SDK uses
the maximum value next to 1,920 × 1,080 with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1,440 × 1,080.
getter/setter pair
-
excludeWindowList
↔ List<
int> ? -
getter/setter pair
- frameRate ↔ int?
-
The frame rate (fps) of the shared region. The default value is 5. Agora does not recommend setting it to a value greater than 15.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- windowFocus ↔ bool?
-
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited