开发
API
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

tt.getSystemInfo

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

获取系统信息。

语法

tt.getSystemInfo(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
useCachebooleanfalse是否使用缓存中的系统信息(默认不使用)2.67.0
successfunction接口调用成功后的回调函数1.0.0
failfunction接口调用失败后的回调函数1.0.0
completefunction接口调用结束后的回调函数(调用成功、失败都会执行)1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
systemstring操作系统版本1.0.0
platformstring操作系统类型1.0.0
brandstring手机品牌1.0.0
modelstring手机型号1.0.0
versionstring宿主 App 版本号(宿主指今日头条、抖音等)1.0.0
appNamestring宿主 APP 名称,详情见 appName 说明1.0.0
SDKVersionstring客户端基础库版本1.0.0
screenWidthnumber屏幕宽度1.0.0
screenHeightnumber屏幕高度1.0.0
windowWidthnumber可使用窗口宽度1.0.0
windowHeightnumber可使用窗口高度1.0.0
pixelRationumber设备像素比1.0.0
statusBarHeightnumber状态栏的高度,单位 px1.0.0
safeAreaSafeArea在竖屏正方向下的安全区域,详情见 SafeArea 类型说明1.51.0
batterynumber电池电量2.53.0
fontSizeSettingstring字体大小2.53.0
languagestring系统语言2.53.0
errMsgstring"getSystemInfo:ok"1.0.0

useCache 为 true 时,以下字段可能不准确需要特别注意:

属性名类型说明原因最低支持版本
windowWidthstring可使用窗口宽度在 X 分屏场景下可使用窗口宽度可能为正常高度1.0.0
windowHeightstring可使用窗口高度在 X 分屏场景下可使用窗口高度可能为正常高度1.0.0
batterynumber电池电量电池电量实时变化使用缓存值电池电量可能会不准确2.53.0

SafeArea 类型说明

object 类型,属性如下:

属性名类型说明最低支持版本
leftnumber安全区域左上角横坐标1.51.0
rightnumber安全区域右下角横坐标1.51.0
topnumber安全区域左上角纵坐标1.51.0
bottomnumber安全区域右下角纵坐标1.51.0
widthnumber安全区域的宽度,单位逻辑像素1.51.0
heightnumber安全区域的高度,单位逻辑像素1.51.0

appName 说明

返回值如下:

返回值类型说明最低支持版本
Toutiaostring今日头条1.0.0
Douyinstring抖音(国内版)1.0.0
news_article_litestring今日头条(极速版)1.0.0
live_streamstring火山小视频1.0.0
XiGuastring西瓜1.0.0
PPXstring皮皮虾1.0.0

回调失败

object 类型,属性如下:

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

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.getSystemInfo({
  success(res) {
    console.log("getSystemInfo 调用成功", res);
  },
  fail(res) {
    console.log("getSystemInfo 调用失败", res);
  },
});
tt.getSystemInfo({
  useCache: true,
  success(res) {
    console.log("getSystemInfo 调用成功", res);
  },
  fail(res) {
    console.log("getSystemInfo 调用失败", res);
  },
});

Bug & Tip

  • Tip:暂不支持获取deviceId(设备唯一标识);
  • Tip:建议未使用到 windowWidth、windowHeight、battery 参数时,传入 useCache 参数为 true,可提升该 API 的响应速度。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助