Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Properties | |
CGSize | dimensions |
NSInteger | frameRate |
NSInteger | bitrate |
BOOL | captureMouseCursor |
BOOL | windowFocus |
NSArray *_Nullable | excludeWindowList |
BOOL | highLighted |
COLOR_CLASS *_Nullable | highLightColor |
NSUInteger | highLightWidth |
The definition of the screen sharing encoding parameters.
|
readwritenonatomicassign |
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.
|
readwritenonatomicassign |
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.
|
readwritenonatomicassign |
The bitrate (Kbps) of the shared region. The default value is 0, which means the SDK works out a bitrate according to the dimensions of the current screen.
|
readwritenonatomicassign |
Sets whether to capture the mouse for screen sharing.
|
readwritenonatomicassign |
Whether to bring the window to the front when calling [startScreenCaptureByWindowId]([AgoraRtcEngineKit startScreenCaptureByWindowId:rectangle:parameters:]) to share the window:
windowFocus
only supports bringing the main window of an application to the front.
|
readwritenonatomiccopy |
A list of IDs of windows to be blocked.
When calling [startScreenCaptureByDisplayId]([AgoraRtcEngineKit startScreenCaptureByDisplayId:rectangle:parameters:]) and pass 0
in the displayId
parameter to start sharing a main screen, you can use this parameter to block the specified windows. When calling [updateScreenCaptureParameters]([AgoraRtcEngineKit updateScreenCaptureParameters:]) to update the configuration for the main screen sharing, you can use this parameter to dynamically block the specified windows during the main screen sharing.
|
readwritenonatomicassign |
(macOS only) Determines whether to place a border around the shared window or screen:
highLighted
as YES.
|
readwritenonatomicstrong |
(macOS only) The color of the border in RGBA format. The default value is 0xFF8CBF26.
on macOS, COLOR_CLASS
refers to NSColor
.
|
readwritenonatomicassign |
(macOS only) The width (px) of the border. Defaults to 0, and the value range is [0,50].