For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/basic/system/getSystemInfoSync.md.

getSystemInfoSync

同步获取系统信息。

支持版本

前端库版本不低于 0.0.34。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

调用方式

同步 API

getSystemInfoSync(_params?: object): GetSystemInfoResult

入参

无。

调用示例

import { getSystemInfoSync } from '@doubao-dev/framework/api';

const result = getSystemInfoSync();

console.log(result.brand, result.model, result.system);
console.log(result.screenWidth, result.screenHeight);

返回值

名称类型必返说明
abistring否豆包客户端二进制接口类型(如 arm64-v8a),仅 Android 返回
benchmarkLevelnumber否设备性能等级,-1 表示未知
brandstring是设备品牌
deviceOrientation"portrait" | "landscape"否设备方向
enableDebugboolean否是否已打开调试
languagestring是系统语言,格式为 language_region,如 zh_CN、en_US
modelstring是设备型号
pixelRationumber是设备像素比,物理像素 = 逻辑像素 × pixelRatio
platformstring是客户端平台,取值为 "ios" 或 "android"
safeAreaSystemInfoSafeArea否在竖屏正方向下的安全区域,单位为逻辑像素
safeArea.bottomnumber否安全区域右下角纵坐标
safeArea.heightnumber否安全区域高度
safeArea.leftnumber否安全区域左上角横坐标
safeArea.rightnumber否安全区域右下角横坐标
safeArea.topnumber否安全区域左上角纵坐标
safeArea.widthnumber否安全区域宽度
screenHeightnumber是屏幕高度,单位为逻辑像素
screenWidthnumber是屏幕宽度,单位为逻辑像素
SDKVersionstring否客户端基础库版本
statusBarHeightnumber是状态栏高度,单位为逻辑像素
systemstring是操作系统及版本,如 "Android 14"、"iOS 17.5"
theme"light" | "dark"否系统当前主题
versionstring否豆包客户端版本号
windowHeightnumber是可使用窗口高度,单位为逻辑像素
windowWidthnumber是可使用窗口宽度,单位为逻辑像素

返回示例

{
  "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"
}

错误处理

同步调用失败时抛出错误。错误对象和通用错误码见 通用错误处理。

错误码

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android

平台差异

  • Android:abi 返回豆包客户端二进制接口类型(如 arm64-v8a),iOS 不返回该字段