---
name: "clipVideo"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "3.14.2" }
  - { name: "@ray-js/ray", version: "1.5.33" }
platform:
  - "iOS"
  - "Android"
async: true
title: "clipVideo - 裁剪视频"
---

## clipVideo

> [VERSION] BaseKit >= 3.14.2 | @ray-js/ray >= 1.5.33

> [PLATFORM] iOS, Android

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

### 描述

裁剪视频

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `filePath` | `string` | 是 | - | `3.14.2` | 视频文件路径，可以是临时文件路径也可以是永久文件路径 (本地路径) |
| `startTime` | `number` | 是 | - | `3.14.2` | 开始时间，毫秒 |
| `endTime` | `number` | 是 | - | `3.14.2` | 结束时间，毫秒 |
| `level` | `number` | 是 | - | `3.14.2` | 目标压缩的分辨率 1 - 480*854  码率：1572*1000 2 - 540*960   码率：2128*1000 3 - 720*1280  码率：3145*1000 4 - 1080*1920  码率：3500*1000 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `videoClipPath` | `string` | `3.14.2` | 裁剪视频路径 |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

```tsx
import { downloadFile, clipVideo } from '@ray-js/ray'

// 裁剪视频：先下载视频，用协议路径 tempFilePath 调用；level 1~4 对应分辨率档位（1=480*854）
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
  success: ({ tempFilePath }) => {
    clipVideo({
      filePath: tempFilePath,
      startTime: 0,
      endTime: 3000,
      level: 1,
      success: data => console.log("裁剪后视频路径：", data.videoClipPath),
      fail: error => console.error("裁剪失败：", JSON.stringify(error)),
    });
  },
  fail: error => console.error("下载失败：", JSON.stringify(error)),
});
```
