# 本地截图上传 (/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot)

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

<a id="toc_snapshot"></a>

<a id="api_irtcengine_enablecontentinspect"></a>

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

## enableContentInspect [#enablecontentinspect]

开启/关闭本地截图上传。

<a id="api_irtcengine_enablecontentinspect__prototype"></a>

```ts
abstract enableContentInspect(
    enabled: boolean,
    config: ContentInspectConfig
  ): number;
```

<a id="api_irtcengine_enablecontentinspect__detailed_desc"></a>

开启本地截图上传后，SDK 会根据你在 [ContentInspectConfig](/zh-CN/api-reference/rtc/react-native/class-contentinspectconfig) 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。

:::note
注：

- 调用该方法前，请确保已在声网控制台开通本地截图上传服务。
- 视频审核模块选择声网自研插件截图上传（`ContentInspectSupervision`）时需集成本地截图上传动态库 `libagora_content_inspect_extension.dll`，如果删除该动态库会导致无法正常开启本地截图上传功能。
:::

<a id="api_irtcengine_enablecontentinspect__timing"></a>

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

加入频道前后均可调用。

<a id="api_irtcengine_enablecontentinspect__parameters"></a>

### 参数 [#参数]

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

设置是否开启本地截图上传：

- true：开启本地截图上传。
- false：关闭本地截图上传。

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

本地截图上传配置。详见 [ContentInspectConfig](/zh-CN/api-reference/rtc/react-native/class-contentinspectconfig)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_enablecontentinspect__return_values"></a>

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

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

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

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

<a id="api_irtcengineex_enablecontentinspectex"></a>

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

## enableContentInspectEx [#enablecontentinspectex]

开启/关闭本地截图上传。

<a id="api_irtcengineex_enablecontentinspectex__prototype"></a>

```ts
abstract enableContentInspectEx(
    enabled: boolean,
    config: ContentInspectConfig,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_enablecontentinspectex__detailed_desc"></a>

该方法可以对多条视频流截图并上传。开启本地截图上传后，SDK 会根据你在 [ContentInspectConfig](/zh-CN/api-reference/rtc/react-native/class-contentinspectconfig) 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。

:::note
注： 调用该方法前，请确保已[联系技术支持](https://ticket.shengwang.cn/)开通本地截图上传服务。
:::

<a id="api_irtcengineex_enablecontentinspectex__timing"></a>

### 调用时机 [#调用时机-1]

加入频道前后均可调用。

<a id="api_irtcengineex_enablecontentinspectex__parameters"></a>

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

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

设置是否开启本地截图上传：

- true：开启本地截图上传。
- false：关闭本地截图上传。

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

本地截图上传配置。详见 [ContentInspectConfig](/zh-CN/api-reference/rtc/react-native/class-contentinspectconfig)。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_enablecontentinspectex__return_values"></a>

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

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_takesnapshot"></a>

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

## takeSnapshot [#takesnapshot]

对视频截图。

<a id="api_irtcengine_takesnapshot__prototype"></a>

```ts
abstract takeSnapshot(uid: number, filePath: string): number;
```

<a id="api_irtcengine_takesnapshot__detailed_desc"></a>

该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

:::note
注：

- 调用该方法返回时 SDK 并没有真正获取截图。
- 该方法用于本地视频截图时，是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/class-channelmediaoptions) 中指定发布的视频流进行截图。
- 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。
:::

<a id="api_irtcengine_takesnapshot__timing"></a>

### 调用时机 [#调用时机-2]

该方法需要在加入频道后调用。

<a id="api_irtcengine_takesnapshot__related"></a>

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

成功调用该方法后，SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调，报告截图是否成功和获取截图的详情。

<a id="api_irtcengine_takesnapshot__parameters"></a>

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

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

用户 ID。如果要对本地用户的视频截图，则设为 0。

</Parameter>
<a id="filepath"></a>
<Parameter name="filePath">

:::note
注： 请确保目录存在且可写。
:::

截图的本地保存路径，需精确到文件名及格式，例如：

- iOS: `/App Sandbox/Library/Caches/example.jpg`
- Android: `/storage/emulated/0/Android/data/<package name>/files/example.jpg`

</Parameter>
</ParameterList>

<a id="api_irtcengine_takesnapshot__return_values"></a>

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

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

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

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

<a id="api_irtcengine_takesnapshot2"></a>

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

## takeSnapshotWithConfig [#takesnapshotwithconfig]

在指定观测位置进行视频截图。

<a id="api_irtcengine_takesnapshot2__prototype"></a>

```ts
abstract takeSnapshotWithConfig(uid: number, config: SnapshotConfig): number;
```

<a id="api_irtcengine_takesnapshot2__detailed_desc"></a>

该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

:::note
注：

- 调用该方法返回时 SDK 并没有真正获取截图。
- 该方法用于本地视频截图时，是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/class-channelmediaoptions) 中指定发布的视频流进行截图。
:::

<a id="api_irtcengine_takesnapshot2__timing"></a>

### 调用时机 [#调用时机-3]

该方法需要在加入频道后调用。

<a id="api_irtcengine_takesnapshot2__related"></a>

### 相关回调 [#相关回调-1]

成功调用该方法后，SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调，报告截图是否成功和获取截图的详情。

<a id="api_irtcengine_takesnapshot2__parameters"></a>

### 参数 [#参数-3]

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

用户 ID。如果要对本地用户的视频截图，则设为 0。

</Parameter>
<a id="config-2"></a>
<Parameter name="config">

截图设置，详见 [SnapshotConfig](/zh-CN/api-reference/rtc/react-native/class-snapshotconfig)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_takesnapshot2__return_values"></a>

### 返回值 [#返回值-3]

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

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

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

<a id="api_irtcengineex_takesnapshotex"></a>

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

## takeSnapshotEx [#takesnapshotex]

使用连接 ID 获取视频截图。

<a id="api_irtcengineex_takesnapshotex__prototype"></a>

```ts
abstract takeSnapshotEx(
    connection: RtcConnection,
    uid: number,
    filePath: string
  ): number;
