微信小程序开发文档微信小程序API 音频·InnerAudioContext对象

2024-02-25 开发教程微信小程序开发文档匿名 4℃

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)

基础库 1.9.0 开始支持，低版本需做兼容处理。

取消监听音频进行跳转操作的事件

参数

function callback

音频进行跳转操作的事件的回调函数

InnerAudioContext.offStop(function callback)

基础库 1.9.0 开始支持，低版本需做兼容处理。

取消监听音频停止事件

参数

function callback

音频停止事件的回调函数

InnerAudioContext.offTimeUpdate(function callback)

基础库 1.9.0 开始支持，低版本需做兼容处理。

取消监听音频播放进度更新事件

参数

function callback

音频播放进度更新事件的回调函数

InnerAudioContext.offWaiting(function callback)

基础库 1.9.0 开始支持，低版本需做兼容处理。

取消监听音频加载中事件

参数

function callback

音频加载中事件的回调函数

InnerAudioContext.onCanplay(function callback)

监听音频进入可以播放状态的事件。但不保证后面可以流畅播放

参数

function callback

音频进入可以播放状态的事件的回调函数

InnerAudioContext.onEnded(function callback)

监听音频自然播放至结束的事件

参数

function callback

音频自然播放至结束的事件的回调函数

InnerAudioContext.onError(function callback)

监听音频播放错误事件

参数

function callback

音频播放错误事件的回调函数

参数

Object res

属性	类型	说明
errMsg	string
errCode	number

errCode 的合法值

值	说明	最低版本
10001	系统错误
10002	网络错误
10003	文件错误
10004	格式错误
-1	未知错误

InnerAudioContext.onPause(function callback)

监听音频暂停事件

参数

function callback

音频暂停事件的回调函数

InnerAudioContext.onPlay(function callback)

监听音频播放事件

参数

function callback

音频播放事件的回调函数

InnerAudioContext.onSeeked(function callback)

监听音频完成跳转操作的事件

参数

function callback

音频完成跳转操作的事件的回调函数

InnerAudioContext.onSeeking(function callback)

监听音频进行跳转操作的事件

参数

function callback

音频进行跳转操作的事件的回调函数

InnerAudioContext.onStop(function callback)

监听音频停止事件

参数

function callback

音频停止事件的回调函数

InnerAudioContext.onTimeUpdate(function callback)

监听音频播放进度更新事件

参数

function callback

音频播放进度更新事件的回调函数

InnerAudioContext.onWaiting(function callback)

监听音频加载中事件。当音频因为数据不足，需要停下来加载时会触发

参数

function callback

音频加载中事件的回调函数

InnerAudioContext.pause()

暂停。暂停后的音频再播放会从暂停处开始播放

InnerAudioContext.play()

播放

InnerAudioContext.seek(number position)

跳转到指定位置

参数

number position

跳转的时间，单位 s。精确到小数点后 3 位，即支持 ms 级别精确度

InnerAudioContext.stop()

停止。停止后的音频再播放会从头开始播放。

支持格式

格式	iOS	Android
flac	x	√
m4a	√	√
ogg	x	√
ape	x	√
amr	x	√
wma	x	√
wav	√	√
mp3	√	√
mp4	x	√
aac	√	√
aiff	√	x
caf	√	x

示例代码：

const innerAudioContext = wx.createInnerAudioContext()
innerAudioContext.autoplay = true
innerAudioContext.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'
innerAudioContext.onPlay(() => {
  console.log('开始播放')
})
innerAudioContext.onError((res) => {
  console.log(res.errMsg)
  console.log(res.errCode)
})

上一节：微信小程序API 音频·创建AudioContext 对象。

下一节：微信小程序API 音频·AudioContext对象

"微信小程序开发文档"的目录

微信小程序开发文档 微信小程序API 音频·InnerAudioContext对象

InnerAudioContext

属性

string src

number startTime

boolean autoplay

boolean loop

boolean obeyMuteSwitch

number volume

number playbackRate

number duration

number currentTime

boolean paused

number buffered

方法：

InnerAudioContext.destroy()

InnerAudioContext.offCanplay(function callback)

参数

function callback

InnerAudioContext.offEnded(function callback)

参数

function callback

InnerAudioContext.offError(function callback)

参数

function callback

InnerAudioContext.offPause(function callback)

参数

function callback

InnerAudioContext.offPlay(function callback)

参数

function callback

InnerAudioContext.offSeeked(function callback)

参数

function callback

InnerAudioContext.offSeeking(function callback)

参数

function callback

InnerAudioContext.offStop(function callback)

参数

function callback

InnerAudioContext.offTimeUpdate(function callback)

参数

function callback

InnerAudioContext.offWaiting(function callback)

参数

function callback

InnerAudioContext.onCanplay(function callback)

参数

function callback

InnerAudioContext.onEnded(function callback)

参数

function callback

InnerAudioContext.onError(function callback)

参数

function callback

参数

Object res

InnerAudioContext.onPause(function callback)

参数

function callback

InnerAudioContext.onPlay(function callback)

参数

function callback

InnerAudioContext.onSeeked(function callback)

参数

function callback

InnerAudioContext.onSeeking(function callback)

参数

function callback

InnerAudioContext.onStop(function callback)

参数

function callback

InnerAudioContext.onTimeUpdate(function callback)

参数

function callback

InnerAudioContext.onWaiting(function callback)

参数

function callback

InnerAudioContext.pause()

微信小程序开发文档微信小程序API 音频·InnerAudioContext对象