> 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.

# getSystemInfo

获取系统信息。

## 扫码预览

![扫码预览 getSystemInfo](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fget-system-info%252Findex)

## 支持版本

前端库版本不低于 `0.0.34`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>支持</td></tr>
</tbody>
</table>

## 调用方式

### 异步 API

```typescript
getSystemInfo(params?: object): Promise<GetSystemInfoResult>
```

## 入参

无。

## 调用示例

```typescript
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);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>abi</code></td><td><code>string</code></td><td>否</td><td>豆包客户端二进制接口类型（如 arm64-v8a），仅 Android 返回</td></tr>
<tr><td><code>benchmarkLevel</code></td><td><code>number</code></td><td>否</td><td>设备性能等级，-1 表示未知</td></tr>
<tr><td><code>brand</code></td><td><code>string</code></td><td>是</td><td>设备品牌</td></tr>
<tr><td><code>deviceOrientation</code></td><td><code>&quot;portrait&quot; | &quot;landscape&quot;</code></td><td>否</td><td>设备方向</td></tr>
<tr><td><code>enableDebug</code></td><td><code>boolean</code></td><td>否</td><td>是否已打开调试</td></tr>
<tr><td><code>language</code></td><td><code>string</code></td><td>是</td><td>系统语言，格式为 language_region，如 zh_CN、en_US</td></tr>
<tr><td><code>model</code></td><td><code>string</code></td><td>是</td><td>设备型号</td></tr>
<tr><td><code>pixelRatio</code></td><td><code>number</code></td><td>是</td><td>设备像素比，物理像素 = 逻辑像素 × pixelRatio</td></tr>
<tr><td><code>platform</code></td><td><code>string</code></td><td>是</td><td>客户端平台，取值为 &quot;ios&quot; 或 &quot;android&quot;</td></tr>
<tr><td><code>safeArea</code></td><td><code>SystemInfoSafeArea</code></td><td>否</td><td>在竖屏正方向下的安全区域，单位为逻辑像素</td></tr>
<tr><td><code>safeArea.bottom</code></td><td><code>number</code></td><td>否</td><td>安全区域右下角纵坐标</td></tr>
<tr><td><code>safeArea.height</code></td><td><code>number</code></td><td>否</td><td>安全区域高度</td></tr>
<tr><td><code>safeArea.left</code></td><td><code>number</code></td><td>否</td><td>安全区域左上角横坐标</td></tr>
<tr><td><code>safeArea.right</code></td><td><code>number</code></td><td>否</td><td>安全区域右下角横坐标</td></tr>
<tr><td><code>safeArea.top</code></td><td><code>number</code></td><td>否</td><td>安全区域左上角纵坐标</td></tr>
<tr><td><code>safeArea.width</code></td><td><code>number</code></td><td>否</td><td>安全区域宽度</td></tr>
<tr><td><code>screenHeight</code></td><td><code>number</code></td><td>是</td><td>屏幕高度，单位为逻辑像素</td></tr>
<tr><td><code>screenWidth</code></td><td><code>number</code></td><td>是</td><td>屏幕宽度，单位为逻辑像素</td></tr>
<tr><td><code>SDKVersion</code></td><td><code>string</code></td><td>否</td><td>客户端基础库版本</td></tr>
<tr><td><code>statusBarHeight</code></td><td><code>number</code></td><td>是</td><td>状态栏高度，单位为逻辑像素</td></tr>
<tr><td><code>system</code></td><td><code>string</code></td><td>是</td><td>操作系统及版本，如 &quot;Android 14&quot;、&quot;iOS 17.5&quot;</td></tr>
<tr><td><code>theme</code></td><td><code>&quot;light&quot; | &quot;dark&quot;</code></td><td>否</td><td>系统当前主题</td></tr>
<tr><td><code>version</code></td><td><code>string</code></td><td>否</td><td>豆包客户端版本号</td></tr>
<tr><td><code>windowHeight</code></td><td><code>number</code></td><td>是</td><td>可使用窗口高度，单位为逻辑像素</td></tr>
<tr><td><code>windowWidth</code></td><td><code>number</code></td><td>是</td><td>可使用窗口宽度，单位为逻辑像素</td></tr>
</tbody>
</table>

### 返回示例

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

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 错误码

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android</td></tr>
</tbody>
</table>

## 平台差异

- **Android**：abi 返回豆包客户端二进制接口类型（如 arm64-v8a），iOS 不返回该字段