```

<a id="api_irtcengineex_takesnapshotex__detailed_desc"></a>

该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

:::note
注：

- 调用该方法返回时 SDK 并没有真正获取截图。
- 该方法用于本地视频截图时，是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/class-channelmediaoptions) 中指定发布的视频流进行截图。
- 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。
:::

<a id="api_irtcengineex_takesnapshotex__timing"></a>

### 调用时机 [#调用时机-4]

该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengineex_joinchannelex) 后调用。

<a id="api_irtcengineex_takesnapshotex__related"></a>

### 相关回调 [#相关回调-2]

成功调用该方法后，SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调，报告截图是否成功和获取截图的详情。

<a id="api_irtcengineex_takesnapshotex__parameters"></a>

### 参数 [#参数-4]

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。

</Parameter>
<a id="uid-2"></a>
<Parameter name="uid">

用户 ID。如果要对本地用户的视频截图，则设为 0。

</Parameter>
<a id="filepath-1"></a>
<Parameter name="filePath">

:::note
注： 请确保目录存在且可写。
:::

截图的本地保存路径，需精确到文件名及格式，例如：

- iOS: `/App Sandbox/Library/Caches/example.jpg`
- Android: `/storage/emulated/0/Android/data/<package name>/files/example.jpg`

</Parameter>
</ParameterList>

<a id="api_irtcengineex_takesnapshotex__return_values"></a>

### 返回值 [#返回值-4]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengineex_takesnapshotex2"></a>

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

## takeSnapshotWithConfigEx [#takesnapshotwithconfigex]

使用连接 ID 获取指定观测位置的视频截图。

<a id="api_irtcengineex_takesnapshotex2__prototype"></a>

```ts
abstract takeSnapshotWithConfigEx(
    connection: RtcConnection,
    uid: number,
    config: SnapshotConfig
  ): number;
```

<a id="api_irtcengineex_takesnapshotex2__detailed_desc"></a>

该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

:::note
注：

- 调用该方法返回时 SDK 并没有真正获取截图。
- 该方法用于本地视频截图时，是对 [ChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/class-channelmediaoptions) 中指定发布的视频流进行截图。
- 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。
:::

<a id="api_irtcengineex_takesnapshotex2__timing"></a>

### 调用时机 [#调用时机-5]

该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengineex_joinchannelex) 后调用。

<a id="api_irtcengineex_takesnapshotex2__related"></a>

### 相关回调 [#相关回调-3]

成功调用该方法后，SDK 会触发 [onSnapshotTaken](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) 回调，报告截图是否成功和获取截图的详情。

<a id="api_irtcengineex_takesnapshotex2__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="connection-2"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。

</Parameter>
<a id="uid-3"></a>
<Parameter name="uid">

用户 ID。如果要对本地用户的视频截图，则设为 0。

</Parameter>
<a id="config-3"></a>
<Parameter name="config">

截图设置，详见 [SnapshotConfig](/zh-CN/api-reference/rtc/react-native/class-snapshotconfig)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_takesnapshotex2__return_values"></a>

### 返回值 [#返回值-5]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex)

<a id="callback_irtcengineeventhandler_onsnapshottaken"></a>

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

## onSnapshotTaken [#onsnapshottaken]

视频截图结果回调。

<a id="callback_irtcengineeventhandler_onsnapshottaken__prototype"></a>

```ts
onSnapshotTaken?(
    connection: RtcConnection,
    uid: number,
    filePath: string,
    width: number,
    height: number,
    errCode: number
  ): void;
```

<a id="callback_irtcengineeventhandler_onsnapshottaken__detailed_desc"></a>

成功调用 [takeSnapshot](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengine_takesnapshot) 后，SDK 触发该回调报告截图是否成功和获取截图的详情。

<a id="callback_irtcengineeventhandler_onsnapshottaken__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="uid-4"></a>
<Parameter name="uid">

用户 ID。如果 `uid` 为 0，表示本地用户。

</Parameter>
<a id="connection-3"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。

</Parameter>
<a id="filepath-2"></a>
<Parameter name="filePath">

截图的本地保存路径。

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

图片宽度（px）。

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

图片高度（px）。

</Parameter>
<a id="errcode"></a>
<Parameter name="errCode">

截图成功的提示或失败的原因。

- 0：截图成功。
- &lt; 0: 截图失败。

  - -1：写入文件失败或 JPEG 编码失败。
  - -2：[takeSnapshot](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengine_takesnapshot) 方法调用后 1 秒内没有收到指定用户的视频帧。可能的原因有：本地采集停止、远端停止发布或者视频数据处理堵塞。
  - -3：[takeSnapshot](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengine_takesnapshot) 方法调用过于频繁。

</Parameter>
</ParameterList>

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

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