AgoraVideoEncoderConfiguration Class Reference

Discussion

You can customize the dimension, or select from the following list:

• AgoraVideoDimension120x120
• AgoraVideoDimension160x120
• AgoraVideoDimension180x180
• AgoraVideoDimension240x180
• AgoraVideoDimension320x180
• AgoraVideoDimension240x240
• AgoraVideoDimension320x240
• AgoraVideoDimension424x240
• AgoraVideoDimension360x360
• AgoraVideoDimension480x360
• AgoraVideoDimension640x360
• AgoraVideoDimension480x480
• AgoraVideoDimension640x480
• AgoraVideoDimension840x480
• AgoraVideoDimension960x720
• AgoraVideoDimension1280x720
• AgoraVideoDimension1920x1080 (macOS only)
• AgoraVideoDimension2540x1440 (macOS only)
• AgoraVideoDimension3840x2160 (macOS only)

Note:

• The dimension does not specify the orientation mode of the output ratio. For how to set the video orientation, see AgoraVideoOutputOrientationMode.
• Whether 720p can be supported depends on the device. If the device cannot support 720p, the frame rate will be lower than the one listed in the table. Agora optimizes the video in lower-end devices.
• iPhones do not support video frame dimensions above 720p.

Discussion

• AgoraVideoFrameRateFps1(1): 1 fps
• AgoraVideoFrameRateFps7(7): 7 fps
• AgoraVideoFrameRateFps10(10): 10 fps
• AgoraVideoFrameRateFps15(15): 15 fps
• AgoraVideoFrameRateFps24(24): 24 fps
• AgoraVideoFrameRateFps30(30): 30 fps
• AgoraVideoFrameRateFps60(30): 60 fps (macOS only)

Discussion

Sets the video bitrate (Kbps). Refer to the table below and set your bitrate. If you set a bitrate beyond the proper range, the SDK automatically adjusts it to a value within the range. You can also choose from the following options:

• AgoraVideoBitrateStandard: (Recommended) The standard bitrate mode. In this mode, the bitrates differ between the live broadcast and communication profiles:

  • Communication profile: The video bitrate is the same as the base bitrate.
  • Live broadcast profile: The video bitrate is twice the base bitrate.

• AgoraVideoBitrateCompatible: The compatible bitrate mode. In this mode, the bitrate stays the same regardless of the profile. In a live broadcast profile, if you choose this mode, the video frame rate may be lower than the set value.

Agora uses different video codecs for different profiles to optimize the user experience. For example, a communication profile prioritizes the smoothness while a live broadcast profile prioritizes the video quality (a higher bitrate). Therefore, Agora recommends setting this parameter as AgoraVideoBitrateStandard.

Video Bitrate Table

Note:

The base bitrate in this table applies to a communication profile. A live broadcast profile generally requires a higher bitrate for better video quality. Agora recommends setting the bitrate mode as AgoraVideoBitrateStandard. You can also set the bitrate as twice the base bitrate.

Discussion

Sets the minimum encoding bitrate (Kbps).

The Agora SDK automatically adjusts the encoding bitrate to adapt to 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 hence sacrifice the smoothness of the video transmission. Unless you have special requirements for image quality, Agora does not recommend changing this value.

Note:

This parameter applies only to the live broadcast profile.

Discussion

• AgoraVideoOutputOrientationModeAdaptative(0): (Default) The output video always follows the orientation of the captured video, because the receiver takes the rotational information passed on from the video encoder.
  • If the captured video is in landscape mode, the output video is in landscape mode.
  • If the captured video is in portrait mode, the output video is in portrait mode.
• AgoraVideoOutputOrientationModeFixedLandscape(1): The output video is always in landscape mode. If the captured video is in portrait mode, the video encoder crops it to fit the output. This applies to situations where the receiver cannot process the rotational information. For example, CDN live streaming.
• AgoraVideoOutputOrientationModeFixedPortrait(2): The output video is always in portrait mode. If the captured video is in landscape mode, the video encoder crops it to fit the output. This applies to situations where the receiver cannot process the rotational information. For example, CDN live streaming.

For scenarios with video rotation, Agora provides Basic: Video Rotation Guide to guide users on how to set this parameter to get the preferred video orientation.