Video SDK v3.7.1 API Reference for Unity
|
Public Attributes | |
VideoDimensions | dimensions |
int | frameRate |
int | bitrate |
bool | captureMouseCursor |
bool | windowFocus |
string[] | excludeWindowList |
int | excludeWindowCount |
int | highLightWidth |
uint | highLightColor |
bool | enableHighLight |
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:
bool agora_gaming_rtc.ScreenCaptureParameters.windowFocus |
Whether to bring the window to the front when calling StartScreenCaptureByWindowId to share the window:
string [] agora_gaming_rtc.ScreenCaptureParameters.excludeWindowList |
A list of IDs of windows to be blocked.
When calling StartScreenCaptureByScreenRect or StartScreenCaptureByWindowId to start screen sharing, you can use this parameter to block the specified windows. When calling UpdateScreenCaptureParameters to update the configuration for screen sharing, you can use this parameter to dynamically block the specified windows during screen sharing.
int agora_gaming_rtc.ScreenCaptureParameters.excludeWindowCount |
The number of windows to be blocked.
int agora_gaming_rtc.ScreenCaptureParameters.highLightWidth |
(macOS only) The width (px) of the border. Defaults to 0, and the value range is [0,50].
uint agora_gaming_rtc.ScreenCaptureParameters.highLightColor |
(macOS only) The color of the border in RGBA format. The default value is 0xFF8CBF26.
bool agora_gaming_rtc.ScreenCaptureParameters.enableHighLight |
(macOS only) Determines whether to place a border around the shared window or screen:
enableHighLight
as true.