接口 YmxDeviceCompass

罗盘（方向传感器）

interface YmxDeviceCompass {
    isSupportCompass(): Promise<boolean>;
    offCompassChange(listener?: Function): Promise<void>;
    onCompassChange(listener: (res: CompassResult) => void): Promise<void>;
    startCompass(data: CompassData): Promise<void>;
    stopCompass(): Promise<void>;
}

层级 (查看层级一览)

YmxDeviceCompass
- YmxDevice

索引

方法

isSupportCompass offCompassChange onCompassChange startCompass stopCompass

方法

isSupportCompass

isSupportCompass(): Promise<boolean>
检测设备是否支持罗盘

返回 Promise<boolean>
示例
```
const isSupport = await ymx.isSupportCompass();
alert(isSupport ? '支持' : '不支持');
```
- 定义于 core.d.ts:2424

offCompassChange

offCompassChange(listener?: Function): Promise<void>
移除罗盘数据事件的监听函数，不传 listener 则移除所有监听函数
参数
- 可选listener: Function
返回 Promise<void>
示例
```
//移除全部罗盘监听器
await ymx.offCompassChange();
```
- 定义于 core.d.ts:2470

onCompassChange

onCompassChange(listener: (res: CompassResult) => void): Promise<void>
监听罗盘数据事件
参数
- listener: (res: CompassResult) => void
返回 Promise<void>
示例
```
await ymx.onCompassChange((res) => {
  console.log(`Compass x:${res.x}, y:${res.y}, z:${res.z}`);
});
```
- 定义于 core.d.ts:2459

startCompass

startCompass(data: CompassData): Promise<void>
开始监听罗盘数据
参数
- data: CompassData
返回 Promise<void>
示例
```
await ymx.startCompass({
  interval: 200
});
```
- 定义于 core.d.ts:2436

stopCompass

stopCompass(): Promise<void>
停止监听罗盘数据

返回 Promise<void>
示例
```
await ymx.stopCompass();
```
- 定义于 core.d.ts:2445