鸿蒙HarmonyOS实战开发：媒体开发＞基于SoundPool播放短音频 ...

  鸿蒙NEXT开发实战往期必看文章：
一分钟了解”纯血版！鸿蒙HarmonyOS Next应用开发！
“非常详细的” 鸿蒙HarmonyOS Next应用开发学习路线！（从零基础入门到醒目）
HarmonyOS NEXT应用开发案例实践总结合（持续更新......）
HarmonyOS NEXT应用开发性能优化实践总结（持续更新......）

---

使用SoundPool（音频池）提供的接口，可以实现低时延短音播放。
当应用开发时，常常需要使用一些急促简短的音效（如相机快门音效、系统通知音效等），此时发起调用SoundPool，实现一次加载，多次低时延播放。
SoundPool当前支持播放1MB以下的音频资源，大小超过1MB的长音频将截取1MB大小数据举行播放。
本开发引导将以SoundPool举行一次低时延播放音频的过程为例，向开发者讲授如何使用SoundPool。详细的API声明请参考SoundPool API参考。
过程包括：创建SoundPool实例，加载音频资源（包括资源的解封装与解码:解码格式参考音频解码支持），设置播放参数（循环模式/播放优先级等），播放控制（播放/停止），释放资源。
在应用开发过程中，开发者应通过监听方法查抄当前播放状态并按照一定顺序调用接口，执行对应操作，否则系统大概会抛出非常或天生其他未定义的行为。详细顺序可参考下列开发步调及对应阐明。
阐明
使用SoundPool播放短音频时，涉及音频核心管控计谋的题目，请参考音频核心指南。
开发步调及注意事项

• 调用createSoundPool方法创建SoundPool实例。
  
  1. import { media } from '@kit.MediaKit';
  2. import { audio } from '@kit.AudioKit';
  3. import { BusinessError } from '@kit.BasicServicesKit';
  5. let soundPool: media.SoundPool;
  6. // audioRenderInfo中的参数usage取值为STREAM_USAGE_UNKNOWN，STREAM_USAGE_MUSIC，STREAM_USAGE_MOVIE，
  7. // STREAM_USAGE_AUDIOBOOK时，SoundPool播放短音时为混音模式，不会打断其他音频播放。
  8. let audioRendererInfo: audio.AudioRendererInfo = {
  9.   usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  10.   rendererFlags : 0
  11. }
  13. media.createSoundPool(5, audioRendererInfo).then((soundpool_: media.SoundPool) => {
  14.   if (soundpool_ != null) {
  15.     soundPool = soundpool_;
  16.     console.info('create SoundPool success');
  17.   } else {
  18.     console.error('create SoundPool fail');
  19.   }
  20. }).catch((error: BusinessError) => {
  21.   console.error(`soundpool catchCallback, error message:${error.message}`);
  22. });

  复制代码
• 调用on('loadComplete')方法，用于监听“资源加载完成”。
  
  1. soundPool.on('loadComplete', (soundId: number) => {
  2.   console.info('loadComplete, soundId: ' + soundId);
  3. });

  复制代码
• 调用on('playFinished')方法，用于监听“播放完成”。
  
  1. soundPool.on('playFinished', () => {
  2.   console.info("receive play finished message");
  3. });

  复制代码
• 调用on('error')方法，设置错误类型监听。
  
  1. soundPool.on('error', (error: BusinessError) => {
  2.   console.info('error happened,message is :' + error.message);
  3. });

  复制代码
