# 本地合图 (/zh-CN/api-reference/rtc/macos/video/video-prenpro/local-transcoder)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## startLocalVideoTranscoder: [#startlocalvideotranscoder]
开始本地合图。
```objc
- (int)startLocalVideoTranscoder:(AgoraLocalTranscoderConfiguration* _Nonnull)config NS_SWIFT_NAME(startLocalVideoTranscoder(_:));
```
调用该方法后,你可以在本地将多个视频流合并为一个视频流。例如,你可以将摄像头采集的视频流、屏幕共享、媒体播放器、远端视频、视频文件、图片等视频流合并为一个视频流,并将该合图视频流发布到频道中。
:::note
注: 本地合图功能需要更多的 CPU 资源。因此,声网建议在性能较高的设备上启用该功能。
如果需要合成本地采集的视频流,SDK 支持以下采集组合:
- 在 iOS 上,支持最多 2 路摄像头采集的视频流(设备本身需支持双摄或支持外接摄像头)+ 1 路屏幕共享流。
- 在 macOS 上,支持最多 4 路摄像头采集的视频流 + 1 路屏幕共享流。
配置本地合图时,需要确保采集人像的视频流的图层编号大于屏幕共享流的图层编号。否则,人像会被屏幕共享遮挡,无法在最终的合图视频流中显示。
:::
### 适用场景 [#适用场景]
适用于远程会议、直播、在线教育等场景,便于用户查看和管理多个视频流,并支持人像画中画等功能。
### 调用时机 [#调用时机]
如果需要合成本地采集的视频流,需要在调用 `startCameraCapture` 或 `startScreenCapture`(iOS)/`startScreenCapture`(macOS)之后调用该方法。
如果希望将合图视频流发布到频道中,需要在调用 `joinChannelByToken` 或 `updateChannelWithMediaOptions` 时,将 [AgoraRtcChannelMediaOptions](/zh-CN/api-reference/rtc/macos/class-channelmediaoptions) 中的 `publishTranscodedVideoTrack` 设置为 YES。
### 相关回调 [#相关回调]
调用该方法失败时,SDK 会触发 [rtcEngine\:didLocalVideoTranscoderErrorWithStream\:errorCode:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/local-transcoder#callback_irtcengineeventhandler_onlocalvideotranscodererror) 回调报告失败原因。
### 参数 [#参数]
本地合图的配置,详见 [AgoraLocalTranscoderConfiguration](/zh-CN/api-reference/rtc/macos/class-localtranscoderconfiguration)。
:::note
注:
- 每路参与本地合图的视频流的最大分辨率为 4096 × 2160。若超过该限制,合图不生效。
- 合图后的视频流的最大分辨率为 4096 × 2160。
:::
### 返回值 [#返回值]
0:方法调用成功。
< 0:方法调用失败。
### 所属接口类 [#所属接口类]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## stopLocalVideoTranscoder [#stoplocalvideotranscoder]
停止本地合图。
```objc
- (int)stopLocalVideoTranscoder NS_SWIFT_NAME(stopLocalVideoTranscoder());
```
调用 [startLocalVideoTranscoder:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) 方法后,如果你想停止本地合图,可以调用该方法。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## updateLocalTranscoderConfiguration: [#updatelocaltranscoderconfiguration]
更新本地合图配置。
```objc
- (int)updateLocalTranscoderConfiguration:(AgoraLocalTranscoderConfiguration* _Nonnull)config NS_SWIFT_NAME(updateLocalTranscoderConfiguration(_:));
```
调用 [startLocalVideoTranscoder:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) 后,如果你想更新本地合图配置,调用该方法。
:::note
注: 如果你想更新用于本地合图的视频源类型,例如添加第二个摄像头或屏幕进行视频采集,你需要在调用 [startCameraCapture\:config:](/zh-CN/api-reference/rtc/macos/video/camera-capture#api_irtcengine_startcameracapture) 或 `startScreenCapture:`(iOS)/ [startScreenCapture\:config:](/zh-CN/api-reference/rtc/macos/video/screencapture#api_irtcengine_startscreencapture2)(macOS)之后调用该方法。
:::
### 参数 [#参数-1]
本地合图的配置。详见 [AgoraLocalTranscoderConfiguration](/zh-CN/api-reference/rtc/macos/class-localtranscoderconfiguration)。
### 返回值 [#返回值-2]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## rtcEngine\:didLocalVideoTranscoderErrorWithStream\:errorCode: [#rtcenginedidlocalvideotranscodererrorwithstreamerrorcode]
本地合图过程中发生错误时触发的回调。
```objc
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalVideoTranscoderErrorWithStream:(AgoraTranscodingVideoStream * _Nonnull )stream
errorCode:(AgoraVideoTranscoderError)errorCode NS_SWIFT_NAME(rtcEngine(_:didLocalVideoTranscoderErrorWithStream:errorCode:));
```
当你调用 [startLocalVideoTranscoder:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) 或 [updateLocalTranscoderConfiguration:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/local-transcoder#api_irtcengine_updatelocaltranscoderconfiguration) 失败时,SDK 会触发该回调报告失败原因。
### 触发时机 [#触发时机]
该回调在本地合图过程中发生错误时被触发。
### 参数 [#参数-2]
在视频合图过程中无法被合图的视频流。详见 [AgoraTranscodingVideoStream](/zh-CN/api-reference/rtc/macos/class-transcodingvideostream)。
本地合图错误的原因。详见 [AgoraVideoTranscoderError](/zh-CN/api-reference/rtc/macos/enum-videotranscodererror)。
### 所属接口类 [#所属接口类-3]
- [AgoraRtcEngineDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineeventhandler)