tt.compressImage
收藏我的收藏
收藏基础库 1.28.0 开始支持本方法，这是一个异步方法。
压缩图片接口，可选压缩质量，并可以产出压缩后的图片到本地临时文件。仅对 jpg 格式图片有效。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 无 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.compressImage(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| quality | number | 80 | 否 | 压缩质量，范围 0 ~ 100，数值越小，质量越低，压缩率越高 | 1.28.0 |
| src | string | array | 是 | 图片路径 | 1.28.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.28.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.28.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会 执行） | 1.28.0 |
src 参数说明
src 可以是本地路径、代码包相对路径，但不支持网络图片。基础库 2.48.0 版本之后，支持传入路径数组，批量压缩图片。当批量压缩时：
- 如果批量压缩全部失败，会进入 fail 回调。
- 如果批量压缩部分压缩成功、部分压缩失败，则会进入 success 回调，压缩失败的图片返回空字符串。
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "compressImage:ok" | 1.28.0 |
| tempFilePath | string | array | 压缩完成后的文件的临时路径 | 1.28.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "compressImage:fail" + 详细错误信息 | 1.28.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 112102 | compressImage:fail decode image fail | D | 传入非图片 检查传入的资源路径是否为图片资源 | 1.28.0 |
| 112101 | compressImage:fail no such file or directory ${src} | D | 文件或目录不存在 检查路径 | 1.28.0 |
| 112199 | compressImage:fail params src is required | D | src为空 检查src参数 | 1.28.0 |
| 112199 | compressImage:fail params.src should be string, but got xxx or params.src should be array, but got xxx | D | 入参错误 检查入参 | 1.28.0 |
| 112199 | compressImage:fail src is invalid | D | src类型错误 检查src参数 | 1.28.0 |
| 112104 | compressImage:fail batch compress images fail | F | 小程序框架内部错误，有需要请创建工单 咨询 | 1.28.0 |
| 112103 | compressImage:fail permission denied, read xxx | D | 无权限错误 请传入ttfile://temp或ttfile://user路径 | 1.28.0 |
| 112106 | compressImage:fail compress image fail | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.28.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
<!-- index.ttml --> <view class="wrap"> <button type="primary" bindtap="compressImage">点击选择图片压缩</button> <view>压缩前：</view> <image class="image" src="{{oldSrc}}"></image> <view>压缩后：</view> <image class="image" src="{{newSrc}}"></image> </view>
// index.js Page({ data: { oldSrc: "", newSrc: "", }, compressImage() { tt.chooseImage({ success: (res) => { this.setData({ oldSrc: res.tempFilePaths[0], }); tt.compressImage({ src: res.tempFilePaths[0], quality: 80, success: (res) => { tt.showToast({ title: "压缩成功" }); this.setData({ newSrc: res.tempFilePath, }); }, fail: (err) => { tt.showModal({ title: "压缩失败", content: err.errMsg, showCancel: false, }); }, complete: (res) => { console.log("压缩完成"); }, }); }, fail: (err) => { tt.showModal({ title: "选择图片失败", content: err.errMsg, showCancel: false, }); }, }); }, });
