# 本地截图上传 (/zh-CN/api-reference/rtc/android/video/video-prenpro/snapshot) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## enableContentInspect [#enablecontentinspect] 启用或关闭本地截图上传功能。 ```java public abstract int enableContentInspect(boolean enabled, ContentInspectConfig config); ``` SDK 会根据在 [ContentInspectConfig](/zh-CN/api-reference/rtc/android/class-contentinspectconfig) 中设置的模块类型和频率,对本地用户发送的视频进行截图并上传。完成截图和上传后,声网服务器会通过 HTTPS 请求将回调通知发送到你的应用服务器,并将所有截图发送到第三方云存储服务。 :::note 注: - 在调用该方法前,请确保你已在声网控制台启用本地截图上传功能。 - 当视频审核模块设置为使用声网自研扩展(`CONTENT_INSPECT_TYPE_SUPERVISE`)进行视频审核时,需要使用本地截图上传动态库 agora_content_inspect_extension.so。删除该库将禁用截图上传功能。 ::: ### 调用时机 [#调用时机] 该方法可以在加入频道前或加入频道后调用。 ### 参数 [#参数] 是否启用本地截图上传功能: - true:启用本地截图上传功能。 - false:关闭本地截图上传功能。 截图上传配置,详见 [ContentInspectConfig](/zh-CN/api-reference/rtc/android/class-contentinspectconfig)。 ### 返回值 [#返回值] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) ## enableContentInspectEx [#enablecontentinspectex] 启用或关闭本地截图上传功能。 ```java public abstract int enableContentInspectEx(boolean enabled, ContentInspectConfig config, RtcConnection connection); ``` 启用该功能后,SDK 会根据你在 [ContentInspectConfig](/zh-CN/api-reference/rtc/android/class-contentinspectconfig) 中设置的模块类型和频率,对本地用户发送的视频进行截图并上传。截图上传后,声网服务器会通过 HTTPS 请求将回调通知发送到你的应用服务器,并将所有截图上传至第三方云存储服务。 :::note 注: 在调用该方法前,请确保你已[联系技术支持](https://ticket.shengwang.cn/)开通本地截图上传服务。 ::: ### 适用场景 [#适用场景] 该方法适用于多频道场景。 ### 调用时机 [#调用时机-1] 该方法可在加入频道前或后调用。 ### 参数 [#参数-1] 是否启用本地截图上传功能: - true:启用本地截图上传功能。 - false:关闭本地截图上传功能。 截图上传的配置参数,详见 [ContentInspectConfig](/zh-CN/api-reference/rtc/android/class-contentinspectconfig)。 连接信息,详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。 ### 返回值 [#返回值-1] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex) ## takeSnapshot [1/2] [#takesnapshot-12] 截取指定用户的视频流快照并保存为 JPG 图像。 ```java public abstract int takeSnapshot(int uid, String filePath); ``` :::note 注: 该方法为异步方法,调用返回时 SDK 尚未完成快照操作。当用于本地视频快照时,该方法会对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中指定的视频流进行快照。如果用户的视频已进行预处理,例如添加水印或美颜,生成的快照将包含预处理效果。 ::: ### 调用时机 [#调用时机-2] 请在加入频道后调用该方法。 ### 相关回调 [#相关回调] 调用该方法成功后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/android/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告快照是否成功以及快照的详细信息。 ### 参数 [#参数-2] 用户 ID。如果要截取本地用户的视频快照,请将 `uid` 设置为 0。 :::note 注: 请确保指定的路径存在且可写。 ::: 快照的本地路径(包含文件扩展名)。例如: - Android: `/storage/emulated/0/Android/data//files/example.jpg` ### 返回值 [#返回值-2] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) ## takeSnapshot [2/2] [#takesnapshot-22] 在指定的观察点截取视频截图。 ```java public abstract int takeSnapshot(int uid, SnapshotConfig config); ``` :::note 注: - 该方法为异步调用,调用返回时 SDK 尚未完成截图操作。 - 当用于本地视频截图时,该方法会对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中指定的视频流进行截图。 ::: ### 调用时机 [#调用时机-3] 请在加入频道后调用该方法。 ### 相关回调 [#相关回调-1] 调用该方法成功后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/android/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功以及截图的详细信息。 ### 参数 [#参数-3] 用户 ID。如果要截取本地用户的视频,请将 `uid` 设置为 0。 截图的配置信息,详见 [SnapshotConfig](/zh-CN/api-reference/rtc/android/class-snapshotconfig)。 ### 返回值 [#返回值-3] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) ## takeSnapshotEx [1/2] [#takesnapshotex-12] 使用连接 ID 对视频流进行截图。 ```java public abstract int takeSnapshotEx(RtcConnection connection, int uid, String filePath); ``` :::note 注: `takeSnapshotEx` 为异步调用,调用该方法时 SDK 尚未完成截图操作。用于本地视频截图时,会对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中指定的视频流进行截图。如果用户的视频已进行预处理(如添加水印或美颜),截图结果中会包含这些预处理效果。 ::: ### 适用场景 [#适用场景-1] 适用于多频道场景。 ### 调用时机 [#调用时机-4] 请在调用 [joinChannelEx](/zh-CN/api-reference/rtc/android/channel#api_irtcengineex_joinchannelex) 后调用该方法。 ### 相关回调 [#相关回调-2] 调用该方法成功后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/android/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功以及截图的详细信息。 ### 参数 [#参数-4] 连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。 用户 ID。如果要对本地用户的视频进行截图,请将 `uid` 设置为 0。 :::note 注: 请确保指定的路径存在且可写。 ::: 截图的本地路径(包含文件扩展名)。例如: - Android: `/storage/emulated/0/Android/data//files/example.jpg` ### 返回值 [#返回值-4] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-4] - [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex) ## takeSnapshotEx [2/2] [#takesnapshotex-22] 通过连接 ID 获取指定用户的视频截图。 ```java public abstract int takeSnapshotEx(RtcConnection connection, int uid, SnapshotConfig config); ``` :::note 注: - 该方法为异步调用,调用该方法后 SDK 并不会立即完成截图。 - 用于本地视频截图时,该方法会对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/android/class-channelmediaoptions) 中指定的视频流进行截图。 - 如果用户的视频已进行预处理,例如添加水印或美颜,截图结果中会包含这些预处理效果。 ::: ### 适用场景 [#适用场景-2] 适用于多频道场景。 ### 调用时机 [#调用时机-5] 请在调用 [joinChannelEx](/zh-CN/api-reference/rtc/android/channel#api_irtcengineex_joinchannelex) 后调用该方法。 ### 相关回调 [#相关回调-3] 调用该方法成功后,SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/android/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调,报告截图是否成功以及截图的详细信息。 ### 参数 [#参数-5] 连接信息,详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。 用户 ID。如果要截取本地用户的视频,请将 `uid` 设置为 0。 截图的配置信息,详见 [SnapshotConfig](/zh-CN/api-reference/rtc/android/class-snapshotconfig)。 ### 返回值 [#返回值-5] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-5] - [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex) ## onSnapshotTaken [#onsnapshottaken] 视频截图结果回调。 ```java public void onSnapshotTaken(int uid, String filePath, int width, int height, int errCode) ``` 该回调在调用 `takeSnapshot` 方法成功后被触发,用于报告截图的详细信息和是否成功。 ### 触发时机 [#触发时机] 该回调在调用 `takeSnapshot` 方法成功后被触发。 ### 参数 [#参数-6] 用户 ID。`uid` 为 0 表示本地用户。 截图的本地路径。 截图的宽度(像素)。 截图的高度(像素)。 截图结果的错误码: - 0:成功。 - < 0:失败: - -1:SDK 写入文件或编码 JPEG 图像失败。 - -2:调用 `takeSnapshot` 方法成功后 1 秒内未找到指定用户的视频流。可能原因包括:本地采集停止、远端停止发布或视频数据处理阻塞。 - -3:调用 `takeSnapshot` 方法过于频繁。 ### 所属接口类 [#所属接口类-6] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineeventhandler)