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