startScreenCapture
开始屏幕采集。
- (int)startScreenCapture:(AgoraVideoSourceType)sourceType config:(AgoraScreenCaptureConfiguration * _Nullable)config NS_SWIFT_NAME(startScreenCapture(_:config:));
详情
- 自从
- v4.2.0
该方法和 startScreenCaptureByDisplayId 、 startScreenCaptureByWindowId 均可以开启屏幕采集,区别如下:
- startScreenCaptureByDisplayId 和 startScreenCaptureByWindowId 仅支持采集单个屏幕或窗口;调用该方法可以通过 sourceType 指定多个视频源,以采集多路屏幕共享流,用于本地合图或者多频道发布。
注意:
- 如果调用该方法开始屏幕采集,声网建议你使用 stopScreenCapture [2/2] 停止采集,不要与 stopScreenCapture [1/2] 混用。
参数
- sourceType
-
视频源的类型,详见 AgoraVideoSourceType。
注:- macOS 平台最多支持 1 路屏幕采集的视频流,当前仅支持将该参数设置为
AgoraVideoSourceTypeScreen(2)
。
- macOS 平台最多支持 1 路屏幕采集的视频流,当前仅支持将该参数设置为
- config
- 屏幕采集配置。详见 AgoraScreenCaptureConfiguration。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败