屏幕采集
queryScreenCaptureCapability
setScreenCaptureContentHint
设置屏幕共享内容类型。
TypeScript
abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number;
详情
SDK 会根据不同的内容类型，使用不同的算法对共享效果进行优化。如果不调用该方法，SDK 会将屏幕共享的内容默认为 ContentHintNone，即无指定的内容类型。
注意
该方法在开始屏幕共享前后都能调用。
参数
- contentHint
- 屏幕共享的内容类型。详见 VideoContentHint。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2：传入的参数无效。
- -8：屏幕共享状态无效。可能因为你已经共享了其他屏幕或窗口。尝试调用 stopScreenCapture 停止当前共享，再重新开始共享屏幕。
setScreenCaptureScenario
设置屏幕共享的场景。
TypeScript
abstract setScreenCaptureScenario(screenScenario: ScreenScenarioType): number;
详情
开启屏幕共享或窗口共享时，你可以调用该方法设置屏幕共享的场景，SDK 会根据你设置的场景调整共享画面的画质。
信息
声网建议你在加入频道前调用该方法。
参数
- screenScenario
- 屏幕共享的场景，详见 ScreenScenarioType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
startScreenCapture
开始屏幕采集。
TypeScript
abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number;
注意
- 屏幕共享流的计费标准以 ScreenVideoParameters 中的 dimensions 值为准：
- 当你未传值时，以 1280 × 720 计费。
- 当你传值时，以你传入的值计费。
适用场景
在屏幕共享场景下，你需要调用该方法开始采集屏幕视频流。有关屏幕共享的实现方法，详见屏幕共享。
调用时机
该方法在加入频道前后均可调用，区别如下：
- 如果在加入频道前调用该方法，然后调用 joinChannel 加入频道，并设置 publishScreenCaptureVideo 为
true，即可开始屏幕共享。 - 如果在加入频道后调用该方法，然后调用 updateChannelMediaOptions 更新频道媒体选项，并设置 publishScreenCaptureVideo 为
true，即可开始屏幕共享。
调用限制
- 在 iOS 平台上，屏幕共享仅适用于 iOS 12.0 及以上。
- 在 iOS 平台上，如果你使用音频自采集而非 SDK 采集音频，为避免应用退后台后屏幕共享停止，建议你对应用添加保活处理逻辑。
- 在 iOS 平台上，该功能对设备性能要求较高，建议你在 iPhone X 及之后机型上使用。
- 在 iOS 平台上，该方法依赖于屏幕共享动态库
AgoraReplayKitExtension.xcframework，如果删除该动态库会导致无法正常开启屏幕共享。 - 在 Android 平台上，如果用户未授予 App 屏幕采集权限，SDK 会上报 onPermissionError
(2)回调。 - 在 Android 9 及之后版本上，为避免应用退后台后被系统杀死，建议你在
/app/Manifests/AndroidManifest.xml文件中添加前台服务权限：android.permission.FOREGROUND_SERVICE。 - 因 Android 性能限制，屏幕共享不支持 Android TV。
- 因 Android 系统限制，使用华为手机进行屏幕共享时，为避免崩溃，请不要在共享过程中调节屏幕共享流的视频编码分辨率。
- 因 Android 系统限制，部分小米手机不支持屏幕共享时采集系统音频。
- 为提高屏幕共享时采集系统音频的成功率，建议你在加入频道前通过 setAudioScenario 方法设置音频场景为 AudioScenarioGameStreaming。
参数
- captureParams
- 屏幕共享的编码参数配置。详见 ScreenCaptureParameters2。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2 (iOS 平台): 参数为空。
- -2 (Anroid 平台): 系统版本过低，请确保 Android API 级别不低于 21。
- -3 (Anroid 平台): 无法采集系统音频，请确保 Android API 级别不低于 29。
stopScreenCapture
停止屏幕采集。
TypeScript
abstract stopScreenCapture(): number;
适用场景
如果你调用了 startScreenCapture 开启屏幕采集，则停止屏幕采集时需要调用该方法。
调用时机
该方法在加入频道前后均可调用。
调用限制
无。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
updateScreenCapture
更新屏幕采集的参数配置。
TypeScript
abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number;
详情
如果在开启屏幕共享时未采集系统音频、然后想要更新参数配置、发布系统音频，可参考以下步骤：
- 调用该方法并设置 captureAudio 为
true。 - 调用 updateChannelMediaOptions 设置 publishScreenCaptureAudio 为
true，即可发布屏幕采集的音频。
注意
- 该方法仅适用于 Android 和 iOS 平台。
- 在 iOS 平台上，屏幕共享仅适用于 iOS 12.0 及以上。
参数
- captureParams
- 屏幕共享的编码参数配置。详见 ScreenCaptureParameters2。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
- -2：传入的参数无效。
- -8：屏幕共享状态无效。可能因为你已经共享了其他屏幕或窗口。尝试调用 stopScreenCapture 停止当前共享，再重新开始共享屏幕。
updateScreenCaptureParameters
更新屏幕采集的参数配置。
TypeScript
abstract updateScreenCaptureParameters(
captureParams: ScreenCaptureParameters
): number;
详情
注意
- 请在开启屏幕共享或窗口共享后调用该方法。
参数
- captureParams
- 屏幕共享的编码参数配置。详见 。注意屏幕共享流的视频属性只需通过该参数设置，与 setVideoEncoderConfiguration 无关。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2：传入的参数无效。
- -8：屏幕共享状态无效。可能因为你已经共享了其他屏幕或窗口。尝试调用 stopScreenCapture 停止当前共享，再重新开始共享屏幕。
updateScreenCaptureRegion
更新屏幕采集的区域。
TypeScript
abstract updateScreenCaptureRegion(regionRect: Rectangle): number;
详情
注意
请在开启屏幕共享或窗口共享后调用该方法。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2：传入的参数无效。
- -8：屏幕共享状态无效。可能因为你已经共享了其他屏幕或窗口。尝试调用 stopScreenCapture 停止当前共享，再重新开始共享屏幕。