tt.stopCompass
收藏
我的收藏

基础库 1.2.0 开始支持本方法,这是一个异步方法。

停止监听罗盘数据。

前提条件
业务背景
使用限制
注意事项

调用此接口后,tt.onCompassChange中的回调方法将不再执行。

支持沙盒
相关教程

语法

tt.stopCompass(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successfunction
接口调用成功的回调函数
1.2.0
failfunction
接口调用失败的回调函数
1.2.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.2.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"stopCompass:ok"
1.2.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"stopCompass:fail" + 详细错误信息
1.2.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<button type="default" size="default" bindtap="tapStartCompass">
  开始监听罗盘
</button>
<button type="default" size="default" bindtap="tapStopCompass">
  停止监听罗盘
</button>
Page({
  tapStartCompass() {
    tt.startCompass({
      success(res) {
        //调用开始监听罗盘成功 startCompass:ok
        console.log("调用开始监听罗盘成功", res.errMsg);
      },
      fail(res) {
        // 调用开始监听罗盘失败 startCompass:fail
        console.log("调用开始监听罗盘失败", res);
      },
    });
  },
  tapStopCompass() {
    tt.stopCompass({
      success(res) {
        //调用停止监听罗盘成功 stopCompass:ok
        console.log("调用停止监听罗盘成功", res.errMsg);
      },
      fail(res) {
        // 调用停止监听罗盘失败 stopCompass:fail
        console.log("调用停止监听罗盘失败", res.errMsg);
      },
    });
  },
});