屏幕采集
- HarmonyOS
更新时间不可用
startScreenCapture
开始屏幕采集。
public abstract startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): number;注意：
-
屏幕共享流的计费标准以 VideoCaptureParameters 中的 dimensions 值为准：
- 当你未传值时，以 1280 × 720 计费。
- 当你传值时，以你传入的值计费。
适用场景
在屏幕共享场景下，你需要调用该方法开始采集屏幕视频流。有关屏幕共享的实现方法，详见屏幕共享。
调用时机
该方法在加入频道前后均可调用，区别如下：
- 如果在加入频道前调用该方法，然后调用 joinChannelWithOptions 加入频道，并设置 publishScreenCaptureVideo 为
true，即可开始屏幕共享。 - 如果在加入频道后调用该方法，然后调用 updateChannelMediaOptions 更新频道媒体选项，并设置 publishScreenCaptureVideo 为
true，即可开始屏幕共享。
调用限制
- 为提高屏幕共享时采集系统音频的成功率，建议你在加入频道前通过 setAudioScenario 方法设置音频场景为 GAME_STREAMING。
参数
| 参数名 | 描述 |
|---|---|
screenCaptureParameters | 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080，即 2,073,600 像素。该像素值为计费标准。详见 ScreenCaptureParameters。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
stopScreenCapture
停止屏幕采集。
public abstract stopScreenCapture(): number;适用场景
如果你调用了 startScreenCapture 开启屏幕采集，则停止屏幕采集时需要调用该方法。
调用时机
该方法在加入频道前后均可调用。
调用限制
无。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
updateScreenCaptureParameters
更新屏幕采集的参数配置。
public abstract updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): number;详情
注意：
- 请在开启屏幕共享或窗口共享后调用该方法。
参数
| 参数名 | 描述 |
|---|---|
screenCaptureParameters | 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080，即 2073600 像素。该像素值为计费标准。详见 。 注意： 屏幕共享流的视频属性只需通过该参数设置，与 setVideoEncoderConfiguration 无关。 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2：传入的参数无效。
- -8：屏幕共享状态无效。可能因为你已经共享了其他屏幕或窗口。尝试调用 stopScreenCapture 停止当前共享，再重新开始共享屏幕。