Agora RTC Objective-C API Reference
Refactor
|
Data Fields | |
VideoDimensions | dimensions |
int | frameRate |
int | bitrate |
bool | captureMouseCursor |
bool | windowFocus |
view_t * | excludeWindowList |
int | excludeWindowCount |
int | highLightWidth |
unsigned int | highLightColor |
bool | enableHighLight |
The screen sharing encoding parameters.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
VideoDimensions dimensions |
The dimensions of the shared region in terms of width × height. The default value is 0, which means the original dimensions of the shared screen.
int 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 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 captureMouseCursor |
Sets whether or not to capture the mouse for screen sharing:
bool windowFocus |
Whether to bring the window to the front when calling startScreenCaptureByWindowId to share the window:
view_t* excludeWindowList |
A list of IDs of windows to be blocked.
int excludeWindowCount |
The number of windows to be blocked.
int highLightWidth |
(macOS only) The width (px) of the border. Defaults to 0, and the value range is [0,50].
unsigned int highLightColor |
(macOS only) The color of the border in RGBA format. The default value is 0xFF8CBF26.
bool enableHighLight |
(macOS only) Determines whether to place a border around the shared window or screen:
enableHighLight
as true.