agora::rtc::ScreenCaptureSourceInfo Struct Reference

Public Member Functions
	ScreenCaptureSourceInfo ()
	ScreenCaptureSourceInfo ()

Public Attributes
ScreenCaptureSourceType	type
int64_t	sourceId
const char *	sourceName
ThumbImageBuffer	thumbImage
ThumbImageBuffer	iconImage
const char *	processPath
const char *	sourceTitle
bool	primaryMonitor
bool	isOccluded
Rectangle	position
bool	minimizeWindow
int64_t	sourceDisplayId

Constructor & Destructor Documentation

ScreenCaptureSourceInfo() [1/2]

agora::rtc::ScreenCaptureSourceInfo::ScreenCaptureSourceInfo ( )

inline

ScreenCaptureSourceInfo() [2/2]

agora::rtc::ScreenCaptureSourceInfo::ScreenCaptureSourceInfo ( )

inline

Member Data Documentation

type

ScreenCaptureSourceType agora::rtc::ScreenCaptureSourceInfo::type

The type of the shared target. See ScreenCaptureSourceType.

sourceId

int64_t agora::rtc::ScreenCaptureSourceInfo::sourceId

The window ID for a window or the display ID for a screen.

sourceName

const char* agora::rtc::ScreenCaptureSourceInfo::sourceName

The name of the window or screen. UTF-8 encoding.

thumbImage

ThumbImageBuffer agora::rtc::ScreenCaptureSourceInfo::thumbImage

The image content of the thumbnail. See ThumbImageBuffer.

iconImage

ThumbImageBuffer agora::rtc::ScreenCaptureSourceInfo::iconImage

The image content of the icon. See ThumbImageBuffer.

processPath

const char* agora::rtc::ScreenCaptureSourceInfo::processPath

The process to which the window belongs. UTF-8 encoding.

sourceTitle

const char* agora::rtc::ScreenCaptureSourceInfo::sourceTitle

The title of the window. UTF-8 encoding.

primaryMonitor

bool agora::rtc::ScreenCaptureSourceInfo::primaryMonitor

Determines whether the screen is the primary display:

• true: The screen is the primary display.
• false: The screen is not the primary display.

isOccluded

bool agora::rtc::ScreenCaptureSourceInfo::isOccluded

position

Rectangle agora::rtc::ScreenCaptureSourceInfo::position

The position of a window relative to the entire screen space (including all shareable screens). See Rectangle.

minimizeWindow

bool agora::rtc::ScreenCaptureSourceInfo::minimizeWindow

(For Windows only) Whether the window is minimized:

• true: The window is minimized.
• false: The window is not minimized.

sourceDisplayId

int64_t agora::rtc::ScreenCaptureSourceInfo::sourceDisplayId

(For Windows only) Screen ID where the window is located. If the window is displayed across multiple screens, this parameter indicates the ID of the screen with which the window has the largest intersection area. If the window is located outside of the visible screens, the value of this member is -2.