startAccelerometer(params: Object)

Requires:
BaseKit≥2.3.2@ray-js/ray≥0.3.23
Platforms:
iOSAndroid
import { startAccelerometer } from '@ray-js/ray';

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

Description

Start listening to accelerometer data and initialize the event callback

Parameters

PropertyTypeRequiredDefaultDescription
interval"game" | "ui" | "normal"No'normal'Frequency of the accelerometer data callback
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

Valid Values

interval
ValueDescriptionBaseKit Since
gameCallback frequency for game updates, about 20 ms per callback-
uiCallback frequency for UI updates, about 60 ms per callback-
normalNormal callback frequency, about 200 ms per callback-

Examples

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

await startAccelerometer({ interval: "normal" });
console.log("startAccelerometer success");