抖音开放平台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

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.startCompass({
  success(res) {
    //调用成功 startCompass:ok
    console.log("调用成功", res);
  },
  fail(err) {
    // 调用失败 startCompass:fail
    tt.showModal({
      title: "调用失败",
      content: JSON.stringfy(err),
    });
  },
});