onCompassChange(listener: Function)

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

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

Description

Listen for compass data change events

Parameters

ParameterTypeRequiredDescription
Yes

Return Value

None

Examples

import { onCompassChange, startCompass } from '@ray-js/ray'

// Listen for compass changes: register onCompassChange first, then startCompass to enable the sensor; heading data will be returned via the callback
onCompassChange(e => {
  console.log("Compass direction:", e.direction, "Accuracy:", e.accuracy);
});
startCompass({
  success: () => console.log("Started listening to compass"),
  fail: error => console.error(error),
});