• 调用load方法举行音频资源加载。
  可以传入uri或fd加载资源，此处使用传入uri的方式为例，更多方法请参考API文档。
  当系统加载完毕音频资源文件的时候，会通过loadComplete回调，通知用户资源加载完成，请在收到回调之后，再举行后续的play操作。
  
  1. import { BusinessError } from '@kit.BasicServicesKit';
  2. import { fileIo as fs } from '@kit.CoreFileKit';
  4. let soundID: number;
  5. let uri: string;
  6. async function load() {
  7.   await fs.open('/test_01.mp3', fs.OpenMode.READ_ONLY).then((file: fs.File) => {
  8.     console.info("file fd: " + file.fd);
  9.     uri = 'fd://' + (file.fd).toString()
  10.   }); // '/test_01.mp3' 作为样例，使用时需要传入文件对应路径。
  11.   soundPool.load(uri).then((soundId: number) => {
  12.     console.info('soundPool load uri success');
  13.     soundID = soundId;
  14.   }).catch((err: BusinessError) => {
  15.     console.error('soundPool load failed and catch error is ' + err.message);
  16.   })
  17. }

  复制代码
• 设置播放参数PlayParameters，并在收到loadComplete回调通知之后，调用play方法播放音频。多次调用play播放同一个soundID，只会播放一次。
  
  1. let soundID: number;
  2. let streamID: number;
  3. let playParameters: media.PlayParameters = {
  4.     loop: 0, // 循环0次
  5.     rate: 2, // 2倍速
  6.     leftVolume: 0.5, // range = 0.0-1.0
  7.     rightVolume: 0.5, // range = 0.0-1.0
  8.     priority: 0, // 最低优先级
  9.   }
  10. soundPool.play(soundID, playParameters, (error: BusinessError, streamId: number) => {
  11.   if (error) {
  12.     console.info(`play sound Error: errCode is ${error.code}, errMessage is ${error.message}`)
  13.   } else {
  14.     streamID = streamId;
  15.     console.info('play success soundid:' + streamId);
  16.   }
  17. });

  复制代码
• 调用setLoop方法设置循环次数。
  
  1. import { BusinessError } from '@kit.BasicServicesKit';
  3. let streamID: number;
  4. soundPool.setLoop(streamID, 1).then(() => {
  5.   console.info('setLoop success streamID:' + streamID);
  6. }).catch((err: BusinessError) => {
  7.   console.error('soundpool setLoop failed and catch error is ' + err.message);
  8. });

  复制代码
• 调用setPriority方法设置优先级。
  
  1. let streamID: number;
  2. soundPool.setPriority(streamID, 1);

  复制代码
• 调用setVolume方法设置音量。
  
  1. import { BusinessError } from '@kit.BasicServicesKit';
  3. let streamID: number;
  4. // 先调用play方法获取到对应资源的streamID
  6. soundPool.setVolume(streamID, 0.5, 0.5).then(() => {
  7.   console.info('setVolume success');
  8. }).catch((err: BusinessError) => {
  9.   console.error('soundpool setVolume failed and catch error is ' + err.message);
  10. });

  复制代码
• 调用stop方法停止指定流的播放。
  
  1. import { BusinessError } from '@kit.BasicServicesKit';
  3. let streamID: number;
  4. //先调用play方法给拿到对应的streamID
  6. soundPool.stop(streamID).then(() => {
  7.   console.info('stop success');
  8. }).catch((err: BusinessError) => {
  9.   console.error('soundpool load stop and catch error is ' + err.message);
  10. });

  复制代码
• 调用unload方法卸载音频资源。
  
  1. import { BusinessError } from '@kit.BasicServicesKit';
  3. let soundID: number;
  4. // 先调用load方法获取到对应资源的soundID
  6. soundPool.unload(soundID).then(() => {
  7.   console.info('unload success');
  8. }).catch((err: BusinessError) => {
  9.   console.error('soundpool unload failed and catch error is ' + err.message);
  10. });

  复制代码
• 调用off('loadComplete')方法注销加载完成监听。
  
  1. soundPool.off('loadComplete');

  复制代码
• 调用off('playFinished')方法注销播放完成监听。
  
  1. soundPool.off('playFinished');

  复制代码
• 调用off('error')方法注销错误错误类型监听。
  
  1. soundPool.off('error');

  复制代码
• 调用release方法释放SoundPool实例。
  
  1. import { BusinessError } from '@kit.BasicServicesKit';
  3. soundPool.release().then(() => {
  4.   console.info('release success');
  5. }).catch((err: BusinessError) => {
  6.   console.error('soundpool release failed and catch error is ' + err.message);
  7. });

  复制代码

