BackgroundAudioManager
BackgroundAudioManager 实例,可通过 mc.getBackgroundAudioManager 获取。
属性
String src
音频的数据源,默认为空字符串,当设置了新的 src 时,会自动开始播放。
Number startTime
音频开始播放的位置(单位:s)。
String title
音频标题,用于原生音频播放器音频标题(必填)。原生音频播放器中的分享功能,分享出去的卡片标题,也将使用该值。
String epname
专辑名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。
String singer
歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。
String coverImgUrl
封面图 URL,用于做原生音频播放器背景图。
Number playbackRate
播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本)
Number duration
当前音频的长度(单位:s),只有在有合法 src 时返回。(只读)
Number currentTime
当前音频的播放位置(单位:s),只有在有合法 src 时返回。(只读)
Boolean paused
当前是否暂停或停止。(只读)
Number buffered
音频已缓冲的时间,仅保证当前播放时间点到此时间点内容已缓冲。(只读)
String referrerPolicy
origin
: 发送完整的referrer; no-referrer
: 不发送。
方法
BackgroundAudioManager.play()
播放音乐
BackgroundAudioManager.pause()
暂停音乐
BackgroundAudioManager.seek(Number currentTime)
跳转到指定位置
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
currentTime | Number | 是 | 跳转到的时间位置,单位 s |
BackgroundAudioManager.stop()
停止音乐
事件
BackgroundAudioManager.onCanplay(Function callback)
监听背景音频进入可播放状态事件。 但不保证后面可以流畅播放
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offCanplay(Function callback)
取消监听音频进入可以播放状态的事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onPlay(Function callback)
监听背景音频播放事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offPlay(Function callback)
取消监听音频播放事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onPause(Function callback)
监听背景音频暂停事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offPause(Function callback)
取消监听音频暂停事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onStop(Function callback)
监听背景音频停止事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offStop(Function callback)
取消监听音频停止事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onEnded(Function callback)
监听背景音频自然播放结束事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offEnded(Function callback)
取消监听音频自然播放至结束的事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onTimeUpdate(Function callback)
监听背景音频播放进度更新事件。
BackgroundAudioManager.onTimeUpdate.callback(Number time) | 参数 | 类型 | 说明 | | :-------------- | :----- | :-------------------- | | time | Number | 当前时间, 单位 s |
BackgroundAudioManager.offTimeUpdate(Function callback)
取消监听音频播放进度更新事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onError(Function callback)
监听背景音频播放错误事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.onError.callback(Object res) | 属性 | 类型 | 说明 | | :-------------- | :----- | :-------------------- | | errMsg | String | 错误信息 | | errCode | Number | 错误码 |
Object.errCode | 值 | 说明 | | :-------------- |:-------------------- | | 10001 | 系统错误 | | 10002 | 网络错误 | | 10003 | 文件错误 | | 10004 | 格式错误 | | -1 | 未知错误 |
BackgroundAudioManager.onWaiting(Function callback)
监听音频加载中事件。当音频因为数据不足,需要停下来加载时会触发
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offWaiting(Function callback)
取消监听音频自然播放至结束的事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onSeeking(Function callback)
监听背景音频开始跳转操作事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offSeeking(Function callback)
取消监听音频进行跳转操作的事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onSeeked(Function callback)
监听背景音频完成跳转操作事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offSeeked(Function callback)
取消监听音频完成跳转操作的事件
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onNext(Function callback)
监听用户在系统音乐播放面板点击下一曲事件(仅iOS)
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offNext(Function callback)
取消用户在系统音乐播放面板点击下一曲事件(仅iOS)
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |
BackgroundAudioManager.onPrev(Function callback)
监听用户在系统音乐播放面板点击上一曲事件(仅iOS)
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 监听回调函数 |
BackgroundAudioManager.offPrev(Function callback)
取消监听用户在系统音乐播放面板点击上一曲事件(仅iOS)
参数
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
callback | Function | 是 | 需要取消的监听回调函数 |