Agora Java API Reference for Android
Public Member Functions | Public Attributes | List of all members
agora::rtc::ScreenCaptureParameters Struct Reference

#include <AgoraBase.h>

Public Member Functions

 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
 

Detailed Description

The screen sharing encoding parameters.

Member Data Documentation

◆ dimensions

VideoDimensions agora::rtc::ScreenCaptureParameters::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 agora::rtc::ScreenCaptureParameters::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 agora::rtc::ScreenCaptureParameters::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 agora::rtc::ScreenCaptureParameters::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 agora::rtc::ScreenCaptureParameters::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* agora::rtc::ScreenCaptureParameters::excludeWindowList

A list of IDs of windows to be blocked.

◆ excludeWindowCount

int agora::rtc::ScreenCaptureParameters::excludeWindowCount

The number of windows to be blocked.

◆ highLightWidth

int agora::rtc::ScreenCaptureParameters::highLightWidth

(macOS only) The width (px) of the border. Defaults to 0, and the value range is [0,50].

◆ highLightColor

unsigned int agora::rtc::ScreenCaptureParameters::highLightColor

(macOS only) The color of the border in RGBA format. The default value is 0xFF8CBF26.

◆ enableHighLight

bool agora::rtc::ScreenCaptureParameters::enableHighLight

(macOS only) Determines whether to place a border around the shared window or screen:

  • true: Place a border.
  • false: (Default) Do not place a border.
Note
When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set enableHighLight as true.