---
name: "onSystemVolumeChangeEvent"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.5.0" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
title: "onSystemVolumeChangeEvent - 系统音量监听通知事件"
---

## onSystemVolumeChangeEvent

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

> [PLATFORM] iOS, Android

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

### 描述

系统音量监听通知事件 关联API：[registerSystemVolumeChange, unRegisterSystemVolumeChange]

### 参数

`(listener: Function)`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `listener` | `(params: VolumeResponse) => void` | 是 | - |  |

### 引用对象

##### `interface` VolumeResponse

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `value` | `number` | `3.17.4` | 音量，阈值【0 - 1】 |
| `volumeMode` | `number` | `3.17.4` | 音量类型（仅Android生效） 0：语音电话的声音 1：手机系统声音 2：响铃，通知，系统默认音等 3：手机音乐的声音 4：手机闹铃的声音 5：手机通知的声音 6：蓝牙音量 |


### 示例代码

#### Demo

```tsx
import { registerSystemVolumeChange, onSystemVolumeChangeEvent } from '@ray-js/ray'

registerSystemVolumeChange({
  success: data => {
    console.log("registerSystemVolumeChange ->", data);
  },
  fail: error => {
    console.error("registerSystemVolumeChange failed:", error);
  },
});

onSystemVolumeChangeEvent(e => {
  console.log("onSystemVolumeChangeEvent ->", e);
});

await new Promise(resolve => setTimeout(resolve, 45000));
```