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

# compressImage

压缩图片。

## 扫码预览

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

## 支持版本

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

## 支持平台

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

## 接入准备

### 前置条件

- src 指向豆包应用插件可访问、存在且可解码的本地图片

## 调用方式

### 异步 API

```typescript
compressImage(params: CompressImageParams): Promise<CompressImageResult>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>compressedHeight</code></td><td><code>number</code></td><td>否</td><td><code>-</code></td><td>正数，且与 compressedWidth 同时传入</td><td>输出图片高度，单位 px。仅在 `compressedWidth` 同时为正数时调整尺寸。</td></tr>
<tr><td><code>compressedWidth</code></td><td><code>number</code></td><td>否</td><td><code>-</code></td><td>正数，且与 compressedHeight 同时传入</td><td>输出图片宽度，单位 px。仅在 `compressedHeight` 同时为正数时调整尺寸。</td></tr>
<tr><td><code>quality</code></td><td><code>number</code></td><td>否</td><td><code>80</code></td><td>0 至 100</td><td>JPEG 输出质量。</td></tr>
<tr><td><code>src</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>图片路径。</td></tr>
</tbody>
</table>

## 调用示例

```typescript
import { compressImage } from '@doubao-dev/framework/api';

const { tempFilePath } = await compressImage({
  src: '/tmp/image.png',
  quality: 80
});

console.log(tempFilePath);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>tempFilePath</code></td><td><code>string</code></td><td>是</td><td>压缩后 JPEG 图片的临时文件路径。</td></tr>
</tbody>
</table>

### 返回示例

```json
{
  "tempFilePath": "appletfile://temp/compressed-example.jpg"
}
```

## 错误处理

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

### 失败示例

```json
{
  "errNo": 104,
  "errMsg": "src cannot be empty"
}
```

### 错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
</thead>
<tbody>
<tr><td><code>104</code></td><td><code>src cannot be empty</code></td><td>Android</td><td>src 为空字符串</td><td>传入非空的本地图片路径。</td></tr>
<tr><td><code>104</code></td><td><code>src must not be empty</code></td><td>iOS</td><td>src 为空字符串</td><td>传入非空的本地图片路径。</td></tr>
<tr><td><code>203</code></td><td><code>source file does not exist</code></td><td>Android</td><td>本地源图片文件不存在</td><td>检查路径仍在有效期内并重新获取文件。</td></tr>
</tbody>
</table>
