抖音开放平台Logo
控制台

tt.startCompass
收藏
我的收藏

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

开始监听罗盘数据。罗盘数据会在用户手机发生“朝向变化/加速前进&后退/摇一摇”等手势时触发变化。

前提条件无
业务背景无
使用限制无
注意事项无
支持沙盒
否
相关教程无

语法

tt.startCompass(options)

参数说明

options 为 object 类型，属性如下：

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

回调成功

object 类型，属性如下：

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

回调失败

object 类型，属性如下：

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

错误码

errNoerrMsg说明最低支持版本
10201"startCompass:fail privacy permission is not authorized"

用户拒绝隐私协议授权，详见小程序隐私协议开发指南

3.19.0
10202"startCompass:fail api scope is not declared in the privacy agreement"

隐私协议中未定义相关隐私信息类型，详见配置隐私协议

3.19.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

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