跳到主要内容
版本:v5

@capacitor/motion

Motion API 跟踪加速度计和设备方向(指南针方位等)。

安装

npm install @capacitor/motion@latest-5
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
AccelListener

返回:

Promise<PluginListenerHandle> & PluginListenerHandle

自从: 1.0.0


addListener('orientation', ...)

addListener(eventName: 'orientation', listenerFunc: OrientationListener) => Promise<PluginListenerHandle> & PluginListenerHandle

为设备方向变化(指南针方位等)添加监听器。

参数类型
eventName'orientation'
listenerFunc
OrientationListener

返回:

Promise<PluginListenerHandle> & PluginListenerHandle

自从: 1.0.0


removeAllListeners()

removeAllListeners() => Promise<void>

移除附加到此插件的所有监听器。

自从: 1.0.0


接口

PluginListenerHandle

属性类型
remove() => Promise<void>

AccelListenerEvent

属性类型描述自从
acceleration
Acceleration
一个对象,给出设备在 X、Y 和 Z 三个轴上的加速度。Acceleration 以 m/s 为单位表示。1.0.0
accelerationIncludingGravity
Acceleration
一个对象,给出设备在 X、Y 和 Z 三个轴上的加速度,包含重力影响。Acceleration 以 m/s 为单位表示。1.0.0
rotationRate
RotationRate
一个对象,给出设备在三个方向轴 alpha、beta 和 gamma 上的方向变化率。旋转率以度/秒为单位表示。1.0.0
intervalnumber一个数字,表示从设备获取数据的时间间隔(毫秒)。1.0.0

Acceleration

属性类型描述自从
xnumber沿 X 轴的加速度量。1.0.0
ynumber沿 Y 轴的加速度量。1.0.0
znumber沿 Z 轴的加速度量。1.0.0

RotationRate

属性类型描述自从
alphanumber绕 Z 轴的旋转量,以度/秒为单位。1.0.0
betanumber绕 X 轴的旋转量,以度/秒为单位。1.0.0
gammanumber绕 Y 轴的旋转量,以度/秒为单位。1.0.0

类型别名

AccelListener

(event: AccelListenerEvent): void

OrientationListener

(event: RotationRate): void

OrientationListenerEvent

RotationRate