抖音开放平台Logo
开发者文档
控制台

tt.getLocation
收藏
我的收藏

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

获取设备当前的地理位置。

前提条件

该 API 需要用户授权方可调用,详细信息可参考用户授权。位置精度和调用耗时会因设备而异。

业务背景
使用限制
注意事项
  • 该 API 有一定性能消耗,请注意不要频繁调用以防设备过热和耗电过快。小游戏框架也会做相应的节流处理。
  • 如果要将返回值使用在 openLocation 中,必须指定坐标系为 "gcj02"
相关教程

语法

tt.getLocation(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
typestring"wgs84"

指定坐标系类型,可以是 "wgs84" 或 "gcj02"

1.0.0
successfunction
接口调用成功的回调函数
1.0.0
failfunction
接口调用失败的回调函数
1.0.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"getLocation:ok"
1.0.0
altitudenumber

高度,单位 m

1.0.0
accuracynumber

位置的精确度,反应与真实位置之间的接近程度,可以理解成10即与真实位置相差10m,越小越精确

1.0.0
verticalAccuracynumber

垂直精度,单位 m(Android 需要系统 8.0 及以上机型并且开启 GPS,否则返回 0)

1.0.0
horizontalAccuracynumber

水平精度,单位 m

1.0.0
speednumber

速度,单位 m/s

1.0.0
citystring

定位到的城市信息(因整体性能考虑,不开放返回 iOS 端的城市数据,可基于经纬度自行测算)

1.0.0
latitudestring

纬度,范围为-90 ~ 90,正数表示北,负数表示南

1.0.0
longitudestring

经度,范围为-180 ~180,正数表示东,负数表示西

1.0.0

回调失败

object 类型,属性如下:

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

代码示例

开发者工具中预览

tt.getLocation({ success(res) { console.log(`经度${res.longitude},维度${res.latitude}`); }, fail(res) { console.log(`getLocation调用失败`); }, });