Package io.agora.rtc2.video

Class VideoEncoderConfiguration

java.lang.Object
io.agora.rtc2.video.VideoEncoderConfiguration
public class VideoEncoderConfiguration extends Object

  • Field Details

    • VD_120x120

      public static final VideoEncoderConfiguration.VideoDimensions VD_120x120
      VD_120x120: The video resolution is 120 × 120.

    • VD_160x120

      public static final VideoEncoderConfiguration.VideoDimensions VD_160x120
      VD_160x120: The video resolution is 160 × 120.

    • VD_180x180

      public static final VideoEncoderConfiguration.VideoDimensions VD_180x180
      VD_180x180: The video resolution is 180 × 180.

    • VD_240x180

      public static final VideoEncoderConfiguration.VideoDimensions VD_240x180
      VD_240x180: The video resolution is 240 × 180.

    • VD_320x180

      public static final VideoEncoderConfiguration.VideoDimensions VD_320x180
      VD_320x180: The video resolution is 320 × 180.

    • VD_240x240

      public static final VideoEncoderConfiguration.VideoDimensions VD_240x240
      VD_240x240: The video resolution is 240 × 240.

    • VD_320x240

      public static final VideoEncoderConfiguration.VideoDimensions VD_320x240
      VD_320x240: The video resolution is 320 × 240.

    • VD_424x240

      public static final VideoEncoderConfiguration.VideoDimensions VD_424x240
      VD_424x240: The video resolution is 424 × 240.

    • VD_360x360

      public static final VideoEncoderConfiguration.VideoDimensions VD_360x360
      VD_360x360: The video resolution is 360 × 360.

    • VD_480x360

      public static final VideoEncoderConfiguration.VideoDimensions VD_480x360
      VD_480x360: The video resolution is 480 × 360.

    • VD_640x360

      public static final VideoEncoderConfiguration.VideoDimensions VD_640x360
      VD_640x360: The video resolution is 640 × 360.

    • VD_480x480

      public static final VideoEncoderConfiguration.VideoDimensions VD_480x480
      VD_480x480: The video resolution is 480 × 480.

    • VD_640x480

      public static final VideoEncoderConfiguration.VideoDimensions VD_640x480
      VD_640x480: The video resolution is 640 × 480.

    • VD_840x480

      public static final VideoEncoderConfiguration.VideoDimensions VD_840x480
      VD_840x480: The video resolution is 840 × 480.

    • VD_960x540

      public static final VideoEncoderConfiguration.VideoDimensions VD_960x540
      VD_960x540: The video resolution is 960 × 540.

    • VD_960x720

      public static final VideoEncoderConfiguration.VideoDimensions VD_960x720
      VD_960x720: The video resolution is 640 × 360.

    • VD_1280x720

      public static final VideoEncoderConfiguration.VideoDimensions VD_1280x720
      VD_1280x720: The video resolution is 640 × 360.

    • VD_1920x1080

      public static final VideoEncoderConfiguration.VideoDimensions VD_1920x1080
      Not supported.

    • VD_2540x1440

      public static final VideoEncoderConfiguration.VideoDimensions VD_2540x1440
      Not supported.

    • VD_3840x2160

      public static final VideoEncoderConfiguration.VideoDimensions VD_3840x2160
      Not supported.

    • STANDARD_BITRATE

      public static final int STANDARD_BITRATE
      0: The standard bitrate mode. In this mode, the bitrates under the Live Broadcast and Communication profiles differ: - In the Communication profile, the video bitrate is the same as the base bitrate. - In the Live Broadcast profile, the video bitrate is twice the base bitrate.
      See Also:

    • COMPATIBLE_BITRATE

      public static final int COMPATIBLE_BITRATE
      -1: The compatible bitrate mode. In this mode, the bitrate stays the same regardless of the profile. If you choose this mode for the Live Broadcast profile, the video frame rate may be lower than the set value.
      See Also:

    • DEFAULT_MIN_BITRATE

      public static final int DEFAULT_MIN_BITRATE
      (For future use) Use the default minimum bitrate.
      See Also:

    • DEFAULT_MIN_FRAMERATE

      public static final int DEFAULT_MIN_FRAMERATE
      (For future use) The default minimum frame rate.
      See Also:

    • DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE

      public static final int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE
      -2: (For future use) Set minimum bitrate the same as target bitrate.
      See Also:

    • dimensions

      public VideoEncoderConfiguration.VideoDimensions dimensions
      Users can set the resolution by themselves, or directly select the desired resolution from the following list: - VD_120x120: The video resolution is 120 × 120. - VD_160x120: The video resolution is 160 × 120. - VD_180x180: The video resolution is 180 × 180. - VD_240x180: The video resolution is 240 × 180. - VD_320x180: The video resolution is 320 × 180. - VD_240x240: The video resolution is 240 × 240. - VD_320x240: The video resolution is 320 × 240. - VD_424x240: The video resolution is 424 × 240. - VD_360x360: The video resolution is 360 × 360. - VD_480x360: The video resolution is 480 × 360. - VD_640x360: The video resolution is 640 × 360. - VD_480x480: The video resolution is 480 × 480. - VD_640x480: The video resolution is 640 × 480. - VD_840x480: The video resolution is 840 × 480. - VD_960x540: The video resolution is 960 × 540. - VD_960x720: The video resolution is 960 × 720. - VD_1280x720: The video resolution is 1280 × 720. - VD_1920x1080: The video resolution is 1920 × 1080. - VD_2540x1440: The video resolution is 2540 × 1440. - VD_3840x2160: The video resolution is 3840 × 2160.

    • frameRate

      public int frameRate
      The frame rate (fps) of the encoding video frame. The default value is 15. See `FRAME_RATE`.

    • minFrameRate

      public int minFrameRate
      (For future use) The minimum video encoder frame rate (fps). The default value is DEFAULT_MIN_FRAMERATE(-1) (the SDK uses the lowest encoder frame rate).

    • bitrate

      public int bitrate
      The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value `STANDARD_BITRATE` 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 and frame rate, see `Video profile`. - STANDARD_BITRATE (0): (Recommended) Standard bitrate mode. - COMPATIBLE_BITRATE (-1): Adaptive bitrate mode. In general, Agora suggests that you do not use this value.

    • minBitrate

      public int minBitrate
      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.

    • orientationMode

      public VideoEncoderConfiguration.ORIENTATION_MODE orientationMode
      The orientation mode of the encoded video. See `ORIENTATION_MODE`.

    • degradationPrefer

      public VideoEncoderConfiguration.DEGRADATION_PREFERENCE degradationPrefer
      Video degradation preference under limited bandwidth. See `DEGRADATION_PREFERENCE`.

    • mirrorMode

      public VideoEncoderConfiguration.MIRROR_MODE_TYPE mirrorMode
      Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. - VIDEO_MIRROR_MODE_AUTO (0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default. - VIDEO_MIRROR_MODE_ENABLED (1): Enables the mirror mode for remote users. - VIDEO_MIRROR_MODE_DISABLED (2): Disables the mirror mode for remote users.

    • advanceOptions

      public VideoEncoderConfiguration.AdvanceOptions advanceOptions
      Advanced options for video encoding. See `AdvanceOptions`.

    • codecType

      public VideoEncoderConfiguration.VIDEO_CODEC_TYPE codecType
      The codec type of the local video stream. See `VIDEO_CODEC_TYPE`.

  • Constructor Details