Agora RTC Objective-C API Reference  Refactor
Data Fields
ScreenCaptureConfiguration Struct Reference

Data Fields

bool isCaptureWindow
 
uint32_t displayId
 
Rectangle screenRect
 
view_t windowId
 
ScreenCaptureParameters params
 
Rectangle regionRect
 

Detailed Description

The configuration of the captured screen.

Constructor & Destructor Documentation

◆ ScreenCaptureConfiguration()

Field Documentation

◆ isCaptureWindow

bool isCaptureWindow

Whether to capture the window on the screen:

  • true: Capture the window.
  • false: (Default) Capture the screen, not the window.

◆ displayId

uint32_t displayId

(macOS only) The display ID of the screen.

◆ screenRect

Rectangle screenRect

(Windows only) The relative position of the shared screen to the virtual screen.

Note
This parameter takes effect only when you want to capture the screen on Windows.

◆ windowId

view_t windowId

(For Windows and macOS only) The window ID.

Note
This parameter takes effect only when you want to capture the window.

◆ params

(For Windows and macOS only) The screen capture configuration. For details, see ScreenCaptureParameters.

◆ regionRect

Rectangle 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.