compressImage
压缩图片。
扫码预览
支持版本
前端库版本不低于 0.0.26。
支持平台
支持场景
接入准备
前置条件
- src 指向豆包应用插件可访问、存在且可解码的本地图片
调用方式
异步 API
入参
调用示例
成功返回
返回示例
错误处理
错误对象和通用错误码见 通用错误处理。
压缩图片。
前端库版本不低于 0.0.26。
| 平台 | 支持情况 |
|---|---|
| Android | 支持 |
| iOS | 支持 |
| PC | 不支持 |
| HarmonyOS | 不支持 |
| 场景 | 支持情况 |
|---|---|
| 页面 | 支持 |
| 卡片 | 不支持 |
compressImage(params: CompressImageParams): Promise<CompressImageResult>| 名称 | 类型 | 必填 | 默认值 | 约束 | 说明 |
|---|---|---|---|---|---|
compressedHeight | number | 否 | - | 正数,且与 compressedWidth 同时传入 | 输出图片高度,单位 px。仅在 `compressedWidth` 同时为正数时调整尺寸。 |
compressedWidth | number | 否 | - | 正数,且与 compressedHeight 同时传入 | 输出图片宽度,单位 px。仅在 `compressedHeight` 同时为正数时调整尺寸。 |
quality | number | 否 | 80 | 0 至 100 | JPEG 输出质量。 |
src | string | 是 | - | - | 图片路径。 |
import { compressImage } from '@doubao-dev/framework/api';
const { tempFilePath } = await compressImage({
src: '/tmp/image.png',
quality: 80
});
console.log(tempFilePath);| 名称 | 类型 | 必返 | 说明 |
|---|---|---|---|
tempFilePath | string | 是 | 压缩后 JPEG 图片的临时文件路径。 |
{
"tempFilePath": "appletfile://temp/compressed-example.jpg"
}错误对象和通用错误码见 通用错误处理。
{
"errNo": 104,
"errMsg": "src cannot be empty"
}| errNo | errMsg | 平台 | 触发条件 | 处理建议 |
|---|---|---|---|---|
104 | src cannot be empty | Android | src 为空字符串 | 传入非空的本地图片路径。 |
104 | src must not be empty | iOS | src 为空字符串 | 传入非空的本地图片路径。 |
203 | source file does not exist | Android | 本地源图片文件不存在 | 检查路径仍在有效期内并重新获取文件。 |