开发
API

tt.getSystemInfo

基础库 1.0.0 开始支持本方法。

获取系统信息。

语法

tt.getSystemInfo(options)

参数说明

options 为 object 类型,属性如下:

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

回调成功

object 类型,属性如下:

属性名类型说明示例最低支持版本
systemstring操作系统版本"11.4" "8.0.0"1.0.0
platformstring操作系统类型"ios" "android"1.0.0
brandstring手机品牌"Apple" "Xiaomi"1.0.0
modelstring手机型号1.0.0
versionstring宿主 App 版本号(宿主指今日头条、抖音等)6.7.81.0.0
appNamestring宿主 APP 名称"Toutiao" "Douyin"1.0.0
SDKVersionstring客户端基础库版本"1.0.0"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
safeAreaobject在竖屏正方向下的安全区域1.51.0

safeArea 的属性如下:

属性类型说明最低支持版本
leftnumber安全区域左上角横坐标1.0.0
rightnumber安全区域右下角横坐标1.0.0
topnumber安全区域左上角纵坐标1.0.0
bottomnumber安全区域右下角纵坐标1.0.0
widthnumber安全区域的宽度,单位逻辑像素1.0.0
heightnumber安全区域的高度,单位逻辑像素1.0.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(res);
  },
  fail(res) {
    console.log(`getSystemInfo 调用失败`);
  },
});

Bug & Tip

  • Tip:无
点击纠错
评价此篇文档