|
Agora C++ API Reference for All Platforms
|
Public Member Functions | |
| ScreenCaptureParameters () | |
| ScreenCaptureParameters (const VideoDimensions &d, int f, int b) | |
| ScreenCaptureParameters (int width, int height, int f, int b) | |
| ScreenCaptureParameters (int width, int height, int f, int b, bool cur, bool fcs) | |
| ScreenCaptureParameters (int width, int height, int f, int b, view_t *ex, int cnt) | |
| ScreenCaptureParameters (int width, int height, int f, int b, bool cur, bool fcs, view_t *ex, int cnt) | |
Public Attributes | |
| 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 agora::rtc::ScreenCaptureParameters::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 agora::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::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::rtc::ScreenCaptureParameters::captureMouseCursor |
Sets whether or not to capture the mouse for screen sharing:
| bool agora::rtc::ScreenCaptureParameters::windowFocus |
Whether to bring the window to the front when calling startScreenCaptureByWindowId to share the window:
| view_t* agora::rtc::ScreenCaptureParameters::excludeWindowList |
A list of IDs of windows to be blocked.
| int agora::rtc::ScreenCaptureParameters::excludeWindowCount |
The number of windows to be blocked.
| int agora::rtc::ScreenCaptureParameters::highLightWidth |
(macOS only) The width (px) of the border. Defaults to 0, and the value range is [0,50].
| unsigned int agora::rtc::ScreenCaptureParameters::highLightColor |
(macOS only) The color of the border in RGBA format. The default value is 0xFF8CBF26.
| bool agora::rtc::ScreenCaptureParameters::enableHighLight |
(macOS only) Determines whether to place a border around the shared window or screen:
enableHighLight as true.
1.8.18