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

Data Fields

VideoDimensions dimensions
 
int frameRate
 
int bitrate
 
bool captureMouseCursor
 
bool windowFocus
 
view_texcludeWindowList
 
int excludeWindowCount
 

Detailed Description

The screen sharing encoding parameters.

Constructor & Destructor Documentation

◆ ScreenCaptureParameters() [1/6]

◆ ScreenCaptureParameters() [2/6]

ScreenCaptureParameters ( const VideoDimensions d,
int  f,
int  b 
)
inline

◆ ScreenCaptureParameters() [3/6]

ScreenCaptureParameters ( int  width,
int  height,
int  f,
int  b 
)
inline

◆ ScreenCaptureParameters() [4/6]

ScreenCaptureParameters ( int  width,
int  height,
int  f,
int  b,
bool  cur,
bool  fcs 
)
inline

◆ ScreenCaptureParameters() [5/6]

ScreenCaptureParameters ( int  width,
int  height,
int  f,
int  b,
view_t ex,
int  cnt 
)
inline

◆ ScreenCaptureParameters() [6/6]

ScreenCaptureParameters ( int  width,
int  height,
int  f,
int  b,
bool  cur,
bool  fcs,
view_t ex,
int  cnt 
)
inline

Field Documentation

◆ dimensions

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

◆ frameRate

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

◆ bitrate

int 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).

◆ captureMouseCursor

bool captureMouseCursor

Sets whether or not to capture the mouse for screen sharing:

  • true: (Default) Capture the mouse.
  • false: Do not capture the mouse.

◆ windowFocus

bool windowFocus

Whether to bring the window to the front when calling startScreenCaptureByWindowId to share the window:

  • true: Bring the window to the front.
  • false: (Default) Do not bring the window to the front.

◆ excludeWindowList

view_t* excludeWindowList

A list of IDs of windows to be blocked.

◆ excludeWindowCount

int excludeWindowCount

The number of windows to be blocked.