AgoraScreenCaptureSourceInfo Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

The AgoraScreenCaptureSourceInfo interface. (macOS only)

  type

The type of the shared target. See ScreenCaptureSourceType.

@property (assign, nonatomic) AgoraScreenCaptureSourceType type

Declared In

AgoraObjects.h

  sourceId

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

@property (assign, nonatomic) CGWindowID sourceId

Declared In

AgoraObjects.h

  sourceName

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

@property (copy, nonatomic) NSString *sourceName

Declared In

AgoraObjects.h

  thumbImage

The image content of the thumbnail. See AgoraThumbImageBuffer.

@property (strong, nonatomic) AgoraThumbImageBuffer *thumbImage

Declared In

AgoraObjects.h

  iconImage

The image content of the icon. See AgoraThumbImageBuffer.

@property (strong, nonatomic) AgoraThumbImageBuffer *iconImage

Declared In

AgoraObjects.h

  processPath

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

@property (copy, nonatomic) NSString *processPath

Declared In

AgoraObjects.h

  sourceTitle

The title of the window. UTF-8 encoding.

@property (copy, nonatomic) NSString *sourceTitle

Declared In

AgoraObjects.h

  primaryMonitor

Determines whether the screen is the primary display:

@property (assign, nonatomic) BOOL primaryMonitor

Discussion

  • YES: The screen is the primary display.
  • NO: The screen is not the primary display.

Declared In

AgoraObjects.h