---
name: "onSystemVolumeChangeEvent"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.5.0" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
---

## onSystemVolumeChangeEvent

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

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

System volume change notification event. Related APIs: [registerSystemVolumeChange, unRegisterSystemVolumeChange]

### Parameters

`(listener: Function)`

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `listener` | `(params: VolumeResponse) => void` | Yes | - |  |

### Referenced Types

##### `interface` VolumeResponse

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `value` | `number` | `3.17.4` | Volume, range [0–1] |
| `volumeMode` | `number` | `3.17.4` | Volume type (Android only) 0: Voice call 1: System sounds 2: Ring, notification, system default tones 3: Media/Music 4: Alarm 5: Notification 6: Bluetooth volume |


### Examples

#### 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));
```