Video SDK v3.7.1 API Reference for Unity
Public Attributes | List of all members
agora_gaming_rtc.VideoEncoderConfiguration Struct Reference

Public Attributes

VideoDimensions dimensions
FRAME_RATE frameRate
int minFrameRate
int bitrate
int minBitrate
ORIENTATION_MODE orientationMode
DEGRADATION_PREFERENCE degradationPreference

Detailed Description

Video encoder configurations.

Member Data Documentation

◆ dimensions

VideoDimensions agora_gaming_rtc.VideoEncoderConfiguration.dimensions

The video frame dimension used to specify the video quality and measured by the total number of pixels along a frame's width and height: VideoDimensions.

◆ frameRate

FRAME_RATE agora_gaming_rtc.VideoEncoderConfiguration.frameRate

The frame rate of the video: FRAME_RATE. The default value is 15. Note that we do not recommend setting this to a value greater than 30.

◆ minFrameRate

int agora_gaming_rtc.VideoEncoderConfiguration.minFrameRate

The minimum frame rate of the video. The default value is -1.

◆ bitrate

int agora_gaming_rtc.VideoEncoderConfiguration.bitrate

The video encoding bitrate (Kbps).

◆ minBitrate

int agora_gaming_rtc.VideoEncoderConfiguration.minBitrate

The minimum encoding bitrate (Kbps).

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 hence sacrifice the smoothness of the video transmission. That said, unless you have special requirements for image quality, Agora does not recommend changing this value.

This parameter applies only to the Live-broadcast profile.

◆ orientationMode

ORIENTATION_MODE agora_gaming_rtc.VideoEncoderConfiguration.orientationMode

The video orientation mode of the video: ORIENTATION_MODE.

◆ degradationPreference

DEGRADATION_PREFERENCE agora_gaming_rtc.VideoEncoderConfiguration.degradationPreference

The video encoding degradation preference under limited bandwidth: DEGRADATION_PREFERENCE.

◆ mirrorMode

VIDEO_MIRROR_MODE_TYPE agora_gaming_rtc.VideoEncoderConfiguration.mirrorMode

Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See VIDEO_MIRROR_MODE_TYPE

The SDK disables the mirror mode by default.

The documentation for this struct was generated from the following file: