# 本地截图上传 (/zh-CN/api-reference/rtc/unreal-cpp/video/video-prenpro/snapshot) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## enableContentInspect [#enablecontentinspect] 开启/关闭本地截图上传。 ```cpp virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config) = 0; ``` 开启本地截图上传后,SDK 会根据你在 [ContentInspectConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-contentinspectconfig) 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后,声网服务器会以 HTTPS 请求的形式,向你的服务器发送回调通知,并将所有截图发送至你指定的第三方云存储。 ### 调用时机 [#调用时机] 加入频道前后均可调用。 ### 调用限制 [#调用限制] - 调用该方法前,请确保已在声网控制台开通本地截图上传服务。 - 视频审核模块选择声网自研插件截图上传(CONTENT_INSPECT_SUPERVISION)时需集成本地截图上传动态库 `libagora_content_inspect_extension.dll`,如果删除该动态库会导致无法正常开启本地截图上传功能。 ### 参数 [#参数] 设置是否开启本地截图上传: - `true`:开启本地截图上传。 - `false`:关闭本地截图上传。 本地截图上传配置。详见 [ContentInspectConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-contentinspectconfig)。 ### 返回值 [#返回值] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## enableContentInspectEx [#enablecontentinspectex] 开启/关闭本地截图上传。 ```cpp virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection& connection) = 0; ``` 该方法可以对多条视频流截图并上传。开启本地截图上传后,SDK 会根据你在 [ContentInspectConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-contentinspectconfig) 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后,声网服务器会以 HTTPS 请求的形式,向你的服务器发送回调通知,并将所有截图发送至你指定的第三方云存储。 ### 调用时机 [#调用时机-1] 加入频道前后均可调用。 ### 调用限制 [#调用限制-1] 调用该方法前,请确保已[联系技术支持](https://ticket.shengwang.cn/)开通本地截图上传服务。 ### 参数 [#参数-1] 设置是否开启本地截图上传: - `true`:开启本地截图上传。 - `false`:关闭本地截图上传。 本地截图上传配置。详见 [ContentInspectConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-contentinspectconfig)。 Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 ### 返回值 [#返回值-1] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## takeSnapshot [#takesnapshot] 对视频截图。 ```cpp virtual int takeSnapshot(uid_t uid, const char* filePath) = 0; ``` 该方法用于对指定用户的视频流进行截图,生成一张 JPG 格式的图片,并保存至指定的路径。 ### 调用时机 [#调用时机-2] 该方法需要在加入频道后调用。 ### 调用限制 [#调用限制-2] - 该方法是异步操作,调用返回时 SDK 并没有真正获取截图。 - 该方法用于本地视频截图时,是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/class-channelmediaoptions) 中指定发布的视频流进行截图。 - 如果用户的视频经过前处理,例如,添加了水印或美颜,生成的截图会包含前处理效果。 ### 相关回调 [#相关回调] 成功调用该方法后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/unreal-cpp/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功和获取截图的详情。 ### 参数 [#参数-2] 用户 ID。如果要对本地用户的视频截图,则设为 0。 截图的本地保存路径,需精确到文件名及格式,例如: - Windows: `C:\Users\\AppData\Local\Agora\\example.jpg` - iOS: `/App Sandbox/Library/Caches/example.jpg` - macOS: `~/Library/Logs/example.jpg` - Android: `/storage/emulated/0/Android/data//files/example.jpg` :::caution 注意: 请确保目录存在且可写。 ::: ### 返回值 [#返回值-2] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## takeSnapshot [2/2] [#takesnapshot-22] 在指定观测位置进行视频截图。 ```cpp virtual int takeSnapshot(uid_t uid, const media::SnapshotConfig& config) = 0; ``` 该方法用于对指定用户的视频流进行截图,生成一张 JPG 格式的图片,并保存至指定的路径。 ### 调用时机 [#调用时机-3] 该方法需要在加入频道后调用。 ### 调用限制 [#调用限制-3] - 该方法是异步操作,调用返回时 SDK 并没有真正获取截图。 - 该方法用于本地视频截图时,是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/class-channelmediaoptions) 中指定发布的视频流进行截图。 ### 相关回调 [#相关回调-1] 成功调用该方法后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/unreal-cpp/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功和获取截图的详情。 ### 参数 [#参数-3] 用户 ID。如果要对本地用户的视频截图,则设为 0。 截图设置,详见 [SnapshotConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-snapshotconfig)。 ### 返回值 [#返回值-3] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## takeSnapshotEx [#takesnapshotex] 使用连接 ID 获取视频截图。 ```cpp virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const char* filePath) = 0; ``` 该方法用于对指定用户的视频流进行截图,生成一张 JPG 格式的图片,并保存至指定的路径。 ### 调用时机 [#调用时机-4] 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 后调用。 ### 调用限制 [#调用限制-4] - 该方法是异步操作,调用返回时 SDK 并没有真正获取截图。 - 该方法用于本地视频截图时,是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/class-channelmediaoptions) 中指定发布的视频流进行截图。 - 如果用户的视频经过前处理,例如,添加了水印或美颜,生成的截图会包含前处理效果。 ### 相关回调 [#相关回调-2] 成功调用该方法后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/unreal-cpp/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功和获取截图的详情。 ### 参数 [#参数-4] Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 用户 ID。如果要对本地用户的视频截图,则设为 0。 截图的本地保存路径,需精确到文件名及格式,例如: - Windows: `C:\Users\\AppData\Local\Agora\\example.jpg` - iOS: `/App Sandbox/Library/Caches/example.jpg` - macOS: `~/Library/Logs/example.jpg` - Android: `/storage/emulated/0/Android/data//files/example.jpg` :::caution 注意: 请确保目录存在且可写。 ::: ### 返回值 [#返回值-4] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-4] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## takeSnapshotEx [2/2] [#takesnapshotex-22] 使用连接 ID 获取指定观测位置的视频截图。 ```cpp virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const media::SnapshotConfig& config) = 0; ``` 该方法用于对指定用户的视频流进行截图,生成一张 JPG 格式的图片,并保存至指定的路径。 ### 调用时机 [#调用时机-5] 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 后调用。 ### 调用限制 [#调用限制-5] - 该方法是异步操作,调用返回时 SDK 并没有真正获取截图。 - 该方法用于本地视频截图时,是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unreal-cpp/class-channelmediaoptions) 中指定发布的视频流进行截图。 - 如果用户的视频经过前处理,例如,添加了水印或美颜,生成的截图会包含前处理效果。 ### 相关回调 [#相关回调-3] 成功调用该方法后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/unreal-cpp/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功和获取截图的详情。 ### 参数 [#参数-5] Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 用户 ID。如果要对本地用户的视频截图,则设为 0。 截图设置,详见 [SnapshotConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-snapshotconfig)。 ### 返回值 [#返回值-5] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-5] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## onSnapshotTaken [#onsnapshottaken] 视频截图结果回调。 ```cpp virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) { (void)uid; (void)filePath; (void)width; (void)height; (void)errCode; } ``` ### 详情 [#详情] 成功调用 [takeSnapshot](/zh-CN/api-reference/rtc/unreal-cpp/video/video-prenpro/snapshot#api_irtcengine_takesnapshot) 后,SDK 触发该回调报告截图是否成功和获取截图的详情。 ### 参数 [#参数-6] 用户 ID。如果 uid 为 0,表示本地用户。 截图的本地保存路径。 图片宽度(px)。 图片高度(px)。 截图成功的提示或失败的原因。 - 0:截图成功。 - < 0: 截图失败。 - -1:写入文件失败或 JPEG 编码失败。 - -2:takeSnapshot 方法调用后 1 秒内没有收到指定用户的视频帧。可能的原因有:本地采集停止、远端停止发布或者视频数据处理堵塞。 - -3:takeSnapshot 方法调用过于频繁。 ### 所属接口类 [#所属接口类-6] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)