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 |
Screen sharing configurations.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
VideoDimensions agora::rtc::ScreenCaptureParameters::dimensions |
On Windows and macOS, it represents the video encoding resolution of the shared screen stream. See VideoDimensions
. The default value is 1920 x 1080, that is, 2,073,600 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 dimensions are 1920 x 1080:
int agora::rtc::ScreenCaptureParameters::frameRate |
On Windows and macOS, it represents the video encoding frame rate (fps) of the shared screen stream. 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 |
On Windows and macOS, it represents the video encoding bitrate of the shared screen stream. 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 |
Whether to capture the mouse in screen sharing:
true
: (Default) Capture the mouse.false
: Do not capture the mouse. bool agora::rtc::ScreenCaptureParameters::windowFocus |
Whether to bring the window to the front when calling the startScreenCaptureByWindowId
method to share it:
true
: Bring the window to the front.false
: (Default) Do not bring the window to the front. view_t* agora::rtc::ScreenCaptureParameters::excludeWindowList |
A list of IDs of windows to be blocked. When calling startScreenCaptureByDisplayId
to start screen sharing, you can use this parameter to block a specified window. When calling updateScreenCaptureParameters
to update screen sharing configurations, you can use this parameter to dynamically block the specified windows during screen sharing.
int agora::rtc::ScreenCaptureParameters::excludeWindowCount |
The number of windows to be blocked.
int agora::rtc::ScreenCaptureParameters::highLightWidth |
The width (px) of the border. Defaults to 0, and the value range is [0,50].
unsigned int agora::rtc::ScreenCaptureParameters::highLightColor |
The color of the border in RGBA format. The default value is 0xFF8CBF26.
bool agora::rtc::ScreenCaptureParameters::enableHighLight |
Whether to place a border around the shared window or screen:
enableHighLight
as true.