ScreenVideoParameters class

The video configuration for the shared screen stream.

Annotations
  • @JsonSerializable(explicitToJson: true)

Constructors

ScreenVideoParameters({VideoDimensions? dimensions, int? frameRate, int? bitrate, VideoContentHint? contentHint})
Constructs the ScreenVideoParameters.
const

Properties

bitrate → int?
The video encoding bitrate (Kbps). For recommended values, see Recommended video profiles.
final
contentHint → VideoContentHint?
The content hint of the screen sharing. See VideoContentHint .
final
dimensions → VideoDimensions?
The video encoding resolution. The default value is 1280 × 720. For recommended values, see Recommended video profiles. If the aspect ratio is different between dimensions and the screen, the SDK adjusts the video encoding resolution according to the following rules (using an example value for dimensions of 1280 × 720): When the width and height of the screen are both lower than those of dimensions, the SDK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, the SDK uses 640 × 360 for video encoding. When either the width or height of the screen is higher than that of dimensions, the SDK uses the maximum values that do not exceed those of dimensions while maintaining the aspect ratio of the screen for video encoding. For example, if the screen is 2000 × 1500, the SDK uses 960 × 720 for video encoding. The billing of the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For details, see Pricing for Real-time Communication. This value does not indicate the orientation mode of the output ratio. For how to set the video orientation, see VideoOutputOrientationMode . Whether the SDK can support a resolution at 720P depends on the performance of the device. If you set 720P but the device cannot support it, the video frame rate can be lower.
final
frameRate → int?
The video encoding frame rate (fps). The default value is 15. For recommended values, see Recommended video profiles.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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