背景音频管理器对象。
起始版本: 1.0.9
属性:
| 属性名 | 类型 | 默认值 | 必填 | 只读 | 描述 |
|---|---|---|---|---|---|
| src | string | - | 是 | 否 | 音频源地址。当设置了新的src时,会自动开始播放。 目前支持的格式有m4a、aac、mp3、ogg、wav、flac、amr,支持网络音频链接和本地音频文件路径(internal://开头)。 |
| startTime | number | 0 | 否 | 否 | 音频开始播放的位置,单位:s。 |
| title | string | 元服务名称 | 否 | 否 | 音频标题,用于系统音频播放器的标题,默认为元服务名称。 |
| epname | string | '' | 否 | 否 | 专辑名,用于系统音频播放器的副标题(歌手名为空时,才使用专辑名做副标题)。 |
| singer | string | '' | 否 | 否 | 歌手名,用于系统音频播放器的副标题。 |
| coverImgUrl | string | 元服务图标 | 否 | 否 | 封面图URL,用于系统音频播放器的背景图,默认为元服务图标。 |
| webUrl | string | '' | 否 | 否 | 页面链接。 |
| protocol | string | http | 否 | 否 | 音频协议。默认值为http,设置HLS可以支持播放HLS协议的直播音频。 |
| playbackRate | number | 1 | 否 | 否 | 播放速度。支持的播放速度有:0.125、0.25、0.5、0.75、1、1.25、1.5、1.75、2。 |
| duration | number | - | 否 | 是 | 当前音频总时长,单位:秒。 |
| currentTime | number | - | 否 | 是 | 当前音频的播放位置,单位:s。 |
| paused | boolean | - | 否 | 是 | 当前音频是否暂停或停止。 |
| buffered | number | - | 否 | 是 | 当前音频已缓冲的时长,单位:s。 |
BackgroundAudioManager.play(): void
播放音乐。
起始版本: 1.0.9
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 101 | AVPlayer is not initialized. |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.title = '标题'; backgroundAudioManager.src = 'https://www.example.com/test.mp3'; // 此处仅为样例,请开发者更换为可用的网址 backgroundAudioManager.play();
BackgroundAudioManager.pause(): void
暂停音乐。
起始版本: 1.0.9
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 101 | AVPlayer is not initialized. |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.title = '标题'; backgroundAudioManager.src = 'https://www.example.com/test.mp3'; // 此处仅为样例,请开发者更换为可用的网址 backgroundAudioManager.pause();
BackgroundAudioManager.seek(number currentTime): void
跳转到指定位置。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| currentTime | number | 是 | 跳转的位置,单位:s。精确到小数点后3位,支持ms级别精确度。 |
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 101 | AVPlayer is not initialized. |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.title = '标题'; backgroundAudioManager.src = 'https://www.example.com/test.mp3'; // 此处仅为样例,请开发者更换为可用的网址 backgroundAudioManager.seek(10.5);
BackgroundAudioManager.stop(): void
停止音乐。
起始版本: 1.0.9
错误码信息:
| 错误码 | 错误信息 |
|---|---|
| 101 | AVPlayer is not initialized. |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.title = '标题'; backgroundAudioManager.src = 'https://www.example.com/test.mp3'; // 此处仅为样例,请开发者更换为可用的网址 backgroundAudioManager.stop();
BackgroundAudioManager.onPlay(function callback)
监听背景音频播放事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频播放事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onPlay(() => {
console.info('BackgroundAudioManager onPlay callback triggered');
}); BackgroundAudioManager.offPlay(function callback)
取消监听背景音频播放事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onPlay传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offPlay();
BackgroundAudioManager.onPause(function callback)
监听背景音频暂停事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频暂停事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onPause(() => {
console.info('BackgroundAudioManager onPause callback triggered');
}); BackgroundAudioManager.offPause(function callback)
取消监听背景音频暂停事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onPause传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offPause();
BackgroundAudioManager.onSeeking(function callback)
监听背景音频开始跳转操作事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频开始跳转操作事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onSeeking(() => {
console.info('BackgroundAudioManager onSeeking callback triggered');
}); BackgroundAudioManager.offSeeking(function callback)
取消监听背景音频开始跳转操作事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onSeeking传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offSeeking();
BackgroundAudioManager.onSeeked(function callback)
监听背景音频完成跳转操作事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频完成跳转操作事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onSeeked(() => {
console.info('BackgroundAudioManager onSeeked callback triggered');
}); BackgroundAudioManager.offSeeked(function callback)
取消监听背景音频完成跳转操作事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onSeeked传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offSeeked();
BackgroundAudioManager.onEnded(function callback)
监听背景音频自然播放结束事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频自然播放结束事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onEnded(() => {
console.info('BackgroundAudioManager onEnded callback triggered');
}); BackgroundAudioManager.offEnded(function callback)
取消监听背景音频自然播放结束事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onEnded传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offEnded();
BackgroundAudioManager.onStop(function callback)
监听背景音频停止事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频停止事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onStop(() => {
console.info('BackgroundAudioManager onStop callback triggered');
}); BackgroundAudioManager.offStop(function callback)
取消监听背景音频停止事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onStop传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offStop();
BackgroundAudioManager.onTimeUpdate(function callback)
监听背景音频播放进度更新事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频播放进度更新事件的监听函数。 |
callback返回值:
返回number,代表当前背景音频播放的位置,单位秒,精确到小数点后3位。
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onTimeUpdate((currentTime) => {
console.info('BackgroundAudioManager onTimeUpdate callback triggered', currentTime);
}); BackgroundAudioManager.offTimeUpdate(function callback)
取消监听背景音频播放进度更新事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onTimeUpdate传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offTimeUpdate();
BackgroundAudioManager.onError(function callback)
监听背景音频播放错误事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频播放错误事件的监听函数。 |
callback返回值:
| 参数 | 类型 | 描述 |
|---|---|---|
| errCode | number | 错误码。 |
| errMsg | string | 错误信息。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onError((err) => {
console.error('BackgroundAudioManager onError callback triggered', err);
}); BackgroundAudioManager.offError(function callback)
取消监听背景音频播放错误事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onError传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offError();
BackgroundAudioManager.onCanplay(function callback)
监听背景音频进入可播放状态事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 背景音频进入可播放状态事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onCanplay(() => {
console.info('BackgroundAudioManager onCanplay callback triggered');
}); BackgroundAudioManager.offCanplay(function callback)
取消监听背景音频进入可播放状态事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onCanplay传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offCanplay();
BackgroundAudioManager.onPrev(function callback)
监听用户在系统音乐播放面板点击上一曲事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 用户在系统音乐播放面板点击上一曲事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onPrev(() => {
console.info('BackgroundAudioManager onPrev callback triggered');
}); BackgroundAudioManager.offPrev(function callback)
取消监听用户在系统音乐播放面板点击上一曲事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onPrev传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offPrev();
BackgroundAudioManager.onNext(function callback)
监听用户在系统音乐播放面板点击下一曲事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 是 | 用户在系统音乐播放面板点击下一曲事件的监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager();
backgroundAudioManager.onNext(() => {
console.info('BackgroundAudioManager onNext callback triggered');
}); BackgroundAudioManager.offNext(function callback)
取消监听用户在系统音乐播放面板点击下一曲事件。
起始版本: 1.0.9
参数:
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| callback | function | 否 | BackgroundAudioManager.onNext传入的监听函数,不传此参数则移除所有监听函数。 |
示例:
const backgroundAudioManager = has.getBackgroundAudioManager(); backgroundAudioManager.offNext();