---
name: "updateVolume"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.4.3" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
title: "updateVolume - 设置系统音量"
---

## updateVolume

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

> [PLATFORM] iOS, Android

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

### 描述

设置系统音量

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `value` | `number` | 是 | - | `2.4.3` | 音量，阈值【0 - 1】 |
| `volumeMode` | `number[]` | 否 | `[2]` | `3.3.3` | 音量类型（仅Android生效） 0：语音电话的声音 1：手机系统声音 2：响铃，通知，系统默认音等 3：手机音乐的声音 4：手机闹铃的声音 5：手机通知的声音 6：蓝牙音量 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

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

updateVolume({
  value: 0.5,
  volumeMode: [2],
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```