# 本地合图 (/zh-CN/api-reference/rtc/electron/video/video-prenpro/local-transcoder)

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

<a id="toc_local_transcoder"></a>

<a id="api_irtcengine_startlocalvideotranscoder"></a>

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

## startLocalVideoTranscoder [#startlocalvideotranscoder]

开启本地合图。

<a id="api_irtcengine_startlocalvideotranscoder__prototype"></a>

```ts
abstract startLocalVideoTranscoder(
    config: LocalTranscoderConfiguration
  ): number;
```

<a id="api_irtcengine_startlocalvideotranscoder__detailed_desc"></a>

调用该方法后，你可以在本地将多路视频流合并为一路视频流。例如：将摄像头采集的视频流、屏幕共享流、媒体播放器中的视频流、远端视频流、视频文件、图片等合并为一路视频流，然后将已合图的视频流发布到频道中。

:::note
注：

- 本地合图对 CPU 的消耗较高，声网建议你在性能较高的设备上开启该功能。
- 如果你需要对本地采集的视频流进行合图，SDK 支持如下采集组合：

  - 在 Windows 平台上，最多支持 4 路摄像头采集的视频流 + 4 路屏幕共享流合图。
  - 在 macOS 平台上，最多支持 4 路摄像头采集的视频流 + 1 路屏幕共享流合图。
- 在进行合图配置时，需确保采集人像的摄像头视频流在合图中的图层编号大于屏幕共享流的图层编号，否则人像会被屏幕共享覆盖、无法显示在最终合图的视频流中。
:::

<a id="api_irtcengine_startlocalvideotranscoder__scenario"></a>

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

你可以在远程会议、直播、在线教育等场景下开启本地合图功能，可以让用户更加方便地查看和管理多个视频画面，同时支持人像画中画等功能。
以下是一个实现人像画中画的典型场景：

1. 调用 `enableVirtualBackground`，并将自定义背景图设置为 `BackgroundNone`，即：在摄像头采集的视频中将人像和背景分割。
2. 调用 `startScreenCaptureBySourceType`，开始采集屏幕共享视频流。
3. 调用该方法，并将采集人像的视频源设置为参与本地合图的视频源之一，即可在合图后的视频中实现人像画中画。

<a id="api_irtcengine_startlocalvideotranscoder__timing"></a>

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

- 如果你需要对本地采集的视频流进行合图，需要在 [startCameraCapture](/zh-CN/api-reference/rtc/electron/video/camera-capture#api_irtcengine_startcameracapture) 或 [startScreenCaptureBySourceType](/zh-CN/api-reference/rtc/electron/video/screencapture#api_irtcengine_startscreencapture2) 之后调用该方法。
- 如果你要将合图后的视频流发布到频道中，需要在调用 [joinChannel](/zh-CN/api-reference/rtc/electron/channel#api_irtcengine_joinchannel2) 或 [updateChannelMediaOptions](/zh-CN/api-reference/rtc/electron/channel#api_irtcengine_updatechannelmediaoptions) 时，将 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `publishTranscodedVideoTrack` 设置为 true。

<a id="api_irtcengine_startlocalvideotranscoder__related"></a>

### 相关回调 [#相关回调]

当你调用该方法失败时，SDK 会触发 [onLocalVideoTranscoderError](/zh-CN/api-reference/rtc/electron/video/video-prenpro/local-transcoder#callback_irtcengineeventhandler_onlocalvideotranscodererror) 回调，报告合图失败的原因。

<a id="api_irtcengine_startlocalvideotranscoder__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="config"></a>
<Parameter name="config">

本地合图的配置，详见 [LocalTranscoderConfiguration](/zh-CN/api-reference/rtc/electron/class-localtranscoderconfiguration)。

:::note
注：

- 参与本地合图的每一路视频流的分辨率最大为 4096 × 2160，如果超出此限制，会导致合图不生效。
- 合图后的视频流最大分辨率为 4096 × 2160。
:::

</Parameter>
</ParameterList>

<a id="api_irtcengine_startlocalvideotranscoder__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_stoplocalvideotranscoder"></a>

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

## stopLocalVideoTranscoder [#stoplocalvideotranscoder]

停止本地合图。

<a id="api_irtcengine_stoplocalvideotranscoder__prototype"></a>

```ts
abstract stopLocalVideoTranscoder(): number;
```

<a id="api_irtcengine_stoplocalvideotranscoder__detailed_desc"></a>

调用 [startLocalVideoTranscoder](/zh-CN/api-reference/rtc/electron/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) 后，如果你希望停止本地合图，请调用该方法。

<a id="api_irtcengine_stoplocalvideotranscoder__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_updatelocaltranscoderconfiguration"></a>

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

## updateLocalTranscoderConfiguration [#updatelocaltranscoderconfiguration]

更新本地合图配置。

<a id="api_irtcengine_updatelocaltranscoderconfiguration__prototype"></a>

```ts
abstract updateLocalTranscoderConfiguration(
    config: LocalTranscoderConfiguration
  ): number;
```

<a id="api_irtcengine_updatelocaltranscoderconfiguration__detailed_desc"></a>

调用 [startLocalVideoTranscoder](/zh-CN/api-reference/rtc/electron/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) 后，如果你希望更新本地合图配置，请调用该方法。

:::note
注： 如果你想要更新用于合图的的本地采集视频源类型，比如：增加第二路摄像头或者屏幕采集的视频，需要在 [startCameraCapture](/zh-CN/api-reference/rtc/electron/video/camera-capture#api_irtcengine_startcameracapture) 或 [startScreenCaptureBySourceType](/zh-CN/api-reference/rtc/electron/video/screencapture#api_irtcengine_startscreencapture2) 之后调用该方法。
:::

<a id="api_irtcengine_updatelocaltranscoderconfiguration__parameters"></a>

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

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

本地合图的配置，详见 [LocalTranscoderConfiguration](/zh-CN/api-reference/rtc/electron/class-localtranscoderconfiguration)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_updatelocaltranscoderconfiguration__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="callback_irtcengineeventhandler_onlocalvideotranscodererror"></a>

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

## onLocalVideoTranscoderError [#onlocalvideotranscodererror]

本地合图发生错误回调。

<a id="callback_irtcengineeventhandler_onlocalvideotranscodererror__prototype"></a>

```ts
onLocalVideoTranscoderError?(
    stream: TranscodingVideoStream,
    error: VideoTranscoderError
  ): void;
```

<a id="callback_irtcengineeventhandler_onlocalvideotranscodererror__detailed_desc"></a>

当你调用 [startLocalVideoTranscoder](/zh-CN/api-reference/rtc/electron/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) 或 [updateLocalTranscoderConfiguration](/zh-CN/api-reference/rtc/electron/video/video-prenpro/local-transcoder#api_irtcengine_updatelocaltranscoderconfiguration) 失败时，SDK 会触发该回调，报告合图失败的原因。

<a id="callback_irtcengineeventhandler_onlocalvideotranscodererror__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="stream"></a>
<Parameter name="stream">

合图失败的视频流。详见 [TranscodingVideoStream](/zh-CN/api-reference/rtc/electron/class-transcodingvideostream)。

</Parameter>
<a id="error"></a>
<Parameter name="error">

本地合图出错原因。详见 [VideoTranscoderError](/zh-CN/api-reference/rtc/electron/enum-videotranscodererror)。

</Parameter>
</ParameterList>

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

- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineeventhandler)