微信小程序API 实时语音·监听被动断开通话事件
wx.onVoIPChatInterrupted(function callback) 基础库 2.7.0 开始支持,低版本需做兼容处理。 监听被动断开实时语音通话事件。包括小游戏切入后端时断开 参数 function callback 被动断开实时语音通话事件的回调函数 参数 Object res 属性 类型 说明 errCode Number 错误码 errMsg String 调用结果(错误原因)
wx.onVoIPChatInterrupted(function callback) 基础库 2.7.0 开始支持,低版本需做兼容处理。 监听被动断开实时语音通话事件。包括小游戏切入后端时断开 参数 function callback 被动断开实时语音通话事件的回调函数 参数 Object res 属性 类型 说明 errCode Number 错误码 errMsg String 调用结果(错误原因)
wx.onVoIPChatMembersChanged(function callback) 基础库 2.7.0 开始支持,低版本需做兼容处理。 监听实时语音通话成员在线状态变化事件。有成员加入/退出通话时触发回调 参数 function callback 实时语音通话成员在线状态变化事件的回调函数 参数 Object res 属性 类型 说明 openIdList Array.<String> 还在实时语音通话中的成员 openId 名单 errCode Number 错误码 errMsg String 调用结果
wx.onVoIPChatSpeakersChanged(function callback) 基础库 2.7.0 开始支持,低版本需做兼容处理。 监听实时语音通话成员通话状态变化事件。有成员开始/停止说话时触发回调 参数 function callback 实时语音通话成员通话状态变化事件的回调函数 参数 Object res 属性 类型 说明 openIdList Array.<String> 还在实时语音通话中的成员 openId 名单 errCode Number 错误码 errMsg String 调用结果(错误原因)
wx.updateVoIPChatMuteConfig(Object object) 基础库 2.7.0 开始支持,低版本需做兼容处理。 更新实时语音静音设置 参数 Object object 属性 类型 默认值 必填 说明 muteConfig Object 是 静音设置 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.muteConfig 的结构 属性 类型 默认值 必填 说明 muteMicrophone Boolean false 否 是否静音麦克风 muteEarphone Boolean false 否 是否静音耳机
MediaTrack 基础库 2.9.0 开始支持,低版本需做兼容处理。 可通过 MediaContainer.extractDataSource 返回。 MediaTrack 音频或视频轨道,可以对轨道进行一些操作 属性 string kind 轨道类型,只读 kind 的合法值 值 说明 最低版本 audio 音频轨道 video 视频轨道 number duration 轨道长度,只读 number volume 音量,音频轨道下有效,可写
MediaContainer 基础库 2.9.0 开始支持,低版本需做兼容处理。 可通过 wx.createMediaContainer 创建。 MediaContainer 音视频处理容器,可以进行音频混音等操作 方法: MediaContainer.addTrack(MediaTrack track) 基础库 2.9.0 开始支持,低版本需做兼容处理。 将音频或视频轨道添加到容器 参数 MediaTrack track 要添加的音频或视频轨道 MediaContainer.destroy() 基础库 2.9.0 开始支持,低版本需做兼容处理。 将容器销毁,释放资源 MediaContainer.export() 基础库 2.9.0 开始支持,低版本需做兼容处理。 将容器内的轨道合并并导出视频文件 MediaContainer.extractDataSource(Object object) 基础库 2.9.0 开始支持,低版本需做兼容处理。 将传入的视频源分离轨道。不会自动将轨道添加到待合成的容器里。 参数 Object object 属性 类型 默认值 必填 说明 source string 是 视频源地址,只支持本地文件 MediaContainer.removeTrack(MediaTrack track) 基础库 2.9.0 开始支持,低版本需做兼容处理兼容处理。 将音频或视频轨道从容器中移除 参数 MediaTrack track 要移除的音频或视频轨道
EditorContext 基础库 2.7.0 开始支持,低版本需做兼容处理。 EditorContext 实例,可通过 wx.createSelectorQuery 获取。 EditorContext 通过 id 跟一个 editor 组件绑定,操作对应的 editor 组件。 方法: EditorContext.blur(Object object) 基础库 2.8.3 开始支持,低版本需做兼容处理。 编辑器失焦,同时收起键盘。 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) EditorContext.clear(Object object) 基础库 2.7.0 开始支持,低版本需做兼容处理。 清空编辑器内容 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) EditorContext.format(string name, string value) 基础库 2.7.0 开始支持,低版本需做兼容处理。 修改样式 参数 string name 属性 string value 值 支持设置的样式列表 name value verson bold 2.7.0 italic 2.7.0 underline 2.7.0 strike 2.7.0 ins 2.7.0 script sub / super 2.7.0 header H1 / H2 / h3 / H4 / h5 / H6 2.7.0 align left / center / right / justify 2.7.0 direction rtl 2.7.0 indent...
CameraFrameListener CameraContext.onCameraFrame() 返回的监听器。 方法: CameraFrameListener.start(Object object) 开始监听帧数据 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) CameraFrameListener.stop(Object object) 停止监听帧数据 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)
CameraContext CameraContext 实例,可通过 wx.createCameraContext 获取。 CameraContext 与页面内唯一的 camera 组件绑定,操作对应的 camera 组件。 方法: CameraFrameListener CameraContext.onCameraFrame(function callback) 基础库 2.7.0 开始支持,低版本需做兼容处理。 获取 Camera 实时帧数据 参数 function callback 回调函数 参数 Object res 属性 类型 说明 width number 图像数据矩形的宽度 height number 图像数据矩形的高度 data ArrayBuffer 图像像素点数据,一维数组,每四项表示一个像素点的 rgba 返回值 CameraFrameListener 注: 使用该接口需同时在 camera 组件属性中指定 frame-size。 示例代码 const context = wx.createCameraContext() const listener = context.onCameraFrame((frame) => { console.log(frame.data instanceof ArrayBuffer, frame.width, frame.height) }) listener.start() CameraContext.setZoom(Object object) 基础库 2.10.0 开始支持,低版本需做兼容处理。 设置缩放级别 参数 Object object 属性 类型 默认值 必填 说明 zoom number 是 缩放级别,范围[1, maxZoom]。zoom 可取小数,精确到小数后一位。maxZoom 可在 bindinitdone 返回值中获取。 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 zoom number 实际设置的缩放级别。由于系统限制,某些机型可能无法设置成指定值,会改用最接近的可设值。 CameraContext.startRecord(Object object) 开始录像 参数 Object object 属性 类型 默认值 必填 说明 timeoutCallback function 否 超过30s或页面 onHide 时会结束录像 success function 否...
RecorderManager 全局唯一的录音管理器 方法: RecorderManager.onError(function callback) 监听录音错误事件 参数 function callback 录音错误事件的回调函数 参数 Object res 属性 类型 说明 errMsg string 错误信息 RecorderManager.onFrameRecorded(function callback) 监听已录制完指定帧大小的文件事件。如果设置了 frameSize,则会回调此事件。 参数 function callback 已录制完指定帧大小的文件事件的兼容处理。 参数 Object res 属性 类型 说明 frameBuffer ArrayBuffer 录音分片数据 isLastFrame boolean 当前帧是否正常录音结束前的最后一帧 RecorderManager.onInterruptionBegin(function callback) 基础库 2.3.0 开始支持,低版本需做兼容处理。 监听录音因为受到系统占用而被中断开始事件。以下场景会触发此事件:微信语音聊天、微信视频聊天。此事件触发后,录音会被暂停。pause 事件在此事件后触发 参数 function callback 录音因为受到系统占用而被中断开始事件的回调函数 RecorderManager.onInterruptionEnd(function callback) 基础库 2.3.0 开始支持,低版本需做兼容处理。 监听录音中断结束事件。在收到 interruptionBegin 事件之后,小程序内所有录音会暂停,收到此事件之后才可再次录音成功。 参数 function callback 录音中断结束事件的回调函数 RecorderManager.onPause(function callback) 监听录音暂停事件 参数 function callback 录音暂停事件的回调函数 RecorderManager.onResume(function callback) 监听录音继续事件 参数 function callback 录音继续事件的回调函数 RecorderManager.onStart(function callback) 监听录音开始事件 参数 function callback 录音开始事件的回调函数 RecorderManager.onStop(function callback) 监听录音结束事件 参数 function callback 录音结束事件的回调函数 参数 Object res 属性 类型 说明 tempFilePath string 录音文件的临时路径 (本地路径) duration number 录音总时长,单位:ms fileSize number 录音文件大小,单位:Byte RecorderManager.pause() 暂停录音 RecorderManager.resume() 继续录音 RecorderManager.start(Object object) 开始录音 参数 Object object 属性 类型 默认值 必填...