# 屏幕采集 (/zh-CN/api-reference/rtc/harmonyos/video/screencapture)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_screencapture"></a>

<a id="api_irtcengine_startscreencapture"></a>

<a id="ariaid-title2"></a>

## startScreenCapture [#startscreencapture]

开始屏幕采集。

<a id="api_irtcengine_startscreencapture__prototype"></a>

```ts
public abstract startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): number;
```

<a id="api_irtcengine_startscreencapture__detailed_desc"></a>

:::caution
注意：

- 屏幕共享流的计费标准以 VideoCaptureParameters 中的 dimensions 值为准：

  - 当你未传值时，以 1280 × 720 计费。
  - 当你传值时，以你传入的值计费。
:::

<a id="api_irtcengine_startscreencapture__scenario"></a>

### 适用场景 [#适用场景]

在屏幕共享场景下，你需要调用该方法开始采集屏幕视频流。有关屏幕共享的实现方法，详见[屏幕共享](/zh-CN/realtime-media/rtc/build/video/screen-share)。

<a id="api_irtcengine_startscreencapture__timing"></a>

### 调用时机 [#调用时机]

<a id="api_irtcengine_startscreencapture__apisequence"></a>

该方法在加入频道前后均可调用，区别如下：

- 如果在加入频道前调用该方法，然后调用 [joinChannelWithOptions](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_joinchannel2) 加入频道，并设置 publishScreenCaptureVideo 为 `true`，即可开始屏幕共享。
- 如果在加入频道后调用该方法，然后调用 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_updatechannelmediaoptions) 更新频道媒体选项，并设置 publishScreenCaptureVideo 为 `true`，即可开始屏幕共享。

<a id="api_irtcengine_startscreencapture__restriction"></a>

### 调用限制 [#调用限制]

- 为提高屏幕共享时采集系统音频的成功率，建议你在加入频道前通过 [setAudioScenario](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_setaudioscenario) 方法设置音频场景为 GAME_STREAMING。

<a id="api_irtcengine_startscreencapture__related"></a>

<a id="api_irtcengine_startscreencapture__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="screencaptureparameters"></a>
<Parameter name="screenCaptureParameters">

屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080，即 2,073,600 像素。该像素值为计费标准。详见 [ScreenCaptureParameters](/zh-CN/api-reference/rtc/harmonyos/class-screencaptureparameters2)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_startscreencapture__return_values"></a>

### 返回值 [#返回值]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类]

- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_stopscreencapture"></a>

<a id="ariaid-title3"></a>

## stopScreenCapture [#stopscreencapture]

停止屏幕采集。

<a id="api_irtcengine_stopscreencapture__prototype"></a>

```ts
public abstract stopScreenCapture(): number;
```

<a id="api_irtcengine_stopscreencapture__detailed_desc"></a>

<a id="api_irtcengine_stopscreencapture__scenario"></a>

### 适用场景 [#适用场景-1]

如果你调用了 [startScreenCapture](/zh-CN/api-reference/rtc/harmonyos/video/screencapture#api_irtcengine_startscreencapture) 开启屏幕采集，则停止屏幕采集时需要调用该方法。

<a id="api_irtcengine_stopscreencapture__timing"></a>

### 调用时机 [#调用时机-1]

该方法在加入频道前后均可调用。

<a id="api_irtcengine_stopscreencapture__restriction"></a>

### 调用限制 [#调用限制-1]

无。

<a id="api_irtcengine_stopscreencapture__return_values"></a>

### 返回值 [#返回值-1]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-1]

- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_updatescreencaptureparameters"></a>

<a id="ariaid-title4"></a>

## updateScreenCaptureParameters [#updatescreencaptureparameters]

更新屏幕采集的参数配置。

<a id="api_irtcengine_updatescreencaptureparameters__prototype"></a>

```ts
public abstract updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): number;
```

<a id="api_irtcengine_updatescreencaptureparameters__detailed_desc"></a>

### 详情 [#详情]

:::caution
注意：

- 请在开启屏幕共享或窗口共享后调用该方法。
:::

<a id="api_irtcengine_updatescreencaptureparameters__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="screencaptureparameters-1"></a>
<Parameter name="screenCaptureParameters">

屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080，即 2073600 像素。该像素值为计费标准。详见 。

:::caution
注意： 屏幕共享流的视频属性只需通过该参数设置，与 [setVideoEncoderConfiguration](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_setvideoencoderconfiguration) 无关。
:::

</Parameter>
</ParameterList>

<a id="api_irtcengine_updatescreencaptureparameters__return_values"></a>

### 返回值 [#返回值-2]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -2：传入的参数无效。
  - -8：屏幕共享状态无效。可能因为你已经共享了其他屏幕或窗口。尝试调用 [stopScreenCapture](/zh-CN/api-reference/rtc/harmonyos/video/screencapture#api_irtcengine_stopscreencapture) 停止当前共享，再重新开始共享屏幕。