- JS API 列表
- 基础
- 网络
- 媒体
- 地图
- 文件
- 开放接口
- 数据缓存
- 地理位置
- 设备
- 画布
- 界面
- 页面导航
- 侧边栏能力
- 行业开放
- AI/AR能力
- 第三方平台
- TTML
- 转发和挂载
- 其它
- 直播能力
tt.getSystemInfo
基础库 1.0.0 开始支持本方法,这是一个异步方法。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 |
|
支持沙盒 | 否 |
相关教程 | 无 |
语法
tt.getSystemInfo(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
useCache | boolean | false | 否 | 是否使用缓存中的系统信息(默认不使用) | 2.67.0 |
success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 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 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getSystemInfo:ok" | 1.0.0 |
safeArea | object | 在竖屏正方向下的安全区域,详情见 SafeArea 类型说明 | 1.51.0 |
brand | string | 手机品牌 | 1.0.0 |
model | string | 手机型号 | 1.0.0 |
pixelRatio | number | 设备像素比 | 1.0.0 |
platform | string | 操作系统类型,详情见 操作系统说明 | 1.0.0 |
system | string | 操作系统版本 | 1.0.0 |
statusBarHeight | number | 状态栏的高度,单位 px | 1.0.0 |
screenWidth | number | 屏幕宽度 | 1.0.0 |
screenHeight | number | 屏幕高度 | 1.0.0 |
fontSizeSetting | number | 字体大小 | 2.53.0 |
appName | string | 宿主 APP 名称,详情见 appName 说明 | 1.0.0 |
version | string | 宿主 App 版本号(宿主指今日头条、抖音等) | 1.0.0 |
SDKVersion | string | 客户端基础库版本 | 1.0.0 |
windowWidth | number | 可使用窗口宽度 | 1.0.0 |
windowHeight | number | 可使用窗口高度 | 1.0.0 |
battery | number | 电池电量 | 2.53.0 |
language | string | 系统语言 | 2.53.0 |
screenRatio | number | 分屏参数,即 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 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getSystemInfo:fail" + 详细错误信息 | 1.0.0 |