VideoEncoderConfiguration class

Configuration for the video encoder.

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

Properties

advanceOptions → AdvanceOptions?
Advanced options for video encoding. See AdvanceOptions.
final
bitrate → int?
Bitrate for video encoding, in Kbps. You do not need to set this parameter. Keep the default value standardBitrate. The SDK automatically selects the optimal bitrate based on the resolution and frame rate you set. For the relationship between resolution and frame rate, see Video Profile. standardBitrate (0): (Default) Standard bitrate mode. compatibleBitrate (-1): Compatible bitrate mode. In general, Agora recommends not using this value.
final
codecType → VideoCodecType?
Video codec type. See VideoCodecType.
final
degradationPreference → DegradationPreference?
Encoding degradation preference when bandwidth is limited. See DegradationPreference. If this parameter is set to maintainFramerate (1) or maintainBalanced (2), you must also set orientationMode to orientationModeAdaptive (0), otherwise the setting will not take effect.
final
dimensions → VideoDimensions?
Resolution (px) for video encoding. See VideoDimensions. This parameter is used to evaluate encoding quality and is expressed as width × height. The default value is 960 × 540. You can set the resolution as needed.
final
frameRate → int?
Frame rate (fps) for video encoding. The default value is 15. See FrameRate.
final
hashCode → int
The hash code for this object.
no setterinherited
minBitrate → int?
Minimum encoding bitrate, in Kbps. The SDK automatically adjusts the video encoding bitrate based on network conditions. Setting this parameter higher than the default forces the encoder to output higher-quality images, but may cause packet loss and video stuttering under poor network conditions. Unless you have specific requirements for video quality, Agora recommends not modifying this parameter. This parameter applies to live streaming only.
final
mirrorMode → VideoMirrorModeType?
Whether to enable mirror mode when sending encoded video. This only affects the video seen by remote users. See VideoMirrorModeType. Mirror mode is disabled by default.
final
orientationMode → OrientationMode?
Orientation mode for video encoding. See OrientationMode.
final
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
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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