抖音开放平台Logo
控制台

tt.getSystemInfo

更新时间 2024-09-04 07:16:03
收藏
我的收藏

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

获取系统信息。如果在页面渲染时，需要通过调用 API 获取到的信息来设置节点宽高，建议在 Page.onReady 或者更后的时机调用，调用过早可能出现获取的宽高信息不准确。

前提条件无
业务背景无
使用限制无
注意事项
  • Tip：暂不支持获取deviceId(设备唯一标识)；
  • Tip：建议未使用到 windowWidth、windowHeight、battery、screenRatio 参数时，传入 useCache 参数为 true，可提升该 API 的响应速度；
  • Tip：建议在使用 windowWidth、windowHeight、battery、screenRatio 参数时，调用同步 API tt.getSystemInfoSync，异步 API tt.getSystemInfo 的返回值可能因时序原因造成值不准确。
支持沙盒
否
相关教程无

语法

tt.getSystemInfo(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
useCachebooleanfalse否

是否使用缓存中的系统信息（默认不使用）

2.67.0
successfunction否
接口调用成功的回调函数
1.0.0
failfunction否
接口调用失败的回调函数
1.0.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
1.0.0

useCache 参数说明

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

属性名

类型

说明

原因

最低支持版本

windowWidth

string

可使用窗口宽度

在 X 分屏场景下可使用窗口宽度可能为正常高度

1.0.0

windowHeight

string

可使用窗口高度

在 X 分屏场景下可使用窗口高度可能为正常高度

1.0.0

battery

number

电池电量

电池电量实时变化使用缓存值电池电量可能会不准确

2.53.0

screenRatio

number

分屏参数

分屏状态下，分屏比例会随拖动改变，使用缓存值分屏参数会不准确。

2.75.0

回调成功

object 类型，属性如下：

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

在竖屏正方向下的安全区域，详情见 SafeArea 类型说明

1.51.0
brandstring

手机品牌

1.0.0
modelstring

手机型号

1.0.0
pixelRationumber

设备像素比

1.0.0
platformstring

操作系统类型，详情见 操作系统说明

1.0.0
systemstring
操作系统版本
1.0.0
statusBarHeightnumber

状态栏的高度，单位 px

1.0.0
screenWidthnumber

屏幕宽度

1.0.0
screenHeightnumber

屏幕高度

1.0.0
fontSizeSettingnumber

字体大小

2.53.0
appNamestring

宿主 APP 名称，详情见 appName 说明

1.0.0
versionstring

宿主 App 版本号（宿主指今日头条、抖音等）

1.0.0
SDKVersionstring

客户端基础库版本

1.0.0
windowWidthnumber

可使用窗口宽度

1.0.0
windowHeightnumber

可使用窗口高度

1.0.0
batterynumber

电池电量

2.53.0
languagestring

系统语言

2.53.0
screenRationumber

分屏参数，即 X 分屏状态下，分屏占全屏幕的比例

2.75.0

safeArea 参数说明

object 类型，属性如下：

属性名

类型

说明

最低支持版本

left

number

安全区域左上角横坐标

1.51.0

right

number

安全区域右下角横坐标

1.51.0

top

number

安全区域左上角纵坐标

1.51.0

bottom

number

安全区域右下角纵坐标

1.51.0

width

number

安全区域的宽度，单位逻辑像素

1.51.0

height

number

安全区域的高度，单位逻辑像素

1.51.0

platform 参数说明

返回值如下：

返回值

说明

ios

iOS系统

Android

Android系统

devtools

开发者工具

appName 参数说明

返回值

类型

说明

最低支持版本

Toutiao

string

今日头条

1.0.0

Douyin

string

抖音（国内版)

1.0.0

news_article_lite

string

今日头条（极速版)

1.0.0

douyin_lite

string

抖音（极速版）

1.0.0

aweme_hotsoon

string

抖音火山版

1.0.0

XiGua

string

西瓜

1.0.0

PPX

string

皮皮虾

1.0.0

回调失败

object 类型，属性如下：

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

扫码体验

请使用字节宿主APP扫码

代码示例