Agora C++ API Reference for All Platforms
|
#include <IAgoraRtcEngine.h>
Public Member Functions | |
ScreenCaptureParameters () | |
ScreenCaptureParameters (const VideoDimensions &d, int f, int b, bool c, bool focus, view_t *ex=NULL, int cnt=0) | |
ScreenCaptureParameters (int width, int height, int f, int b, bool c, bool focus, view_t *ex=NULL, int cnt=0) | |
Public Attributes | |
VideoDimensions | dimensions |
int | frameRate |
int | bitrate |
bool | captureMouseCursor |
bool | windowFocus |
view_t * | excludeWindowList |
int | excludeWindowCount |
int | highLightWidth |
unsigned int | highLightColor |
bool | enableHighLight |
Screen sharing encoding parameters.
|
inline |
|
inline |
|
inline |
VideoDimensions agora::rtc::ScreenCaptureParameters::dimensions |
The video encoding resolution of the shared screen stream.
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::rtc::ScreenCaptureParameters::frameRate |
The video encoding frame rate (fps) of the shared screen stream
The default value is 5. We do not recommend setting this to a value greater than 15.
int agora::rtc::ScreenCaptureParameters::bitrate |
The video encoding bitrate (Kbps) of the shared screen stream.
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 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.
When calling startScreenCaptureByScreenRect or startScreenCaptureByDisplayId 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.
excludeWindowList
on such a device, the SDK reports the error code ERR_NOT_SUPPORTED_MUTI_GPU_EXCLUDE_WINDOW(1736)
. 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 ARGB 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.