原生小程序开发设备 API —— 罗盘 API 汇总

罗盘 API

ty.startCompass

开始监听罗盘数据

需引入BaseKit，且在>=2.3.2版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 开始监听罗盘数据
 */
export function startCompass(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.stopCompass

停止监听罗盘数据

需引入BaseKit，且在>=2.3.2版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 停止监听罗盘数据
 */
export function stopCompass(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。  

ty.onCompassChange

监听罗盘数据变化事件

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

监听罗盘数据变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
direction	number		是	面对的方向度数
accuracy	string		是	精度 high 高精度 medium 中等精度 low 低精度 no-contact 不可信，传感器失去连接 unreliable 不可信，原因未知 unknow ${value} 未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值

函数定义示例

/**
 * 监听罗盘数据变化事件
 */
export function onCompassChange(
  listener: (params: {
    /** 面对的方向度数 */
    direction: number;
    /**
     * 精度
     * high 高精度
     * medium    中等精度
     * low    低精度
     * no-contact    不可信，传感器失去连接
     * unreliable    不可信，原因未知
     * unknow ${value}    未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值
     */
    accuracy: string;
  }) => void,
): void;

ty.offCompassChange

取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
direction	number		是	面对的方向度数
accuracy	string		是	精度 high 高精度 medium 中等精度 low 低精度 no-contact 不可信，传感器失去连接 unreliable 不可信，原因未知 unknow ${value} 未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值

函数定义示例

/**
 * 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听
 */
export function offCompassChange(
  listener: (params: {
    /** 面对的方向度数 */
    direction: number;
    /**
     * 精度
     * high 高精度
     * medium    中等精度
     * low    低精度
     * no-contact    不可信，传感器失去连接
     * unreliable    不可信，原因未知
     * unknow ${value}    未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值
     */
    accuracy: string;
  }) => void,
): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。