---
name: "privacyProtectDetectForVideo"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.2.0" }
  - { name: "@ray-js/ray", version: "1.7.9" }
platform:
  - "iOS"
  - "Android"
async: true
title: "privacyProtectDetectForVideo - 视频隐私保护识别处理"
---

## privacyProtectDetectForVideo

> [VERSION] AIKit >= 1.2.0 | @ray-js/ray >= 1.7.9

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

对视频进行隐私保护区域识别处理

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `inputVideoPath` | `string` | 是 | - | `1.2.0` | 视频输入路径 |
| `outputVideoPath` | `string` | 是 | - | `1.2.0` | 视频输出路径 |
| `videoConfig` | `1 \| 2 \| 3 \| 4` | 否 | `4` | `1.2.0` | 视频配置信息 -- 默认1080 |
| `detectType` | `1 \| 2` | 否 | `1` | `1.2.0` | 识别类型 |
| `imageEditType` | `1 \| 2 \| 3` | 否 | `1` | `1.2.0` | 图像处理类型 |
| `musicPath` | `string` | 是 | - | `1.2.0` | 配乐本地地址 |
| `audioEditType` | `1 \| 2 \| 3` | 否 | `1` | `1.2.0` | 音频处理类型 |
| `originAudioVolume` | `number` | 否 | `0.5` | `1.2.0` | 原始音频音量 |
| `overlayAudioVolume` | `number` | 否 | `0.5` | `1.2.0` | 覆盖音频音量 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `path` | `string` | `1.2.0` | 输出路径 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 合法值

##### `videoConfig` 合法值

| 值 | 说明 |
| --- | --- |
| `1` | 480 |
| `2` | 540 |
| `3` | 720 |
| `4` | 1080（默认） |

##### `detectType` 合法值

| 值 | 说明 |
| --- | --- |
| `1` | 宠物 |
| `2` | 人物 |

##### `imageEditType` 合法值

| 值 | 说明 |
| --- | --- |
| `1` | 没有效果 |
| `2` | 主体突出 |
| `3` | 隐私保护 |

##### `audioEditType` 合法值

| 值 | 说明 |
| --- | --- |
| `1` | 不处理 |
| `2` | 0.5 0.5 混音 |
| `3` | 视频静音 |


### 示例代码

#### 基础调用

```tsx
import { ai } from '@ray-js/ray'

const { privacyProtectDetectForVideo } = ai;

privacyProtectDetectForVideo({
  inputVideoPath: 'example',
  outputVideoPath: 'example',
  musicPath: 'example',
  success: (result) => {
    console.log('privacyProtectDetectForVideo success', result);
  },
  fail: (error) => {
    console.log('privacyProtectDetectForVideo fail', error.errorMsg);
  },
});
```