• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 音频播放流管理
2
3对于播放音频类的应用，开发者需要关注该应用的音频流的状态以做出相应的操作，比如监听到状态为播放中/暂停时，及时改变播放按钮的UI显示。
4
5## 读取或监听应用内音频流状态变化
6
7参考[使用AudioRenderer开发音频播放功能](using-audiorenderer-for-playback.md)或[audio.createAudioRenderer](../reference/apis/js-apis-audio.md#audiocreateaudiorenderer8)，完成AudioRenderer的创建，然后可以通过以下两种方式查看音频流状态的变化：
8
9- 方法1：直接查看AudioRenderer的[state](../reference/apis/js-apis-audio.md#属性)：
10
11  ```ts
12  let audioRendererState = audioRenderer.state;
13  console.info(`Current state is: ${audioRendererState }`)
14  ```
15
16- 方法2：注册stateChange监听AudioRenderer的状态变化：
17
18  ```ts
19  audioRenderer.on('stateChange', (rendererState) => {
20    console.info(`State change to: ${rendererState}`)
21  });
22  ```
23
24获取state后可对照[AudioState](../reference/apis/js-apis-audio.md#audiostate8)来进行相应的操作，比如更改暂停播放按钮的显示等。
25
26## 读取或监听所有音频流的变化
27
28如果部分应用需要查询获取所有音频流的变化信息，可以通过AudioStreamManager读取或监听所有音频流的变化。
29
30> **说明：**
31>
32> 对于标记为系统接口（system api）的音频流变化信息需要系统级别应用才可查看，若应用不是系统应用，将无法获取准确信息。
33
34如下为音频流管理调用关系图：
35
36![Audio stream management invoking relationship](figures/audio-stream-mgmt-invoking-relationship.png)
37
38在进行应用开发的过程中，开发者需要使用getStreamManager()创建一个AudioStreamManager实例，进而通过该实例管理音频流。开发者可通过调用on('audioRendererChange')监听音频流的变化，在音频流状态变化、设备变化时获得通知。同时可通过off('audioRendererChange')取消相关事件的监听。另外，开发者可以主动调用getCurrentAudioRendererInfoArray()来查询播放流的唯一ID、播放流客户端的UID、音频流状态等信息。
39
40详细API含义可参考[音频管理API文档AudioStreamManager](../reference/apis/js-apis-audio.md#audiostreammanager9)。
41
42## 开发步骤及注意事项
43
441. 创建AudioStreamManager实例。
45   在使用AudioStreamManager的API前，需要使用getStreamManager()创建一个AudioStreamManager实例。
46
47   ```ts
48   import audio from '@ohos.multimedia.audio';
49   let audioManager = audio.getAudioManager();
50   let audioStreamManager = audioManager.getStreamManager();
51   ```
52
532. 使用on('audioRendererChange')监听音频播放流的变化。 如果音频流监听应用需要在音频播放流状态变化、设备变化时获取通知，可以订阅该事件。
54
55   ```ts
56   audioStreamManager.on('audioRendererChange',  (AudioRendererChangeInfoArray) => {
57     for (let i = 0; i < AudioRendererChangeInfoArray.length; i++) {
58       let AudioRendererChangeInfo = AudioRendererChangeInfoArray[i];
59       console.info(`## RendererChange on is called for ${i} ##`);
60       console.info(`StreamId for ${i} is: ${AudioRendererChangeInfo.streamId}`);
61       console.info(`Content ${i} is: ${AudioRendererChangeInfo.rendererInfo.content}`);
62       console.info(`Stream ${i} is: ${AudioRendererChangeInfo.rendererInfo.usage}`);
63       console.info(`Flag ${i} is: ${AudioRendererChangeInfo.rendererInfo.rendererFlags}`);
64       for (let j = 0;j < AudioRendererChangeInfo.deviceDescriptors.length; j++) {
65         console.info(`Id: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].id}`);
66         console.info(`Type: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceType}`);
67         console.info(`Role: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceRole}`);
68         console.info(`Name: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].name}`);
69         console.info(`Address: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].address}`);
70         console.info(`SampleRates: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]}`);
71         console.info(`ChannelCount ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]}`);
72         console.info(`ChannelMask: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelMasks}`);
73       }
74     }
75   });
76   ```
77
783. （可选）使用off('audioRendererChange')取消监听音频播放流变化。
79
80   ```ts
81   audioStreamManager.off('audioRendererChange');
82   console.info('RendererChange Off is called ');
83   ```
84
854. （可选）使用getCurrentAudioRendererInfoArray()获取所有音频播放流的信息。
86     该接口可获取音频播放流唯一ID，音频播放客户端的UID，音频状态以及音频播放器的其他信息。
87   > **说明：**
88   >
89   > 对所有音频流状态进行监听的应用需要[申请权限](../security/accesstoken-guidelines.md)ohos.permission.USE_BLUETOOTH，否则无法获得实际的设备名称和设备地址信息，查询到的设备名称和设备地址（蓝牙设备的相关属性）将为空字符串。
90
91   ```ts
92   async function getCurrentAudioRendererInfoArray(){
93     await audioStreamManager.getCurrentAudioRendererInfoArray().then( function (AudioRendererChangeInfoArray) {
94       console.info(`getCurrentAudioRendererInfoArray  Get Promise is called `);
95       if (AudioRendererChangeInfoArray != null) {
96         for (let i = 0; i < AudioRendererChangeInfoArray.length; i++) {
97           let AudioRendererChangeInfo = AudioRendererChangeInfoArray[i];
98           console.info(`StreamId for ${i} is: ${AudioRendererChangeInfo.streamId}`);
99           console.info(`Content ${i} is: ${AudioRendererChangeInfo.rendererInfo.content}`);
100           console.info(`Stream ${i} is: ${AudioRendererChangeInfo.rendererInfo.usage}`);
101           console.info(`Flag ${i} is: ${AudioRendererChangeInfo.rendererInfo.rendererFlags}`);
102           for (let j = 0;j < AudioRendererChangeInfo.deviceDescriptors.length; j++) {
103             console.info(`Id: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].id}`);
104             console.info(`Type: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceType}`);
105             console.info(`Role: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceRole}`);
106             console.info(`Name: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].name}`);
107             console.info(`Address: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].address}`);
108             console.info(`SampleRates: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]}`);
109             console.info(`ChannelCount ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]}`);
110             console.info(`ChannelMask: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelMasks}`);
111           }
112         }
113       }
114     }).catch((err) => {
115       console.error(`Invoke getCurrentAudioRendererInfoArray failed, code is ${err.code}, message is ${err.message}`);
116     });
117   }
118   ```
119