@capacitor/motion
Motion API 用于跟踪加速度计和设备方向(罗盘航向等)
安装
npm install @capacitor/motion
npx cap sync
权限
此插件目前使用 Web API 实现。大多数浏览器在使用此 API 前需要获取权限。要请求权限,请在用户发起的任何操作(例如按钮点击)时提示用户:
import { PluginListenerHandle } from '@capacitor/core';
import { Motion } from '@capacitor/motion';
let accelHandler: PluginListenerHandle;
myButton.addEventListener('click', async () => {
try {
await DeviceMotionEvent.requestPermission();
} catch (e) {
// 处理错误
return;
}
// 用户批准后,可以开始监听:
accelHandler = await Motion.addListener('accel', event => {
console.log('设备运动事件:', event);
});
});
// 停止加速度监听
const stopAcceleration = () => {
if (accelHandler) {
accelHandler.remove();
}
};
// 移除所有监听器
const removeListeners = () => {
Motion.removeAllListeners();
};
请参阅 DeviceMotionEvent API 来理解 'accel' 事件中提供的数据。
API
addListener('accel', ...)
addListener(eventName: 'accel', listenerFunc: AccelListener) => Promise<PluginListenerHandle> & PluginListenerHandle
添加加速度计数据监听器
| 参数 | 类型 |
|---|---|
eventName | 'accel' |
listenerFunc | |
返回值:
Promise<PluginListenerHandle> & PluginListenerHandle
自: 1.0.0
addListener('orientation', ...)
addListener(eventName: 'orientation', listenerFunc: OrientationListener) => Promise<PluginListenerHandle> & PluginListenerHandle
添加设备方向变化监听器(罗盘航向等)
| 参数 | 类型 |
|---|---|
eventName | 'orientation' |
listenerFunc | |
返回值:
Promise<PluginListenerHandle> & PluginListenerHandle
自: 1.0.0
removeAllListeners()
removeAllListeners() => Promise<void>
移除附加到此插件的所有监听器。
自: 1.0.0
接口
PluginListenerHandle
| 属性 | 类型 |
|---|---|
remove | () => Promise<void> |
AccelListenerEvent
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
acceleration | | 提供设备在 X、Y、Z 三个轴上的加速度的对象。Acceleration 以 m/s 为单位表示。 | 1.0.0 |
accelerationIncludingGravity | | 提供设备在 X、Y、Z 三个轴上包含重力影响的加速度的对象。Acceleration 以 m/s 为单位表示。 | 1.0.0 |
rotationRate | | 提供设备在 alpha、beta 和 gamma 三个方向轴上方向变化速率的对象。旋转速率以度/秒为单位表示。 | 1.0.0 |
interval | number | 一个数字,表示从设备获取数据的间隔时间,以毫秒为单位。 | 1.0.0 |
Acceleration
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
x | number | 沿 X 轴的加速度大小。 | 1.0.0 |
y | number | 沿 Y 轴的加速度大 小。 | 1.0.0 |
z | number | 沿 Z 轴的加速度大小。 | 1.0.0 |
RotationRate
| 属性 | 类型 | 描述 | 自 |
|---|---|---|---|
alpha | number | 围绕 Z 轴的旋转量,以度/秒为单位。 | 1.0.0 |
beta | number | 围绕 X 轴的旋转量,以度/秒为单位。 | 1.0.0 |
gamma | number | 围绕 Y 轴的旋转量,以度/秒为单位。 | 1.0.0 |
类型别名
AccelListener
(event: AccelListenerEvent): void
OrientationListener
(event: RotationRate): void
OrientationListenerEvent
RotationRate