VideoEncoderConfiguration class

Video encoder configurations.

Annotations
  • @JsonSerializable(explicitToJson: true)

Constructors

VideoEncoderConfiguration({VideoDimensions? dimensions, VideoFrameRate? frameRate, VideoFrameRate? minFrameRate, int? bitrate, int? minBitrate, VideoOutputOrientationMode? orientationMode, DegradationPreference? degradationPreference, VideoMirrorMode? mirrorMode})
Constructs the VideoEncoderConfiguration.

Properties

bitrate ↔ int?
The encoding bitrate (Kbps) of the video. You can refer to the table below to set the bitrate according to your app scenario. If the bitrate you set is beyond the reasonable range, the SDK sets it within a reasonable range. You can also choose from the following options: : (Recommended) Standard bitrate mode. In this mode, the video bitrate of the interactive streaming profile is twice that of the communication profile. : Adaptive bitrate mode. In this mode, the bitrate differs between the interactive streaming and communication profiles. If you choose this mode in the interactive streaming profile, the video frame rate may be lower than the set value. : (Recommended) Standard bitrate mode. In this mode, the video bitrate is twice the base bitrate. : Adaptive bitrate mode. In this mode, the video bitrate is the same as the base bitrate. If you choose this mode in the interactive streaming profile, the video frame rate may be lower than the set value. Agora uses different video codecs for different profiles to optimize user experience. The communication profile prioritizes smoothness while the interactive streaming profile prioritizes video quality (a higher bitrate). Therefore, Agora recommends setting this parameter as . You can also set the bitrate value of the Live-broadcasting profile to twice the bitrate value of the communication profile.
getter/setter pair
degradationPreference ↔ DegradationPreference?
Video degradation preference under limited bandwidth. See DegradationPreference .
getter/setter pair
dimensions ↔ VideoDimensions?
getter/setter pair
frameRate ↔ VideoFrameRate?
The frame rate (fps) of the encoding video frame. The default value is 15. See VideoFrameRate . The frame rate (fps) of the encoding video frame. The default value is 15. See VideoFrameRate .
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
minBitrate ↔ int?
The minimum encoding bitrate (Kbps) of the video. The SDK automatically adjusts the encoding bitrate to adapt to the network conditions. Using a value greater than the default value forces the video encoder to output high-quality images but may cause more packet loss and sacrifice the smoothness of the video transmission. Unless you have special requirements for image quality, Agora does not recommend changing this value. This parameter only applies to the interactive streaming profile.
getter/setter pair
minFrameRate ↔ VideoFrameRate?
The minimum encoding frame rate of the video. The default value is -1.
getter/setter pair
mirrorMode ↔ VideoMirrorMode?
By default, the video is not mirrored.
getter/setter pair
orientationMode ↔ VideoOutputOrientationMode?
The orientation mode of the encoded video. See VideoOutputOrientationMode .
getter/setter pair
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