getCurrentVolumeByMode(params: Object)

Requires:
BaseKit≥3.3.3@ray-js/ray≥1.4.57
Platforms:
iOSAndroid
import { getCurrentVolumeByMode } from '@ray-js/ray';

// Promise usage
try {
  const res = await getCurrentVolumeByMode({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Get system volume in different modes. Note: On Android, you can get volumes for different system sounds via the volumeMode parameter. On iOS there is only one system volume; volumeMode has no effect.

Parameters

PropertyTypeRequiredDefaultDescription
volumeModenumberNo2Volume type (Android only) 0: Voice call volume 1: System sounds 2: Ringer, notifications, system default tones, etc. 3: Media volume 4: Alarm volume 5: Notification volume 6: Bluetooth volume
complete() => voidNo-Completion callback (executed on both success and failure)
success(params: Object) => voidNo-Callback on successful API call
fail(params: Object) => voidNo-Failure callback
success callback parameters
PropertyTypeDescription
valuenumberVolume, value range [0–1]
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

import { getCurrentVolumeByMode } from '@ray-js/ray'

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