VideoEncoderConfiguration class

Video encoder configurations.

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

Properties

advanceOptions → AdvanceOptions?
Advanced options for video encoding. See AdvanceOptions.
final
bitrate → int?
The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value standardBitrate is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution, frame rate, and bitrate, please refer to. standardBitrate (0): (Recommended) Standard bitrate mode. compatibleBitrate (-1): Adaptive bitrate mode. In general, Agora suggests that you do not use this value.
final
codecType → VideoCodecType?
The codec type of the local video stream. See VideoCodecType.
final
degradationPreference → DegradationPreference?
Video degradation preference under limited bandwidth. See DegradationPreference.
final
dimensions → VideoDimensions?
The dimensions of the encoded video (px). See VideoDimensions. This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.
final
frameRate → int?
The frame rate (fps) of the encoding video frame. The default value is 15. See FrameRate.
final
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.
final
mirrorMode → VideoMirrorModeType?
Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See VideoMirrorModeType. By default, the video is not mirrored.
final
orientationMode → OrientationMode?
The orientation mode of the encoded video. 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
toString() → String
A string representation of this object.
inherited

Operators

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