Agora C++ API Reference for All Platforms
|
Public Member Functions | |
ScreenCaptureConfiguration () | |
Public Attributes | |
bool | isCaptureWindow |
uint32_t | displayId |
Rectangle | screenRect |
view_t | windowId |
ScreenCaptureParameters | params |
Rectangle | regionRect |
The configuration of the captured screen.
|
inline |
bool agora::rtc::ScreenCaptureConfiguration::isCaptureWindow |
Whether to capture the window on the screen:
true
: Capture the window.false
: (Default) Capture the screen, not the window. uint32_t agora::rtc::ScreenCaptureConfiguration::displayId |
(macOS only) The display ID of the screen.
Rectangle agora::rtc::ScreenCaptureConfiguration::screenRect |
(Windows only) The relative position of the shared screen to the virtual screen.
view_t agora::rtc::ScreenCaptureConfiguration::windowId |
(For Windows and macOS only) The window ID.
ScreenCaptureParameters agora::rtc::ScreenCaptureConfiguration::params |
(For Windows and macOS only) The screen capture configuration. For details, see ScreenCaptureParameters.
Rectangle agora::rtc::ScreenCaptureConfiguration::regionRect |
(For Windows and macOS only) The relative position of the shared region to the whole screen. For details, see Rectangle.
If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in Rectangle as 0, the whole screen is shared.