---
name: "getCurrentVolumeByMode"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "3.3.3" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getCurrentVolumeByMode

> [VERSION] BaseKit >= 3.3.3

> [PLATFORM] iOS, Android

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

### Description

Get system volume for different modes. Note: Android supports retrieving volume values for different system sounds via the volumeMode parameter. iOS has only one system volume; volumeMode has no effect.

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `volumeMode` | `number` | No | `2` | `3.3.3` | Volume type (Android only) 0: Voice call volume 1: System volume 2: Ringtone, notification, system default sounds 3: Media/music volume 4: Alarm volume 5: Notification volume 6: Bluetooth volume |
| `complete` | `() => void` | No | - | - | Completion callback (runs on success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback for API call success |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Callback for API call failure |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `value` | `number` | `3.3.3` | Volume, range [0 - 1] |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Extended error code |
| `errorMsg` | `string` | Extended error info |


### Examples

```tsx
ty.getCurrentVolumeByMode({
  volumeMode: 2,
  success: data => {
    console.log(data.value);
  },
  fail: error => {
    console.error(error);
  },
});
```