updateVolume(params: Object)

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

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

Description

Set system volume

Parameters

PropertyTypeRequiredDefaultDescriptionBaseKit Since
valuenumberYes-Volume, range [0 - 1]-
volumeModenumber[]No[2]Volume type (Android only) 0: Voice call volume 1: System volume 2: Ringtone, notifications, system default sounds, etc. 3: Media volume 4: Alarm volume 5: Notification volume 6: Bluetooth volumev3.3.3
complete() => voidNo-Completion callback (executed on both success and failure)-
success() => voidNo-Callback on successful API call-
fail(params: Object) => voidNo-Failure callback-
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

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

updateVolume({
  value: 0.5,
  volumeMode: [2],
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});