ZegoScreenCaptureSource

Declared in ZegoExpressDefines.h

方法

setEventHandler:

- (void)setEventHandler:(nullable id<ZegoScreenCaptureSourceEventHandler>) handler;

设置屏幕采集源回调

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
handler	nullable id<ZegoScreenCaptureSourceEventHandler>	屏幕采集源回调。

详情

设置屏幕采集源回调，用于监听采集数据的回调。

调用时机：创建 [ZegoScreenCaptureSource] 实例后。

支持版本：3.1.0 及以上。
使用限制：无。
注意事项：调用此函数将覆盖上一次调用此函数设置的回调。

updateCaptureSource:sourceType:

- (void)updateCaptureSource:(unsigned int) sourceId sourceType:(ZegoScreenCaptureSourceType) sourceType;

更新屏幕采集源

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
sourceId	unsigned int	指定的屏幕 ID 或窗口 ID。
sourceType	ZegoScreenCaptureSourceType	指定的屏幕源类型。

详情

根据提供的源的 ID 和源的类型更新屏幕采集源对象。

业务场景：需要对屏幕或窗口有录制和分享等业务时使用。
调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.1.0 及以上。
使用限制：只适用于 Windows/macOS

startCapture

- (void)startCapture;

开始屏幕采集。

Declared in ZegoExpressDefines.h

开始屏幕采集。

调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.1.0 及以上。

stopCapture

- (void)stopCapture;

停止屏幕采集。

Declared in ZegoExpressDefines.h

停止屏幕采集。

支持版本：3.1.0 及以上。

getCaptureSourceRect

- (CGRect)getCaptureSourceRect;

获取屏幕采集源的矩形。

Declared in ZegoExpressDefines.h

获取屏幕采集源的矩形。

支持版本：3.6.0 及以上
使用限制：开始采集 [startScreenCapture] 之后调用，只适用于 Windows/macOS 系统。

采集资源的矩形信息

updateCaptureRegion:

- (void)updateCaptureRegion:(CGRect) rect;

更新屏幕采集的区域。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
rect	CGRect	待采集区域相对于整个屏幕或窗口的位置。

详情

更新屏幕采集的区域。

调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.1.0 及以上。
使用限制：只适用于 Windows/macOS 系统

updatePublishRegion:

- (void)updatePublishRegion:(CGRect) rect;

更新屏幕采集的推流区域。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
rect	CGRect	待推流区域相对于采集画面左上角的位置，实际采集画面尺寸可以通过 [onAvailableFrame] 获取

详情

更新屏幕采集的推流区域。

调用时机：更新屏幕采集源 [updateScreenCaptureSource] 之后。

支持版本：3.8.0 及以上。
使用限制：每次更新屏幕采集源 [updateScreenCaptureSource] 时会清空区域，需要重新设置，只适用于 Windows/macOS 系统。
注意事项：设置的区域不能超过 [onAvailableFrame] 返回的尺寸，否则会设置失败并推流原始画面。推流区域失效会通过 [onExceptionOccurred] 通知。

setExcludeWindowList:

- (void)setExcludeWindowList:(NSArray<NSNumber *> *) list;

设置过滤的窗口列表。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
list	NSArray<NSNumber >	过滤窗口的 ID 列表。

详情

指定窗口列表，在采集屏幕时将这些窗口过滤，不在画面中显示。

调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.1.0 及以上。
使用限制：只适用于 Windows/macOS

enableWindowActivate:

- (void)enableWindowActivate:(BOOL) active;

是否激活窗口提升至前台显示。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
active	BOOL	是否激活窗口。true 为激活窗口，false 不激活窗口，默认 true。

详情

在采集目标为窗口的情况下，初次采集时，设置是否激活窗口提升至前台显示。

调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.1.0 及以上。
使用限制：只适用于 Windows/macOS

enableCursorVisible:

- (void)enableCursorVisible:(BOOL) visible;

设置是否显示光标

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
visible	BOOL	是否显示光标。true 为显示光标，false 不显示光标，默认 true。

详情

设置是否显示光标。

调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.1.0 及以上。
使用限制：只适用于 Windows/macOS

enableHightLight:config:

- (void)enableHightLight:(BOOL) enable config:(ZegoLayerBorderConfig *) config;

设置是否高亮采集区域

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
enable	BOOL	是否高亮采集区域。true 为高亮，false 不高亮，默认 false。
config	ZegoLayerBorderConfig *	高亮采集区域边框配置。

详情

设置是否高亮采集区域。

调用时机：在创建屏幕采集实例 [createScreenCaptureSource] 之后。

支持版本：3.21.0 及以上。
使用限制：只适用于 Windows/macOS

enableAudioCapture:config:

- (void)enableAudioCapture:(BOOL) enable config:(ZegoScreenCaptureAudioConfig *) config;

设置是否采集声音

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
enable	BOOL	是否采集声音。true 为采集，false 不采集，默认 false。
config	ZegoScreenCaptureAudioConfig *	音频采集参数。

详情

设置是否采集声音。

调用时机：任意时刻，开始屏幕采集后生效。[setAudioSource] 设置采集源为 ZegoAudioSourceTypeScreenCapture，并且屏幕采集推流通道相同。

支持版本：3.23.0 及以上。
使用限制：只适用于 macOS 10.15 及以上版本和 Windows 8 及以上版本

getIndex

- (NSNumber *)getIndex;

获取屏幕采集源索引。

Declared in ZegoExpressDefines.h

屏幕采集源索引。