---
name: "getVideoInfo"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.5.0" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getVideoInfo - 获取视频信息"
---

## getVideoInfo

> [VERSION] BaseKit >= 2.5.0 | @ray-js/ray >= 0.5.9

> [PLATFORM] iOS, Android

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

### 描述

获取视频信息

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `src` | `string` | 是 | - | `2.5.0` | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `width` | `number` | `3.2.6` | 视频原始宽度，单位px。不考虑旋转。 |
| `height` | `number` | `3.2.6` | 视频原始高度，单位px。不考虑旋转。 |
| `orientation` | `string` | `3.2.6` | 画面方向 合法值	说明 up	默认方向（手机横持拍照），对应 Exif 中的 1。或无 orientation 信息。 up-mirrored	同 up，但镜像翻转，对应 Exif 中的 2 down	旋转180度，对应 Exif 中的 3 down-mirrored	同 down，但镜像翻转，对应 Exif 中的 4 left-mirrored	同 left，但镜像翻转，对应 Exif 中的 5 right	顺时针旋转90度，对应 Exif 中的 6 right-mirrored	同 right，但镜像翻转，对应 Exif 中的 7 left	逆时针旋转90度，对应 Exif 中的 8 |
| `type` | `string` | `3.2.6` | 视频格式，取值来自媒体解析结果，例如 mp4 |
| `duration` | `number` | `3.2.6` | 视频时长，单位秒 |
| `size` | `number` | `3.2.6` | 视频大小，单位 kB |
| `fps` | `number` | `3.2.6` | 视频帧率 |
| `bitrate` | `number` | `3.2.6` | 视频码率，单位 kbps |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

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

// 获取视频信息：先下载视频，用回调返回的协议路径 tempFilePath 调用
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
  success: ({ tempFilePath }) => {
    getVideoInfo({
      src: tempFilePath,
      success: data => console.log("宽高/时长/格式：", data.width, data.height, data.duration, data.type),
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});
```