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