微信小程序开发文档 第28页
wx.openVideoEditor(Object object) 基础库 2.12.0 开始支持,低版本需做兼容处理。 打开视频编辑器 参数 Object object 属性 类型 默认值 必填 说明 filePath string 是 视频源的路径,只支持本地路径 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 duration number 剪辑后生成的视频文件的时长,单位毫秒(ms) size number 剪辑后生成的视频文件大小,单位字节数(byte) tempFilePath string 编辑后生成的视频文件的临时路径 tempThumbPath string 编辑后生成的缩略图文件的临时路径
wx.saveVideoToPhotosAlbum(Object object) 基础库 1.2.0 开始支持,低版本需做兼容处理。 调用前需要 用户授权 scope.writePhotosAlbum 保存视频到系统相册。支持mp4视频格式。 参数 Object object 属性 类型 默认值 必填 说明 filePath string 是 视频文件路径,可以是临时文件路径也可以是永久文件路径 (本地路径) success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.saveVideoToPhotosAlbum({ filePath: 'wxfile://xxx', success (res) { console.log(res.errMsg) } })
wx.chooseImage(Object object) 从本地相册选择图片或使用相机拍照。 参数 Object object 属性 类型 默认值 必填 说明 count number 9 否 最多可以选择的图片张数 sizeType Array.<string> [‘original’, ‘compressed’] 否 所选的图片的尺寸 sourceType Array.<string> [‘album’, ‘camera’] 否 选择图片的来源 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.sizeType 的合法值 值 说明 最低版本 original 原图 compressed 压缩图 object.sourceType 的合法值 值 说明 最低版本 album 从相册选图 camera 使用相机 object.success 回调函数 参数 Object res 属性 类型 说明 最低版本 tempFilePaths Array.<string> 图片的本地临时文件路径列表 (本地路径) tempFiles Array.<Object> 图片的本地临时文件列表 1.2.0 res.tempFiles 的结构 属性 类型 说明 path string 本地临时文件路径 (本地路径) size number 本地临时文件大小,单位 B wx.chooseImage({ count: 1, sizeType: ['original', 'compressed'], sourceType: ['album', 'camera'], success (res) { // tempFilePath可以作为img标签的src属性显示图片 const tempFilePaths = res.tempFilePaths } })
wx.chooseMessageFile(Object object) 基础库 2.5.0 开始支持,低版本需做兼容处理。 从客户端会话选择文件。 参数 Object object 属性 类型 默认值 必填 说明 最低版本 count number 是 最多可以选择的文件个数,可以 0~100 type string ‘all’ 否 所选的文件的类型 extension Array.<string> 否 根据文件拓展名过滤,仅 type==file 时有效。每一项都不能是空字符串。默认不过滤。 2.6.0 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.type 的合法值 值 说明 最低版本 all 从所有文件选择 video 只能选择视频文件 image 只能选择图片文件 file 可以选择除了图片和视频之外的其它的文件 object.success 回调函数 参数 Object res 属性 类型 说明 tempFiles Array.<Object> 返回选择的文件的本地临时文件对象数组 res.tempFiles 的结构 属性 类型 说明 path string 本地临时文件路径 (本地路径) size number 本地临时文件大小,单位 B name string 选择的文件名称 type string 选择的文件类型 time number 选择的文件的会话发送时间,Unix时间戳,工具暂不支持此属性 type 的合法值 值 说明 最低版本 video 选择了视频文件 image 选择了图片文件 file 选择了除图片和视频的文件 wx.chooseMessageFile({ count: 10, type: 'image', success (res) { // tempFilePath可以作为img标签的src属性显示图片 const tempFilePaths = res.tempFiles } })
wx.compressImage(Object object) 基础库 2.4.0 开始支持,低版本需做兼容处理。 压缩图片接口,可选压缩质量 参数 Object object 属性 类型 默认值 必填 说明 src string 是 图片路径,图片的路径,支持本地路径、代码包路径 quality number 80 否 压缩质量,范围0~100,数值越小,质量越低,压缩率越高(仅对jpg有效)。 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 tempFilePath string 压缩后图片的临时文件路径 (本地路径) 示例代码 wx.compressImage({ src: '', // 图片路径 quality: 80 // 压缩质量 })
wx.getImageInfo(Object object) 获取图片信息。网络图片需先配置download域名才能生效。 参数 Object object 属性 类型 默认值 必填 说明 src string 是 图片的路径,支持网络路径、本地路径、代码包路径 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 最低版本 width number 图片原始宽度,单位px。不考虑旋转。 height number 图片原始高度,单位px。不考虑旋转。 path string 图片的本地路径 orientation string 拍照时设备方向 1.9.90 type string 图片格式 1.9.90 res.orientation 的合法值 值 说明 最低版本 up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。 up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2 down 旋转180度,对应 Exif 中的 3 down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4 left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5 right 顺时针旋转90度,对应 Exif 中的 6 right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7 left 逆时针旋转90度,对应 Exif 中的 8 示例代码 wx.getImageInfo({ src: 'images/a.jpg', success (res) { console.log(res.width) console.log(res.height) } }) wx.chooseImage({ success (res) { wx.getImageInfo({...
wx.previewImage(Object object) 在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。 参数 Object object 属性 类型 默认值 必填 说明 urls Array.<string> 是 需要预览的图片链接列表。2.2.3 起支持云文件ID。 current string urls 的第一张 否 当前显示图片的链接 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.previewImage({ current: '', // 当前显示图片的http链接 urls: [] // 需要预览的图片http链接列表 })
wx.previewMedia(Object object) 基础库 2.12.0 开始支持,低版本需做兼容处理。 预览图片和视频。 参数 Object object 属性 类型 默认值 必填 说明 sources Array.<Object> 是 需要预览的资源列表 current current 0 否 当前显示的资源序号 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.sources 的结构 属性 类型 默认值 必填 说明 url String 是 图片或视频的地址 type String image 否 资源的类型,默认为图片 poster string 否 视频的封面图片 type 的合法值 值 说明 最低版本 image 图片 video 视频
wx.saveImageToPhotosAlbum(Object object) 基础库 1.2.0 开始支持,低版本需做兼容处理。 调用前需要 用户授权 scope.writePhotosAlbum 保存图片到系统相册。 参数 Object object 属性 类型 默认值 必填 说明 filePath string 是 图片文件路径,可以是临时文件路径或永久文件路径 (本地路径) ,不支持网络路径 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.saveImageToPhotosAlbum({ success(res) { } })
UDPSocket wx.createUDPSocket() 基础库 2.7.0 开始支持,低版本需做兼容处理。 创建一个 UDP Socket 实例。使用前请注意阅读相关说明。 返回值 UDPSocket 一个 UDP Socket 实例 UDPSocket 基础库 2.7.0 开始支持,低版本需做兼容处理。 一个 UDP Socket 实例,默认使用 IPv4 协议。 方法: number UDPSocket.bind(number port) 绑定一个系统随机分配的可用端口,或绑定一个指定的端口号 参数 number port 基础库 2.9.0 开始支持,低版本需做兼容处理。 指定要绑定的端口号,不传则返回系统随机分配的可用端口 返回值 number 绑定成功的端口号 示例代码 const udp = wx.createUDPSocket() const port = udp.bind() UDPSocket.close() 关闭 UDP Socket 实例,相当于销毁。 在关闭之后,UDP Socket 实例不能再发送消息,每次调用 UDPSocket.send 将会触发错误事件,并且 message 事件回调函数也不会再也执行。在 UDPSocket 实例被创建后将被 Native 强引用,保证其不被 GC。在 UDPSocket.close 后将解除对其的强引用,让 UDPSocket 实例遵从 GC。 UDPSocket.offClose(function callback) 取消监听关闭事件 参数 function callback 关闭事件的回调函数 UDPSocket.offError(function callback) 取消监听错误事件 参数 function callback 错误事件的回调函数 UDPSocket.offListening(function callback) 取消监听开始监听数据包消息的事件 参数 function callback 开始监听数据包消息的事件的回调函数 UDPSocket.offMessage(function callback) 取消监听收到消息的事件 参数 function callback 收到消息的事件的回调函数 UDPSocket.onClose(function callback) 监听关闭事件 参数 function callback 关闭事件的回调函数 UDPSocket.onError(function callback) 监听错误事件 参数 function callback 错误事件的回调函数 参数 Object res 属性 类型 说明 errMsg string 错误信息 UDPSocket.onListening(function callback) 监听开始监听数据包消息的事件 参数 function...