1.1 接口声明
{"name": "system.media"}
1.2 导入模块
import media from ´@system.media´ 或 var media = require("@system.media")
1.3 media.takePhoto(OBJECT)
拍摄照片。
参数
| 参数 | 类型 | 必填 | 说明 |
| cancel | Function | 否 | 取消回调。 |
| success | Function | 否 | 成功回调,返回值如表1-1所示。 |
| fail | Function | 否 | 失败回调,错误码如表1-2所示。 |
| complete | Function | 否 | 执行结束后的回调。 |
表1-1 success返回值
| 参数名 | 类型 | 说明 |
| uri | String | 选取的文件路径。 |
表1-2 fail返回错误码
| 错误码 | 说明 |
| 201 | 用户拒绝,获取相机权限失败。 |
示例
media.takePhoto({success:function(data){console.log("handling success: " + data.uri);}
})
1.4 media.takeVideo(OBJECT)
拍摄视频。
参数
| 参数 | 类型 | 必填 | 说明 |
| cancel | Function | 否 | 取消回调。 |
| success | Function | 否 | 成功回调,参数为 {uri: ´file:///video.avi´},返回值如表1-3所示。 |
| fail | Function | 否 | 失败回调,错误码如表1-4所示。 |
| complete | Function | 否 | 执行结束后的回调。 |
表1-3 success返回值
| 参数名 | 类型 | 说明 |
| uri | String | 选取的文件路径。 |
表1-4 fail返回错误码
| 错误码 | 说明 |
| 201 | 用户拒绝,获取相机权限失败。 |
示例
media.takeVideo({success:function(data){console.log("handling success: " + data.uri);},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
1.5 media.pickImage(OBJECT)
选择图片。
参数
| 参数 | 类型 | 必填 | 说明 |
| cancel | Function | 否 | 取消回调。 |
| success | Function | 否 | 成功回调,返回值如表1-5所示。 |
| fail | Function | 否 | 失败回调。 |
| complete | Function | 否 | 执行结束后的回调。 |
表1-5 success返回值
| 参数名 | 类型 | 说明 |
| uri | String | 选取的文件路径。 |
示例
media.pickImage({success:function(data){console.log("handling success: " + data.uri);}
})
1.6 media.pickVideo(OBJECT)
选择视频。
参数
| 参数 | 类型 | 必填 | 说明 |
| cancel | Function | 否 | 取消回调。 |
| success | Function | 否 | 成功回调,返回值如表1-6所示。 |
| fail | Function | 否 | 失败回调。 |
| complete | Function | 否 | 执行结束后的回调。 |
表1-6 success返回值
| 参数名 | 类型 | 说明 |
| uri | String | 选取的文件路径。 |
示例
media.pickVideo({success:function(data){console.log("handling success: " + data.uri);},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
2 图片处理
2.1 接口声明
{"name": "system.image"}
2.2 导入模块
import image from ´@system.image´ 或 var media = require("@system.image")
2.3 image.compressImage(OBJECT)
压缩指定路径的图片。
参数
| 参数 | 类型 | 默认值 | 必填 | 说明 |
| uri | String | 是 | 源文件的uri,如果是应用内资源路径, 不允许是相对路径。 | |
| quality | Number | 否 | 图片的压缩质量,0-100之间。 | |
| ratio | Number | 否 | 尺寸压缩倍数,大于0,值越大,图片尺寸越小,假如quality和ratio同时填写的场景下会先进尺寸压缩,后进行质量压缩。 | |
| format | String | JPEG | 否 | 压缩格式,支持三种格式:JPEG,PNG,WEBP。 |
| success | Function | 否 | 成功回调,返回值如表2-1所示。 | |
| fail | Function | 否 | 失败回调,返回值如表2-2所示。 | |
| complete | Function | 否 | 执行结束后的回调。 |
表2-1 success返回值
| 参数名 | 类型 | 必填 | 说明 |
| uri | String | 是 | 压缩成功后的文件路径uri,会保存在应用的cache目录中。 |
表2-2 fail返回错误码
| 错误码 | 说明 |
| 202 | 参数错误。 |
| 300 | I/O错误。 |
| 301 | 文件路径不存在。 |
示例
image.compressImage({uri: “tmp://abc.jpg”,
quality:80,
radio: 2,
format: ”JPEG”,
success: function(data) {
console.log(data.uri)
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
2.4 image.getImageInfo(OBJECT)
获取图片的信息。
参数
| 参数 | 类型 | 默认值 | 必填 | 说明 |
| uri | String | 是 | 源文件的uri,如果是应用内资源路径,不允许是相对路径。 | |
| success | Function | 否 | 成功回调,返回值如表2-3所示。 | |
| fail | Function | 否 | 失败回调,返回值如表2-4所示。 | |
| complete | Function | 否 | 执行结束后的回调。 |
表2-3 success返回值
| 参数名 | 类型 | 必填 | 说明 |
| uri | String | 是 | 压缩成功后的文件路径uri,会保存在应用的cache目录中。 |
| width | Number | 是 | 图片的宽度,单位为px。 |
| height | Number | 是 | 图片的高度,单位为px。 |
| size | Number | 是 | 图片的大小,单位为Byte。 |
表2-4 fail返回错误码
| 错误码 | 说明 |
| 202 | 参数错误。 |
| 300 | I/O错误。 |
| 301 | 文件路径不存在。 |
示例
image.getImageInfo({uri: “tmp://abc.jpg”,
success: function(data) {
console.log(data.uri + data.width + data.height + data.size)
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
2.5 image.editImage(OBJECT)
编辑图片,系统提供基础基于矩形框的裁剪图片UI组件,返回裁剪后保存的图片路径。
参数
| 参数 | 类型 | 默认值 | 必填 | 说明 |
| uri | String | 是 | 源文件的uri,仅支持本地图片路径,如果是应用内资源路径,不允许是相对路径。 | |
| success | Function | 否 | 成功回调,返回值如表2-5所示。 | |
| fail | Function | 否 | 失败回调,返回值如表2-6所示。 | |
| cancel | Function | 否 | 用户取消图片编辑。 | |
| complete | Function | 否 | 执行结束后的回调。 |
表2-5 success返回值
| 参数名 | 类型 | 必填 | 说明 |
| uri | String | 是 | 裁剪后图片的文件路径uri。 |
表2-6 fail返回错误码
| 错误码 | 说明 |
| 202 | 参数错误。 |
| 300 | I/O错误。 |
| 301 | 文件路径不存在。 |
示例
image.editImage({uri: “tmp://abc.jpg”,
success: function(data.uri) {
console.log(data.uri)
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
2.6 image.applyOperations(OBJECT)
对图片按顺序执行编辑操作。
在顺序执行编辑操作列表中的操作时,上一步操作生成的结果会作为下一步操作的输入,坐标系也是以上一步操作生成的结果的左上角为坐标原点重新确定的。
参数
| 参数 | 类型 | 必填 | 说明 |
| uri | String | 是 | 源文件的uri,仅支持本地图片路径,假如是应用内资源路径,不允许是相对路径。 |
| operations | ObjectArray | 否 | 编辑操作列表,按照出现的先后顺序执行。如果不提供,则不对图片进行编辑操作,但是保存参数依然有效。 |
| quality | Integer | 否 | 图片的压缩质量,0-100之间,默认是75。 |
| format | String | 否 | 图片保存格式,支持JPEG,PNG,WEBP三种格式。默认使用JPEG格式。 |
| success | Function | 否 | 成功回调,返回裁切后的图片地址,返回值如表2-7所示。 |
| fail | Function | 否 | 失败回调,返回值如表2-8所示。 |
| complete | Function | 否 | 执行结束后的回调。 |
表2-7 success返回值
| 参数名 | 类型 | 必填 | 说明 |
| uri | String | 是 | 裁剪后图片的文件路径uri,会保存到应用的cache分区中。 |
表2-8 fail返回错误码
| 错误码 | 说明 |
| 202 | 参数错误。 |
| 300 | I/O错误。 |
| 301 | 文件路径不存在。 |
支持的编辑操作如下:
● 图片裁剪
| 参数 | 类型 | 必填 | 说明 |
| action | String | 是 | 必须是crop。 |
| x | Number | 否 | 裁剪的起始点的x坐标,默认是0。 |
| y | Number | 否 | 裁剪的起始点的y坐标,默认是0。 |
| width | Number | 是 | 裁剪的图片宽度。 |
| height | Number | 是 | 裁剪的图片高度。 |
● 图片缩放
| 参数 | 类型 | 必填 | 说明 |
| action | String | 是 | 必须是scale。 |
| scaleX | Number | 否 | 宽度的缩放比率,缩放后宽度会变成原图的scaleX倍。默认是1。 |
| scaleY | Number | 否 | 高度的缩放比率,缩放后高度会变成原图的scaleY倍。默认是1。 |
● 图片旋转
| 参数 | 类型 | 必填 | 说明 |
| action | String | 是 | 必须是rotate。 |
| degree | Number | 是 | 旋转的角度。 |
示例
image.applyOperations({uri: ´internal://cache/123.png´,
operations: [
{
action: ´scale´,
scaleX: 0.5,
scaleY: 0.5
},
{
action: ´crop´,
width: 200,
height: 200
},
{
action: ´rotate´,
degree: 90,
}
],
quality: 90,
format: ´webp´,
success: function(data) {
console.log("handling success: " + data.uri);
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})





































苏公安网备 32011402010933号