Public Attributes | |
VideoDimensions | dimensions |
int | frameRate |
int | bitrate |
bool | captureMouseCursor |
Screen sharing encoding parameters.
VideoDimensions agora_gaming_rtc.ScreenCaptureParameters.dimensions |
The maximum encoding dimensions of the shared region in terms of width × height.
The default value is 1920 × 1080 pixels, that is, 2073600 pixels. Agora uses the value of this parameter to calculate the charges.
If the aspect ratio is different between the encoding dimensions and screen dimensions, Agora applies the following algorithms for encoding. Suppose the encoding dimensions are 1920 x 1080:
int agora_gaming_rtc.ScreenCaptureParameters.frameRate |
The frame rate (fps) of the shared region.
The default value is 5. We do not recommend setting this to a value greater than 15.
int agora_gaming_rtc.ScreenCaptureParameters.bitrate |
The bitrate (Kbps) of the shared region.
The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen).
bool agora_gaming_rtc.ScreenCaptureParameters.captureMouseCursor |
Sets whether or not to capture the mouse for screen sharing: