codecamp

使用AVPlayer开发音频播放功能

使用AVPlayer可以实现端到端播放原始媒体资源,本开发指导将以完整地播放一首音乐作为示例,向开发者讲解AVPlayer音频播放相关功能。

播放的全流程包含:创建AVPlayer,设置播放资源,设置播放参数(音量/倍速/焦点模式),播放控制(播放/暂停/跳转/停止),重置,销毁资源。

在进行应用开发的过程中,开发者可以通过AVPlayer的state属性主动获取当前状态或使用on('stateChange')方法监听状态变化。如果应用在音频播放器处于错误状态时执行操作,系统可能会抛出异常或生成其他未定义的行为。

图1 播放状态变化示意图

状态的详细说明请参考AVPlayerState。当播放处于prepared / playing / paused / completed状态时,播放引擎处于工作状态,这需要占用系统较多的运行内存。当客户端暂时不使用播放器时,调用reset()或release()回收内存资源,做好资源利用。

开发步骤及注意事项

详细的API说明请参考AVPlayer API参考

  1. 创建实例createAVPlayer(),AVPlayer初始化idle状态。
  2. 设置业务需要的监听事件,搭配全流程场景使用。支持的监听事件包括:

    事件类型

    说明

    stateChange

    必要事件,监听播放器的state属性改变。

    error

    必要事件,监听播放器的错误信息。

    durationUpdate

    用于进度条,监听进度条长度,刷新资源时长。

    timeUpdate

    用于进度条,监听进度条当前位置,刷新当前时间。

    seekDone

    响应API调用,监听seek()请求完成情况。

    当使用seek()跳转到指定播放位置后,如果seek操作成功,将上报该事件。

    speedDone

    响应API调用,监听setSpeed()请求完成情况。

    当使用setSpeed()设置播放倍速后,如果setSpeed操作成功,将上报该事件。

    volumeChange

    响应API调用,监听setVolume()请求完成情况。

    当使用setVolume()调节播放音量后,如果setVolume操作成功,将上报该事件。

    bufferingUpdate

    用于网络播放,监听网络播放缓冲信息,用于上报缓冲百分比以及缓存播放进度。

    audioInterrupt

    监听音频焦点切换信息,搭配属性audioInterruptMode使用。

    如果当前设备存在多个音频正在播放,音频焦点被切换(即播放其他媒体如通话等)时将上报该事件,应用可以及时处理。

  3. 设置资源:设置属性url,AVPlayer进入initialized状态。
    说明

    下面代码示例中的url仅作示意使用,开发者需根据实际情况,确认资源有效性并设置:

  4. 准备播放:调用prepare(),AVPlayer进入prepared状态,此时可以获取duration,设置音量。
  5. 音频播控:播放play(),暂停pause(),跳转seek(),停止stop() 等操作。
  6. (可选)更换资源:调用reset()重置资源,AVPlayer重新进入idle状态,允许更换资源url。
  7. 退出播放:调用release()销毁实例,AVPlayer进入released状态,退出播放。

完整示例

参考以下示例,完整地播放一首音乐。
  1. import media from '@ohos.multimedia.media';
  2. import fs from '@ohos.file.fs';
  3. import common from '@ohos.app.ability.common';
  4. export class AVPlayerDemo {
  5. private avPlayer;
  6. private count: number = 0;
  7. // 注册avplayer回调函数
  8. setAVPlayerCallback() {
  9. // seek操作结果回调函数
  10. this.avPlayer.on('seekDone', (seekDoneTime) => {
  11. console.info(`AVPlayer seek succeeded, seek time is ${seekDoneTime}`);
  12. })
  13. // error回调监听函数,当avPlayer在操作过程中出现错误时调用reset接口触发重置流程
  14. this.avPlayer.on('error', (err) => {
  15. console.error(`Invoke avPlayer failed, code is ${err.code}, message is ${err.message}`);
  16. this.avPlayer.reset(); // 调用reset重置资源,触发idle状态
  17. })
  18. // 状态机变化回调函数
  19. this.avPlayer.on('stateChange', async (state, reason) => {
  20. switch (state) {
  21. case 'idle': // 成功调用reset接口后触发该状态机上报
  22. console.info('AVPlayer state idle called.');
  23. this.avPlayer.release(); // 调用release接口销毁实例对象
  24. break;
  25. case 'initialized': // avplayer 设置播放源后触发该状态上报
  26. console.info('AVPlayerstate initialized called.');
  27. this.avPlayer.prepare().then(() => {
  28. console.info('AVPlayer prepare succeeded.');
  29. }, (err) => {
  30. console.error(`Invoke prepare failed, code is ${err.code}, message is ${err.message}`);
  31. });
  32. break;
  33. case 'prepared': // prepare调用成功后上报该状态机
  34. console.info('AVPlayer state prepared called.');
  35. this.avPlayer.play(); // 调用播放接口开始播放
  36. break;
  37. case 'playing': // play成功调用后触发该状态机上报
  38. console.info('AVPlayer state playing called.');
  39. if (this.count !== 0) {
  40. console.info('AVPlayer start to seek.');
  41. this.avPlayer.seek(this.avPlayer.duration); //seek到音频末尾
  42. } else {
  43. this.avPlayer.pause(); // 调用暂停接口暂停播放
  44. }
  45. this.count++;
  46. break;
  47. case 'paused': // pause成功调用后触发该状态机上报
  48. console.info('AVPlayer state paused called.');
  49. this.avPlayer.play(); // 再次播放接口开始播放
  50. break;
  51. case 'completed': // 播放结束后触发该状态机上报
  52. console.info('AVPlayer state completed called.');
  53. this.avPlayer.stop(); //调用播放结束接口
  54. break;
  55. case 'stopped': // stop接口成功调用后触发该状态机上报
  56. console.info('AVPlayer state stopped called.');
  57. this.avPlayer.reset(); // 调用reset接口初始化avplayer状态
  58. break;
  59. case 'released':
  60. console.info('AVPlayer state released called.');
  61. break;
  62. default:
  63. console.info('AVPlayer state unknown called.');
  64. break;
  65. }
  66. })
  67. }
  68. // 以下demo为使用fs文件系统打开沙箱地址获取媒体文件地址并通过url属性进行播放示例
  69. async avPlayerUrlDemo() {
  70. // 创建avPlayer实例对象
  71. this.avPlayer = await media.createAVPlayer();
  72. // 创建状态机变化回调函数
  73. this.setAVPlayerCallback();
  74. let fdPath = 'fd://';
  75. // 通过UIAbilityContext获取沙箱地址filesDir,以下为Stage模型获方式,如需在FA模型上获取请参考《访问应用沙箱》获取地址
  76. let context = getContext(this) as common.UIAbilityContext;
  77. let pathDir = context.filesDir;
  78. let path = pathDir + '/01.mp3';
  79. // 打开相应的资源文件地址获取fd,并为url赋值触发initialized状态机上报
  80. let file = await fs.open(path);
  81. fdPath = fdPath + '' + file.fd;
  82. this.avPlayer.url = fdPath;
  83. }
  84. // 以下demo为使用资源管理接口获取打包在HAP内的媒体资源文件并通过fdSrc属性进行播放示例
  85. async avPlayerFdSrcDemo() {
  86. // 创建avPlayer实例对象
  87. this.avPlayer = await media.createAVPlayer();
  88. // 创建状态机变化回调函数
  89. this.setAVPlayerCallback();
  90. // 通过UIAbilityContext的resourceManager成员的getRawFd接口获取媒体资源播放地址
  91. // 返回类型为{fd,offset,length},fd为HAP包fd地址,offset为媒体资源偏移量,length为播放长度
  92. let context = getContext(this) as common.UIAbilityContext;
  93. let fileDescriptor = await context.resourceManager.getRawFd('01.mp3');
  94. // 为fdSrc赋值触发initialized状态机上报
  95. this.avPlayer.fdSrc = fileDescriptor;
  96. this.isSeek = false; // 不支持seek操作
  97. }
  98. }
为通知添加行为意图
使用AudioRenderer开发音频播放功能
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录
HAR

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }