---
name: "saveVideoToPhotosAlbum"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.5.0" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
title: "saveVideoToPhotosAlbum - 保存视频到系统相册，支持 mp4 视频格式，需要相册权限"
---

## saveVideoToPhotosAlbum

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

> [PLATFORM] iOS, Android

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

### 描述

保存视频到系统相册，支持mp4视频格式，需要相册权限

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `filePath` | `string` | 是 | - | `2.5.0` | 视频文件路径，可以是临时文件路径也可以是永久文件路径 (本地路径) |
| `modifyCreationDate` | `boolean` | 否 | `false` | `3.16.0` | 是否修改视频的创建日期 默认false，不修改视频的创建日期。ture，修改视频的创建日期为当前保存时间 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `localIdentifier` | `string` | `3.14.0` | 相册视频标识符 |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

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

// 保存视频到系统相册（需相册权限）：先下载视频，再用协议路径保存
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
  success: ({ tempFilePath }) => {
    saveVideoToPhotosAlbum({
      filePath: tempFilePath,
      modifyCreationDate: false,
      success: data => console.log("已保存，相册标识：", data.localIdentifier),
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});
```