getCurrentVolume(params: Object)

Requires:
BaseKit≥2.4.3@ray-js/ray≥0.5.9
Platforms:
iOSAndroid
import { getCurrentVolume } from '@ray-js/ray';

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

Description

Get current system volume Note: On Android, system volumes are categorized; this API returns the phone ringer volume. To get other system volume values, use the getCurrentVolumeByMode API.

Parameters

PropertyTypeRequiredDescription
complete() => voidNoCompletion callback (executed on both success and failure)
success(params: Object) => voidNoCallback on successful API call
fail(params: Object) => voidNoFailure callback
success callback parameters
PropertyTypeDescriptionBaseKit Since
valuenumberVolume, range [0 - 1]v3.2.6
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

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

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