微信小程序开发文档 第26页
wx.stopRecord(Object object) 从基础库 1.6.0 开始,本接口停止维护,请使用 wx.getRecorderManager 代替 停止录音。 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.startRecord({ success (res) { const tempFilePath = res.tempFilePath } }) setTimeout(function () { wx.stopRecord() // 结束录音 }, 10000)
wx.startRecord(Object object) 调用前需要 用户授权 scope.record 从基础库 1.6.0 开始,本接口停止维护,请使用 wx.getRecorderManager 代替 开始录音。当主动调用 wx.stopRecord,或者录音超过1分钟时自动结束录音。当用户离开小程序时,此接口无法调用。 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 tempFilePath string 录音文件的临时路径 (本地路径) 示例代码 wx.startRecord({ success (res) { const tempFilePath = res.tempFilePath } }) setTimeout(function () { wx.stopRecord() // 结束录音 }, 10000)
LivePusherContext 实例,可通过 wx.createLivePusherContext 获取。 LivePusherContext 与页面内唯一的 live-pusher 组件绑定,操作对应的 live-pusher 组件。 方法: LivePusherContext.pause(Object object) 暂停推流 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePusherContext.pauseBGM(Object object) 基础库 2.4.0 开始支持,低版本需做兼容处理。 暂停背景音 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePusherContext.playBGM(Object object) 基础库 2.4.0 开始支持,低版本需做兼容处理。 播放背景音 参数 Object object 属性 类型 默认值 必填 说明 url string 是 加入背景混音的资源地址 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePusherContext.resume(Object object) 恢复推流 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePusherContext.resumeBGM(Object object) 基础库 2.4.0 开始支持,低版本需做兼容处理。 恢复背景音 参数 Object object 属性 类型 默认值 必填 说明...
LivePlayerContext LivePlayerContext 实例,可通过 wx.createLivePlayerContext 获取。 LivePlayerContext 通过 id 跟一个 live-player 组件绑定,操作对应的 live-player 组件。 方法: LivePlayerContext.exitFullScreen(Object object) 退出全屏 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePlayerContext.exitPictureInPicture(Object object) 退出小窗,该方法可在任意页面调用 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePlayerContext.mute(Object object) 静音 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePlayerContext.pause(Object object) 基础库 1.9.90 开始支持,低版本需做兼容处理。 暂停 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) LivePlayerContext.play(Object object) 播放 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function...
BackgroundAudioManager BackgroundAudioManager 实例,可通过 wx.getBackgroundAudioManager 获取。 属性 string src 音频的数据源(2.2.3 开始支持云文件ID)。默认为空字符串,当设置了新的 src 时,会自动开始播放,目前支持的格式有 m4a, aac, mp3, wav。 number startTime 音频开始播放的位置(单位:s)。 string title 音频标题,用于原生音频播放器音频标题(必填)。原生音频播放器中的分享功能,分享出去的卡片标题,也将使用该值。 string epname 专辑名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。 string singer 歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。 string coverImgUrl 封面图 URL,用于做原生音频播放器背景图。原生音频播放器中的分享功能,分享出去的卡片配图及背景也将使用该图。 string webUrl 页面链接,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。 string protocol 基础库 1.9.94 开始支持,低版本需做兼容处理。 音频协议。默认值为 ‘http’,设置 ‘hls’ 可以支持播放 HLS 协议的直播音频。 number playbackRate 基础库 2.11.0 开始支持,低版本需做兼容处理。 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) number duration 当前音频的长度(单位:s),只有在有合法 src 时返回。(只读) number currentTime 当前音频的播放位置(单位:s),只有在有合法 src 时返回。(只读) boolean paused 当前是否暂停或停止。(只读) number buffered 音频已缓冲的时间,仅保证当前播放时间点到此时间点内容已缓冲。(只读) 方法: BackgroundAudioManager.onCanplay(function callback) 监听背景音频进入可播放状态事件。 但不保证后面可以流畅播放 参数 function callback 背景音频进入可播放状态事件的回调函数 BackgroundAudioManager.onEnded(function callback) 监听背景音频自然播放结束事件 参数 function callback 背景音频自然播放结束事件的回调函数 BackgroundAudioManager.onError(function callback) 监听背景音频播放错误事件 参数 function callback 背景音频播放错误事件的回调函数 BackgroundAudioManager.onNext(function callback) 监听用户在系统音乐播放面板点击下一曲事件(仅iOS) 参数 function callback 用户在系统音乐播放面板点击下一曲事件的回调函数 BackgroundAudioManager.onPause(function callback) 监听背景音频暂停事件 参数 function callback 背景音频暂停事件的回调函数 BackgroundAudioManager.onPlay(function callback) 监听背景音频播放事件 参数 function callback 背景音频播放事件的回调函数 BackgroundAudioManager.onPrev(function callback) 监听用户在系统音乐播放面板点击上一曲事件(仅iOS) 参数 function callback...
wx.getBackgroundAudioPlayerState(Object object) 从基础库 1.2.0 开始,本接口停止维护,请使用 wx.getBackgroundAudioManager 代替 获取后台音乐播放状态。 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 duration number 选定音频的长度(单位:s),只有在音乐播放中时返回 currentPosition number 选定音频的播放位置(单位:s),只有在音乐播放中时返回 status number 播放状态 downloadPercent number 音频的下载进度百分比,只有在音乐播放中时返回 dataUrl string 歌曲数据链接,只有在音乐播放中时返回 res.status 的合法值 值 说明 最低版本 0 暂停中 1 播放中 2 没有音乐播放 示例代码 wx.getBackgroundAudioPlayerState({ success (res) { const status = res.status const dataUrl = res.dataUrl const currentPosition = res.currentPosition const duration = res.duration const downloadPercent = res.downloadPercent } })
wx.pauseBackgroundAudio(Object object) 从基础库 1.2.0 开始,本接口停止维护,请使用 wx.getBackgroundAudioManager 代替 暂停播放音乐。 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.pauseBackgroundAudio()
wx.seekBackgroundAudio(Object object) 从基础库 1.2.0 开始,本接口停止维护,请使用 wx.getBackgroundAudioManager 代替 控制音乐播放进度。 参数 Object object 属性 类型 默认值 必填 说明 position number 是 音乐位置,单位:秒 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.seekBackgroundAudio({ position: 30 })
wx.stopBackgroundAudio(Object object) 从基础库 1.2.0 开始,本接口停止维护,请使用 wx.getBackgroundAudioManager 代替 停止播放音乐。 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.stopBackgroundAudio()
InnerAudioContext InnerAudioContext 实例,可通过 wx.createInnerAudioContext 接口获取实例。 属性 string src 音频资源的地址,用于直接播放。2.2.3 开始支持云文件ID number startTime 开始播放的位置(单位:s),默认为 0 boolean autoplay 是否自动开始播放,默认为 false boolean loop 是否循环播放,默认为 false boolean obeyMuteSwitch 是否遵循系统静音开关,默认为 true。当此参数为 false 时,即使用户打开了静音开关,也能继续发出声音。从 2.3.0 版本开始此参数不生效,使用 wx.setInnerAudioOption 接口统一设置。 number volume 音量。范围 0~1。默认为 1 number playbackRate 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) number duration 当前音频的长度(单位 s)。只有在当前有合法的 src 时返回(只读) number currentTime 当前音频的播放位置(单位 s)。只有在当前有合法的 src 时返回,时间保留小数点后 6 位(只读) boolean paused 当前是是否暂停或停止状态(只读) number buffered 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲(只读) 方法: InnerAudioContext.destroy() 销毁当前实例 InnerAudioContext.offCanplay(function callback) 基础库 1.9.0 开始支持,低版本需做兼容处理。 取消监听音频进入可以播放状态的事件 参数 function callback 音频进入可以播放状态的事件的回调函数 InnerAudioContext.offEnded(function callback) 基础库 1.9.0 开始支持,低版本需做兼容处理。 取消监听音频自然播放至结束的事件 参数 function callback 音频自然播放至结束的事件的回调函数 InnerAudioContext.offError(function callback) 基础库 1.9.0 开始支持,低版本需做兼容处理。 取消监听音频播放错误事件 参数 function callback 音频播放错误事件的回调函数 InnerAudioContext.offPause(function callback) 基础库 1.9.0 开始支持,低版本需做兼容处理。 取消监听音频暂停事件 参数 function callback 音频暂停事件的回调函数 InnerAudioContext.offPlay(function callback) 基础库 1.9.0 开始支持,低版本需做兼容处理。 取消监听音频播放事件 参数 function callback 音频播放事件的回调函数 InnerAudioContext.offSeeked(function callback) 基础库 1.9.0 开始支持,低版本需做兼容处理。 取消监听音频完成跳转操作的事件 参数 function callback 音频完成跳转操作的事件的回调函数 InnerAudioContext.offSeeking(function callback)...