完整示例

下面展示了使用SoundPool举行低时延播放的完整示例代码。

1. import { audio } from '@kit.AudioKit';
2. import { media } from '@kit.MediaKit';
3. import { fileIo as fs } from '@kit.CoreFileKit';
4. import { BusinessError } from '@kit.BasicServicesKit';
6. let soundPool: media.SoundPool;
7. let streamId: number = 0;
8. let soundId: number = 0;
9. // audioRenderInfo中的参数usage取值为STREAM_USAGE_UNKNOWN，STREAM_USAGE_MUSIC，STREAM_USAGE_MOVIE，
10. // STREAM_USAGE_AUDIOBOOK时，SoundPool播放短音时为混音模式，不会打断其他音频播放。
11. let audioRendererInfo: audio.AudioRendererInfo = {
12.   usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
13.   rendererFlags: 1
14. }
15. let playParameters: media.PlayParameters = {
16.   loop: 3, // 循环4次
17.   rate: audio.AudioRendererRate.RENDER_RATE_NORMAL, // 正常倍速
18.   leftVolume: 0.5, // range = 0.0-1.0
19.   rightVolume: 0.5, // range = 0.0-1.0
20.   priority: 0, // 最低优先级
21. }
22. let uri: string = "";
23. async function create() {
24.   //创建soundPool实例
25.   soundPool = await media.createSoundPool(5, audioRendererInfo);
26.   //注册监听
27.   loadCallback();
28.   finishPlayCallback();
29.   setErrorCallback();
30.   // 加载音频资源
31.   await fs.open('/test_01.mp3', fs.OpenMode.READ_ONLY).then((file: fs.File) => {
32.     console.info("file fd: " + file.fd);
33.     uri = 'fd://' + (file.fd).toString()
34.   }); // '/test_01.mp3' 作为样例，使用时需要传入文件对应路径。
35.   soundId = await soundPool.load(uri);
36. }
37. function loadCallback() {
38.   // 加载完成回调
39.   soundPool.on('loadComplete', (soundId_: number) => {
40.     console.info('loadComplete, soundId: ' + soundId_);
41.   })
42. }
43. //设置播放完成监听
44. function finishPlayCallback() {
45.   // 播放完成回调
46.   soundPool.on('playFinished', () => {
47.     console.info("receive play finished message");
48.     // 可进行下次播放
49.   })
50. }
51. //设置错误类型监听
52. function setErrorCallback() {
53.   soundPool.on('error', (error: BusinessError) => {
54.     console.info('error happened,message is :' + error.message);
55.   })
56. }
57. async function PlaySoundPool() {
58.   // 开始播放，这边play也可带播放播放的参数PlayParameters，请在音频资源加载完毕，即收到loadComplete回调之后再执行play操作
59.   soundPool.play(soundId, playParameters, (error, streamID: number) => {
60.     if (error) {
61.       console.info(`play sound Error: errCode is ${error.code}, errMessage is ${error.message}`)
62.     } else {
63.       streamId = streamID;
64.       console.info('play success soundid:' + streamId);
65.     }
66.   });
67.   // 设置循环播放次数
68.   await soundPool.setLoop(streamId, 2); // 播放3次
69.   // 设置对应流的优先级
70.   await soundPool.setPriority(streamId, 1);
71.   // 设置音量
72.   await soundPool.setVolume(streamId, 0.5, 0.5);
73. }
74. async function release() {
75.   // 终止指定流的播放
76.   await soundPool.stop(streamId);
77.   // 卸载音频资源
78.   await soundPool.unload(soundId);
79.   //关闭监听
80.   setOffCallback();
81.   // 释放SoundPool
82.   await soundPool.release();
83. }
84. //关闭监听
85. function setOffCallback() {
86.   soundPool.off('loadComplete');
87.   soundPool.off('playFinished');
88.   soundPool.off('error');
89. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。