tt.getSystemInfo
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
获取系统信息。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 通过 getSystemInfoSync 和 getSystemInfo 获取到的所有宽高单位均为设备的逻辑分辨率，设备的物理分辨率为逻辑分辨率*设备像素比。 |
| 相关教程 | 无 |
语法
tt.getSystemInfo(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| system | string | 操作系统版本。示例："11.4", "8.0.0" | 1.0.0 |
| platform | string | 操作系统类型。示例："ios", "android" | 1.0.0 |
| brand | string | 手机品牌。示例："Apple", "Xiaomi" | 1.0.0 |
| model | string | 手机型号 | 1.0.0 |
| version | string | 宿主 App 版本号（宿主指今日头条、抖音等）。示例："6.7.8" | 1.0.0 |
| appName | string | 宿主 APP 名称。示例："Toutiao" | 1.0.0 |
| SDKVersion | string | 客户端基础库版本。示例："1.0.0" | 1.0.0 |
| screenWidth | number | 屏幕宽度 | 1.0.0 |
| screenHeight | number | 屏幕高度 | 1.0.0 |
| windowWidth | number | 可使用窗口宽度 | 1.0.0 |
| windowHeight | number | 可使用窗口高度 | 1.0.0 |
| safeArea | object | 在竖屏正方向下的安全区域。安全区域指的是一个可视窗口范围，处于安全区域的内容不受圆角（corners）、齐刘海（sensor housing）、小黑条（Home Indicator）影响。 | 1.51.0 |
| pixelRatio | number | 设备像素比 | 1.0.0 |
| deviceScore | object | 机型性能评分。分数越高说明设备越好，其中(0, 7.30)为低端机，[7.30, 8.51)为中端机，[8.51, +∞)为高端机。如果获取不到对应分数，返回-1。 | 1.79.0 |
| errMsg | string | "getSystemInfo:ok" | 1.0.0 |
| deviceOrientation | string | 设备方向 | 3.66.0 |
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 |
novel_fm | string | 番茄畅听 | 1.0.0 |
novelapp | string | 番茄小说 | 1.0.0 |
deviceOrientation 参数说明
返回值 | 类型 | 说明 | 最低支持版本 |
portrait | string | 竖屏 | 3.66.0 |
landscape | string | 横屏 | 3.66.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 |
deviceScore 类型说明
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| cpu | number | cpu 分数 | 1.79.0 |
| gpu | number | gpu 分数 | 1.79.0 |
| memory | number | 内存分数 | 1.79.0 |
| overall | number | 综合评分 | 1.79.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "getSystemInfo:fail " + 详细错误信息 | 1.0.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 20000 | internal error | 小游戏框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 20001 | invalid param | 参数错误 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.getSystemInfo({ success(res) { console.log(res); }, fail(res) { console.log(`getSystemInfo 调用失败`); }, });
