#getSystemInfo
获取系统信息。
#扫码预览
#支持版本
前端库版本不低于 0.0.34。
#支持平台
| 平台 | 支持情况 |
|---|---|
| Android | 支持 |
| iOS | 支持 |
| PC | 不支持 |
| HarmonyOS | 不支持 |
#支持场景
| 场景 | 支持情况 |
|---|---|
| 页面 | 支持 |
| 卡片 | 支持 |
#调用方式
#异步 API
getSystemInfo(params?: object): Promise<GetSystemInfoResult>#入参
无。
#调用示例
import { getSystemInfo } from '@doubao-dev/framework/api';
const result = await getSystemInfo();
console.log(result.brand, result.model, result.system);
console.log(result.screenWidth, result.screenHeight);#成功返回
| 名称 | 类型 | 必返 | 说明 |
|---|---|---|---|
abi | string | 否 | 豆包客户端二进制接口类型(如 arm64-v8a),仅 Android 返回 |
benchmarkLevel | number | 否 | 设备性能等级,-1 表示未知 |
brand | string | 是 | 设备品牌 |
deviceOrientation | "portrait" | "landscape" | 否 | 设备方向 |
enableDebug | boolean | 否 | 是否已打开调试 |
language | string | 是 | 系统语言,格式为 language_region,如 zh_CN、en_US |
model | string | 是 | 设备型号 |
pixelRatio | number | 是 | 设备像素比,物理像素 = 逻辑像素 × pixelRatio |
platform | string | 是 | 客户端平台,取值为 "ios" 或 "android" |
safeArea | SystemInfoSafeArea | 否 | 在竖屏正方向下的安全区域,单位为逻辑像素 |
safeArea.bottom | number | 否 | 安全区域右下角纵坐标 |
safeArea.height | number | 否 | 安全区域高度 |
safeArea.left | number | 否 | 安全区域左上角横坐标 |
safeArea.right | number | 否 | 安全区域右下角横坐标 |
safeArea.top | number | 否 | 安全区域左上角纵坐标 |
safeArea.width | number | 否 | 安全区域宽度 |
screenHeight | number | 是 | 屏幕高度,单位为逻辑像素 |
screenWidth | number | 是 | 屏幕宽度,单位为逻辑像素 |
SDKVersion | string | 否 | 客户端基础库版本 |
statusBarHeight | number | 是 | 状态栏高度,单位为逻辑像素 |
system | string | 是 | 操作系统及版本,如 "Android 14"、"iOS 17.5" |
theme | "light" | "dark" | 否 | 系统当前主题 |
version | string | 否 | 豆包客户端版本号 |
windowHeight | number | 是 | 可使用窗口高度,单位为逻辑像素 |
windowWidth | number | 是 | 可使用窗口宽度,单位为逻辑像素 |
#返回示例
{
"brand": "Xiaomi",
"model": "23127PN0CC",
"pixelRatio": 3,
"screenWidth": 393,
"screenHeight": 852,
"windowWidth": 393,
"windowHeight": 852,
"statusBarHeight": 59,
"language": "zh_CN",
"version": "8.0.0",
"system": "Android 14",
"platform": "android",
"SDKVersion": "0.0.36",
"theme": "light",
"benchmarkLevel": 30,
"safeArea": {
"left": 0,
"right": 393,
"top": 59,
"bottom": 818,
"width": 393,
"height": 759
},
"enableDebug": false,
"deviceOrientation": "portrait",
"abi": "arm64-v8a"
}#错误处理
错误对象和通用错误码见 通用错误处理。
#错误码
#通用错误码
| errNo | errMsg | 说明 | 平台 |
|---|---|---|---|
102 | internal error | 内部错误 | Android |
#平台差异
- Android:abi 返回豆包客户端二进制接口类型(如 arm64-v8a),iOS 不返回该字段