多媒体
调用相机/相册
注意:
微信上 chooseImage 接口用户点击"取消"不会触发任何回调。
chooseImage
拍照或从手机相册中选图接口
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
名称 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
count | number | 9 | 否 | 最多可以选择的图片张数 |
sourceType | String Array | ['album', 'camera'] | 否 | 选择图片的来源 |
watermark | object | 否 | 照片添加水印,只有拍照功能下生效(wx不支持) | |
returnThumbnail | boolen | false | 否 | 是否需要返回缩略图(wx不支持) |
sourceType的合法值
值 | 说明 |
---|---|
album | 从相册选择图片 |
camera | 使用相机 |
watermark的参数说明
名称 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
text | string | 是 | 水印的文字内容 | |
position | number | 0 | 否 | 水印的位置,0-正下方;1-正上方;2-正左方;3-正右方;4-左上方;5-左下方;6-右上方;7-右下方; |
font | number | 0 | 否 | 水印的文字大小,0-正常;1-大;2-小 |
color | string | #FFFFFF | 否 | 水印的文字颜色 |
alpha | number | 0.5 | 否 | 水印的文字的透明度,0-1之间的 |
示例
mtl.chooseImage({
sourceType: ['album','camera'],
returnThumbnail: true,
watermark: {
text:'我的水印',
position:0,
font:1,
color:'#FF00FF',
alpha:0.9
},
success: function(res) {
// 返回选定照片的本地ID列表
var localIds = res.localIds; // ['wxLocalResource://imageid123456789', ...]
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
预览图片
previewImage
跳转到图片预览界面
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数**
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
current | string | 否 | 当前显示图片的 url |
urls | Array. | 是 | 需要预览的图片 url 列表 |
示例
mtl.previewImage({
current: "https://wx2.sinaimg.cn/mw690/70396e5agy1g0leayhrhoj211418gq9q.jpg",
urls: [
"https://wx3.sinaimg.cn/mw690/70396e5agy1g0leax4owvj211418gk2j.jpg",
"https://wx4.sinaimg.cn/mw690/70396e5agy1g0leay2ymtj211418gk11.jpg",
"https://wx2.sinaimg.cn/mw690/70396e5agy1g0leayhrhoj211418gq9q.jpg",
"https://wx3.sinaimg.cn/mw690/70396e5agy1g0leazeikxj211418gqdc.jpg"
],
success: function(res){
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
保存图片到相册
saveImageToPhotoAlbum
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 否 | 图片的文件服务器地址 |
示例
mtl.saveImageToPhotoAlbum({
url:''
success: function(res) {
...
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
获取本地图片的base64编码
getLocalImgData
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
localId | string | 是 | 图片的localID |
示例
mtl.getLocalImgData({
localId: "",
success: function(res) {
var localData = res.localData; // localData是图片的base64数据,可以用 img 标签显示
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
保存图片到本地
saveImageToLocal
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 图片的文件服务器地址 |
示例
mtl.saveImageToLocal({
url: "",
success: function(res) {
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
读取本地图片
loadImageFromLocal
读取本地已保存的图片,以BASE64流的形式返回。(场景为弱网情况下需要展示图片,服务器图片请求超时则取本地图片)
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 图片的文件服务器地址 |
示例
mtl.loadImageFromLocal({
url: "",
success: function(res) {
let imageData = res.imageData
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
删除本地base64图片
deleteBase64Image
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✘ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 图片的名字(xxx.jpg或者xxx.png) |
示例
mtl.deleteBase64Image({
name: "",
success: function(res) {
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
保存base64图片到本地
saveBase64Image
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✘ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 图片的名字(xxx.jpg或者xxx.png) |
base64str | string | 是 | 图片的base64数据 |
示例
mtl.saveBase64Image({
name: "",
base64str: "",
success: function(res) {
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
选取视频
chooseVideo
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
sourceType | array | 否 | 选择视频来源,默认二者都有。['album', 'camera'] |
maxDuration | number | 否 | 最长视频时间。最长60秒,默认15秒 |
成功回调返回
字段 | 类型 | 说明 |
---|---|---|
filePath | string | 视频临时文件路径,最大支持100MB |
duration | number | 视频时间长度,单位(秒) |
size | number | 视频数据大小,单位(字节) |
height | number | 视频高度 |
width | number | 视频宽度 |
示例**
mtl.chooseVideo({
maxDuration: 15,
sourceType: ["album", "camera"],
success: function(res) {
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
音频-开始录音
startRecord
开始录音(友空间5.22.0及以上版本)
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
-无-
示例
mtl.startRecord({
fail: function(err) {
var message = err.message; // 错误信息
}
});
音频-结束录音
stopRecord
结束录音(友空间5.22.0及以上版本)
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
-无-
示例
mtl.stopRecord({
success: function(res) {
var localId = res.localId; // 微信音频的本地ID,用空间是BASE64加密处理后的音频数据字符串
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
监听录音自动停止
onVoiceRecordEnd
监听录音自动停止,录音时间超过一分钟没有停止的时候会执行 complete 回调
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
-无-
示例
mtl.onVoiceRecordEnd({
success: function(res) {
var localId = res.localId; // 微信音频的本地ID,用空间是BASE64加密处理后的音频数据字符串
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
音频-播放录音
playVoice
播放录音(友空间5.22.0及以上版本)
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
localId | string | 是 | 需要播放的音频的本地ID,由 stopRecord 接口获得 |
注意
1、播放localId必传;
2、继续播放:友空间端localId必须为空,微信端localId必传。
示例
mtl.playVoice({
localId: "",
fail: function(err) {
var message = err.message; // 错误信息
}
});
音频-暂停播放录音
pauseVoice
暂停播放录音,继续播放请调用 playVoice方法(友空间5.22.0及以上版本)
如果当前不再播放状态,友空间返回错误,微信返回成功
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
localId | string | 是 | 需要暂停的音频的本地ID,由 stopRecord 接口获得 |
示例
mtl.pauseVoice({
localId: "",
fail: function(err) {
var message = err.message; // 错误信息
}
});
音频-结束播放
stopVoice
结束播放(友空间5.22.0及以上版本)
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
localId | string | 是 | 需要停止的音频的本地ID,由 stopRecord 接口获得 |
示例
mtl.stopVoice({
localId: "",
fail: function(err) {
var message = err.message; // 错误信息
}
});
监听录音播放完毕
onVoicePlayEnd
监听录音播放完毕
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
-无-
示例
mtl.onVoicePlayEnd({
success: function(res) {
var localId = res.localId; // 音频的本地ID
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
录音(含UI)
recordAudio
提供录音界面以及功能,支持最长60s录音,返回经过BASE64加密处理后的音频数据字符串。
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✔︎ |
参数
-无-
成功回调返回
字段 | 类型 | 说明 |
---|---|---|
bytes | string | 经过BASE64加密处理后的音频数据字符串 |
示例**
mtl.recordAudio({
success: function(res) {
},
fail: function(err) {
var message = err.message; // 错误信息
}
});