微信小程序开发文档 第24页

wx.openDocument(Object object) 删除本地缓存文件。微信客户端 7.0.12 版本前默认显示右上角菜单按钮，之后的版本默认不显示，需主动传入 showMenu。 参数 Object object 属性 类型 默认值 必填 说明 最低版本 filePath string 是 文件路径 (本地路径) ，可通过 downloadFile 获得 showMenu boolean false 否 是否显示右上角菜单 2.11.0 fileType string 否 文件类型，指定文件类型打开文件 1.4.0 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） object.fileType 的合法值 值 说明 最低版本 doc doc 格式 docx docx 格式 xls xls 格式 xlsx xlsx 格式 ppt ppt 格式 pptx pptx 格式 pdf pdf 格式 示例代码 wx.downloadFile({ // 示例 url，并非真实存在 url: 'http://example.com/somefile.pdf', success: function (res) { const filePath = res.tempFilePath wx.openDocument({ filePath: filePath, success: function (res) { console.log('打开文档成功') } }) } })

wx.removeSavedFile(Object object) 删除本地缓存文件 参数 Object object 属性 类型 默认值 必填 说明 filePath string 是 需要删除的文件路径 (本地路径) success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） 示例代码 wx.getSavedFileList({ success (res) { if (res.fileList.length > 0){ wx.removeSavedFile({ filePath: res.fileList[0].filePath, complete (res) { console.log(res) } }) } } })

wx.saveFile(Object object) 保存文件到本地。注意：saveFile 会把临时文件移动，因此调用成功后传入的 tempFilePath 将不可用 参数 Object object 属性 类型 默认值 必填 说明 tempFilePath string 是 需要保存的文件的临时路径 (本地路径) success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） object.success 回调函数 参数 Object res 属性 类型 说明 savedFilePath number 存储后的文件路径 (本地路径) 示例代码 wx.chooseImage({ success: function(res) { const tempFilePaths = res.tempFilePaths wx.saveFile({ tempFilePath: tempFilePaths[0], success (res) { const savedFilePath = res.savedFilePath } }) } }) 注意 本地文件存储的大小限制为 10M

wx.saveFileToDisk(Object object) 基础库 2.11.0 开始支持，低版本需做兼容处理。 保存文件系统的文件到用户磁盘，仅在 PC 端支持 参数 Object object 属性 类型 默认值 必填 说明 filePath string 是 待保存文件路径 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

VideoDecoder 基础库 2.11.0 开始支持，低版本需做兼容处理。 可通过 wx.createVideoDecoder 创建。 VideoDecoder 视频解码器，可以进行视频解码相关操作，逐帧获取解码数据 方法： Object VideoDecoder.getFrameData() 基础库 2.11.0 开始支持，低版本需做兼容处理。 获取下一帧的解码数据 返回值 Object 视频帧数据，若取不到则返回 null。当缓冲区为空的时候可能暂停取不到数据。 属性 类型 说明 width number 帧数据宽度 height number 帧数据高度 data ArrayBuffer 帧数据 pkPts number 帧原始 pts pkDts number 帧原始 dts VideoDecoder.off(string eventName, function callback) 基础库 2.11.0 开始支持，低版本需做兼容处理。 取消监听录制事件。当对应事件触发时，该回调函数不再执行 参数 string eventName 事件名 function callback 事件触发时执行的回调函数 VideoDecoder.on(string eventName, function callback) 基础库 2.11.0 开始支持，低版本需做兼容处理。 注册监听录制事件的回调函数。当对应事件触发时，回调函数会被执行 参数 string eventName 事件名 eventName 的合法值 值 说明 最低版本 start 开始事件。返回 {width, height} stop 结束事件。 seek seek 完成事件。 bufferchange 缓冲区变化事件。 ended 解码结束事件。 function callback 事件触发时执行的回调函数 VideoDecoder.remove() 基础库 2.11.0 开始支持，低版本需做兼容处理。 移除解码器 VideoDecoder.seek(number position) 基础库 2.11.0 开始支持，低版本需做兼容处理。 跳到某个时间点解码 参数 number position 跳转的解码位置，单位 ms VideoDecoder.start(Object object) 基础库 2.11.0 开始支持，低版本需做兼容处理。 开始解码 参数 Object object 属性 类型 默认值 必填 说明 source string 是 需要解码的视频源文件，只支持本地路径 mode...

MediaRecorder 基础库 2.11.0 开始支持，低版本需做兼容处理。 可通过 wx.createMediaRecorder 创建。 MediaRecorder WebGL 画面录制器，可以进行录制相关操作，在结束录制时导出视频文件 方法： MediaRecorder.destroy() 基础库 2.11.0 开始支持，低版本需做兼容处理。 销毁录制器 MediaRecorder.off(string eventName, function callback) 基础库 2.11.0 开始支持，低版本需做兼容处理。 取消监听录制事件。当对应事件触发时，该回调函数不再执行。 参数 string eventName 事件名 function callback 事件触发时执行的回调函数 MediaRecorder.on(string eventName, function callback) 基础库 2.11.0 开始支持，低版本需做兼容处理。 注册监听录制事件的回调函数。当对应事件触发时，回调函数会被执行。 参数 string eventName 事件名 eventName 的合法值 值 说明 最低版本 start 录制开始事件。 stop 录制结束事件。返回 {tempFilePath, duration, fileSize} function callback 事件触发时执行的回调函数 MediaRecorder.pause() 基础库 2.11.0 开始支持，低版本需做兼容处理。 暂停录制 MediaRecorder.requestFrame(function callback) 基础库 2.11.0 开始支持，低版本需做兼容处理。 请求下一帧录制，在 callback 里完成一帧渲染后开始录制当前帧 参数 function callback MediaRecorder.resume() 基础库 2.11.0 开始支持，低版本需做兼容处理。 恢复录制 MediaRecorder.start() 基础库 2.11.0 开始支持，低版本需做兼容处理。 开始录制 MediaRecorder.stop() 基础库 2.11.0 开始支持，低版本需做兼容处理。 结束录制

MediaRecorder wx.createMediaRecorder(Object canvas, Object options) 基础库 2.11.0 开始支持，低版本需做兼容处理。 创建 WebGL 画面录制器，可逐帧录制在 WebGL 上渲染的画面并导出视频文件 参数 Object canvas WebGL 对象，通过 SelectorQuery 获取到的 node 对象 Object options 属性 类型 默认值 必填 说明 duration number 600 否 指定录制的时长（s)，到达自动停止。最大 7200，最小 5 videoBitsPerSecond number 1000 否 视频比特率（kbps），最小值 600，最大值 3000 gop number 12 否 视频关键帧间隔 fps number 24 否 视频 fps 返回值 MediaRecorder

wx.exitVoIPChat(Object object) 基础库 2.7.0 开始支持，低版本需做兼容处理。 退出（销毁）实时语音通话 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.joinVoIPChat(Object object) 基础库 2.7.0 开始支持，低版本需做兼容处理。 调用前需要 用户授权 scope.record 加入 (创建) 实时语音通话，更多信息可见 实时语音指南 参数 Object object 属性 类型 默认值 必填 说明 roomType String voice 否 房间类型 signature String 是 签名，用于验证小游戏的身份 nonceStr String 是 验证所需的随机字符串 timeStamp Number 是 验证所需的时间戳 groupId String 是 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 muteConfig Object 否 静音设置 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） object.roomType 的合法值 值 说明 最低版本 voice 音频房间，用于语音通话 video 视频房间，结合 voip-room 组件可显示成员画面 object.muteConfig 的结构 属性 类型 默认值 必填 说明 muteMicrophone Boolean false 否 是否静音麦克风 muteEarphone Boolean false 否 是否静音耳机 object.success 回调函数 参数 Object res 属性 类型 说明 openIdList Array.<String> 在此通话中的成员 openId 名单 errCode Number 错误码 errMsg String 调用结果 错误 错误码 错误信息 说明 -1 当前已在房间内 -2 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 -3 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 -1000 系统错误

wx.onOnVoIPVideoMembersChanged(function callback) 基础库 2.11.0 开始支持，低版本需做兼容处理。 监听实时语音通话成员视频状态变化事件。 参数 function callback 实时语音通话成员视频状态变化事件的回调函数 参数 Object res 属性 类型 说明 openIdList Array.<String> 开启视频的成员名单 errCode Number 错误码 errMsg String 调用结果