• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Enums
2<!--Kit: Audio Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @songshenke-->
5<!--Designer: @caixuejiang; @hao-liangfei; @zhanganxiang-->
6<!--Tester: @Filger-->
7<!--Adviser: @zengyawen-->
8
9> **说明:**
10>
11> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12
13## AudioVolumeType
14
15表示音频流类型的枚举。
16
17**系统能力:** SystemCapability.Multimedia.Audio.Volume
18
19| 名称                         | 值      | 说明       |
20| ---------------------------- | ------ | ---------- |
21| VOICE_CALL<sup>8+</sup>      | 0      | 语音电话。 |
22| RINGTONE                     | 2      | 铃声。     |
23| MEDIA                        | 3      | 媒体。     |
24| ALARM<sup>10+</sup>          | 4      | 闹钟。     |
25| ACCESSIBILITY<sup>10+</sup>  | 5      | 无障碍。   |
26| VOICE_ASSISTANT<sup>8+</sup> | 9      | 语音助手。 |
27
28## InterruptMode<sup>9+</sup>
29
30表示焦点模型的枚举。
31
32**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
33
34**系统能力:** SystemCapability.Multimedia.Audio.Interrupt
35
36| 名称                         | 值      | 说明       |
37| ---------------------------- | ------ | ---------- |
38| SHARE_MODE                   | 0      | 共享焦点模式。 |
39| INDEPENDENT_MODE             | 1      | 独立焦点模式。 |
40
41## DeviceFlag
42
43表示音频设备类型的枚举。
44
45**系统能力:** SystemCapability.Multimedia.Audio.Device
46
47| 名称                            |  值     | 说明                        |
48| ------------------------------- | ------ |---------------------------|
49| OUTPUT_DEVICES_FLAG             | 1      | 输出设备。                     |
50| INPUT_DEVICES_FLAG              | 2      | 输入设备。                     |
51| ALL_DEVICES_FLAG                | 3      | 所有设备。                     |
52
53## DeviceUsage<sup>12+</sup>
54
55表示音频设备类型的枚举(根据用途分类)。
56
57**系统能力:** SystemCapability.Multimedia.Audio.Device
58
59| 名称                            |  值     | 说明                        |
60| ------------------------------- | ------ |---------------------------|
61| MEDIA_OUTPUT_DEVICES | 1      | 媒体输出设备。|
62| MEDIA_INPUT_DEVICES  | 2      | 媒体输入设备。|
63| ALL_MEDIA_DEVICES    | 3      | 所有媒体设备。|
64| CALL_OUTPUT_DEVICES  | 4      | 通话输出设备。|
65| CALL_INPUT_DEVICES   | 8      | 通话输入设备。|
66| ALL_CALL_DEVICES     | 12     | 所有通话设备。|
67
68## DeviceRole
69
70表示设备角色的枚举。
71
72**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
73
74**系统能力:** SystemCapability.Multimedia.Audio.Device
75
76| 名称          |  值    | 说明           |
77| ------------- | ------ | -------------- |
78| INPUT_DEVICE  | 1      | 输入设备角色。 |
79| OUTPUT_DEVICE | 2      | 输出设备角色。 |
80
81## DeviceType
82
83表示设备类型的枚举。
84
85**系统能力:** SystemCapability.Multimedia.Audio.Device
86
87| 名称                 | 值     | 说明                                                      |
88| ---------------------| ------ | --------------------------------------------------------- |
89| INVALID              | 0      | 无效设备。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
90| EARPIECE             | 1      | 听筒。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
91| SPEAKER              | 2      | 扬声器。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
92| WIRED_HEADSET        | 3      | 有线耳机,带麦克风。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
93| WIRED_HEADPHONES     | 4      | 有线耳机,不带麦克风。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
94| BLUETOOTH_SCO        | 7      | 蓝牙设备SCO(Synchronous Connection Oriented)连接。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
95| BLUETOOTH_A2DP       | 8      | 蓝牙设备A2DP(Advanced Audio Distribution Profile)连接。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
96| MIC                  | 15     | 麦克风。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
97| USB_HEADSET          | 22     | USB耳机,带麦克风。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
98| DISPLAY_PORT<sup>12+</sup>        | 23     | DisplayPort(显示接口,简称DP),用于外接扩展设备。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
99| REMOTE_CAST<sup>12+</sup>        | 24     | 音频被系统应用投送到其他的远程设备。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
100| USB_DEVICE<sup>18+</sup>        | 25 | USB设备(不包含USB耳机)。           |
101| HDMI<sup>19+</sup>        | 27 | HDMI设备(例如HDMI、ARC、eARC等)。           |
102| LINE_DIGITAL<sup>19+</sup>        | 28 | 有线数字设备(例如S/PDIF等)。           |
103| REMOTE_DAUDIO<sup>18+</sup>        | 29 | 分布式设备。<br/>**原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。 |
104| HEARING_AID<sup>20+</sup>        | 30 | 助听器设备。 |
105| NEARLINK<sup>20+</sup>        | 31 | 星闪设备。 |
106| DEFAULT<sup>9+</sup> | 1000   | 默认设备类型。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
107
108## CommunicationDeviceType<sup>9+</sup>
109
110表示用于通信的可用设备类型的枚举。
111
112**系统能力:** SystemCapability.Multimedia.Audio.Communication
113
114| 名称          | 值     | 说明          |
115| ------------- | ------ | -------------|
116| SPEAKER       | 2      | 扬声器。      |
117
118## AudioRingMode
119
120表示铃声模式的枚举。
121
122**系统能力:** SystemCapability.Multimedia.Audio.Communication
123
124| 名称                |  值    | 说明       |
125| ------------------- | ------ | ---------- |
126| RINGER_MODE_SILENT  | 0      | 静音模式。 |
127| RINGER_MODE_VIBRATE | 1      | 震动模式。 |
128| RINGER_MODE_NORMAL  | 2      | 响铃模式。 |
129
130## AudioSampleFormat<sup>8+</sup>
131
132表示音频采样格式的枚举。
133
134**系统能力:** SystemCapability.Multimedia.Audio.Core
135
136| 名称                                |  值    | 说明                       |
137| ---------------------------------- | ------ | -------------------------- |
138| SAMPLE_FORMAT_INVALID              | -1     | 无效格式。                 |
139| SAMPLE_FORMAT_U8                   | 0      | 无符号8位整数。            |
140| SAMPLE_FORMAT_S16LE                | 1      | 带符号的16位整数,小尾数。 |
141| SAMPLE_FORMAT_S24LE                | 2      | 带符号的24位整数,小尾数。 <br>由于系统限制,该采样格式仅部分设备支持,请根据实际情况使用。|
142| SAMPLE_FORMAT_S32LE                | 3      | 带符号的32位整数,小尾数。 <br>由于系统限制,该采样格式仅部分设备支持,请根据实际情况使用。|
143| SAMPLE_FORMAT_F32LE<sup>9+</sup>   | 4      | 带符号的32位浮点数,小尾数。 <br>由于系统限制,该采样格式仅部分设备支持,请根据实际情况使用。|
144
145## AudioErrors<sup>9+</sup>
146
147表示音频错误码的枚举。
148
149**系统能力:** SystemCapability.Multimedia.Audio.Core
150
151| 名称                 | 值      | 说明         |
152| ---------------------| --------| ----------------- |
153| ERROR_INVALID_PARAM  | 6800101 | 无效入参。         |
154| ERROR_NO_MEMORY      | 6800102 | 分配内存失败。     |
155| ERROR_ILLEGAL_STATE  | 6800103 | 状态不支持。       |
156| ERROR_UNSUPPORTED    | 6800104 | 参数选项不支持。    |
157| ERROR_TIMEOUT        | 6800105 | 处理超时。         |
158| ERROR_STREAM_LIMIT   | 6800201 | 音频流数量达到限制。|
159| ERROR_SYSTEM         | 6800301 | 系统处理异常。     |
160
161## AudioChannel<sup>8+</sup>
162
163表示音频声道的枚举。
164
165**系统能力:** SystemCapability.Multimedia.Audio.Core
166
167| 名称      |  值       | 说明   |
168| --------- | -------- |------|
169| CHANNEL_1 | 1 | 单声道。 |
170| CHANNEL_2 | 2 | 双声道。 |
171| CHANNEL_3<sup>11+</sup> | 3 | 三声道。 |
172| CHANNEL_4<sup>11+</sup> | 4 | 四声道。 |
173| CHANNEL_5<sup>11+</sup> | 5 | 五声道。 |
174| CHANNEL_6<sup>11+</sup> | 6 | 六声道。 |
175| CHANNEL_7<sup>11+</sup> | 7 | 七声道。 |
176| CHANNEL_8<sup>11+</sup> | 8 | 八声道。 |
177| CHANNEL_9<sup>11+</sup> | 9 | 九声道。 |
178| CHANNEL_10<sup>11+</sup> | 10 | 十声道。 |
179| CHANNEL_12<sup>11+</sup> | 12 | 十二声道。 |
180| CHANNEL_14<sup>11+</sup> | 14 | 十四声道。 |
181| CHANNEL_16<sup>11+</sup> | 16 | 十六声道。 |
182
183## AudioSamplingRate<sup>8+</sup>
184
185表示音频采样率的枚举(具体设备支持的采样率规格会存在差异)。
186
187**系统能力:** SystemCapability.Multimedia.Audio.Core
188
189| 名称              |  值    | 说明            |
190| ----------------- | ------ | --------------- |
191| SAMPLE_RATE_8000  | 8000   | 采样率为8000。  |
192| SAMPLE_RATE_11025 | 11025  | 采样率为11025。 |
193| SAMPLE_RATE_12000 | 12000  | 采样率为12000。 |
194| SAMPLE_RATE_16000 | 16000  | 采样率为16000。 |
195| SAMPLE_RATE_22050 | 22050  | 采样率为22050。 |
196| SAMPLE_RATE_24000 | 24000  | 采样率为24000。 |
197| SAMPLE_RATE_32000 | 32000  | 采样率为32000。 |
198| SAMPLE_RATE_44100 | 44100  | 采样率为44100。 |
199| SAMPLE_RATE_48000 | 48000  | 采样率为48000。 |
200| SAMPLE_RATE_64000 | 64000  | 采样率为64000。 |
201| SAMPLE_RATE_88200<sup>12+</sup> | 88200  | 采样率为88200。 |
202| SAMPLE_RATE_96000 | 96000  | 采样率为96000。 |
203| SAMPLE_RATE_176400<sup>12+</sup> | 176400  | 采样率为176400。 |
204| SAMPLE_RATE_192000<sup>12+</sup> | 192000  | 采样率为192000。 |
205
206## AudioEncodingType<sup>8+</sup>
207
208表示音频编码类型的枚举。
209
210**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
211
212**系统能力:** SystemCapability.Multimedia.Audio.Core
213
214| 名称                  |  值    | 说明      |
215| --------------------- | ------ | --------- |
216| ENCODING_TYPE_INVALID | -1     | 无效。    |
217| ENCODING_TYPE_RAW     | 0      | PCM编码。 |
218
219## AudioChannelLayout<sup>11+</sup>
220
221表示音频文件声道布局类型的枚举。
222
223**系统能力:** SystemCapability.Multimedia.Audio.Core
224
225| 名称                            |  值              | 说明                                          |
226| ------------------------------ | ---------------- | --------------------------------------------- |
227| CH_LAYOUT_UNKNOWN              | 0x0              | 未知声道布局。                                 |
228| CH_LAYOUT_MONO                 | 0x4              | 声道布局为MONO。                               |
229| CH_LAYOUT_STEREO               | 0x3              | 声道布局为STEREO。                             |
230| CH_LAYOUT_STEREO_DOWNMIX       | 0x60000000       | 声道布局为STEREO-DOWNMIX。                     |
231| CH_LAYOUT_2POINT1              | 0xB              | 声道布局为2.1。                                |
232| CH_LAYOUT_3POINT0              | 0x103            | 声道布局为3.0。                                |
233| CH_LAYOUT_SURROUND             | 0x7              | 声道布局为SURROUND。                           |
234| CH_LAYOUT_3POINT1              | 0xF              | 声道布局为3.1。                                |
235| CH_LAYOUT_4POINT0              | 0x107            | 声道布局为4.0。                                |
236| CH_LAYOUT_QUAD                 | 0x33             | 声道布局为QUAD。                               |
237| CH_LAYOUT_QUAD_SIDE            | 0x603            | 声道布局为QUAD-SIDE。                          |
238| CH_LAYOUT_2POINT0POINT2        | 0x3000000003     | 声道布局为2.0.2。                              |
239| CH_LAYOUT_AMB_ORDER1_ACN_N3D   | 0x100000000001   | 声道排序为ACN_N3D(根据ITU标准)的一阶FOA文件。  |
240| CH_LAYOUT_AMB_ORDER1_ACN_SN3D  | 0x100000001001   | 声道排序为ACN_SN3D(根据ITU标准)的一阶FOA文件。 |
241| CH_LAYOUT_AMB_ORDER1_FUMA      | 0x100000000101   | 声道排序为FUMA(根据ITU标准)的一阶FOA文件。     |
242| CH_LAYOUT_4POINT1              | 0x10F            | 声道布局为4.1。                                  |
243| CH_LAYOUT_5POINT0              | 0x607            | 声道布局为5.0。                                |
244| CH_LAYOUT_5POINT0_BACK         | 0x37             | 声道布局为5.0-BACK。                           |
245| CH_LAYOUT_2POINT1POINT2        | 0x300000000B     | 声道布局为2.1.2。                              |
246| CH_LAYOUT_3POINT0POINT2        | 0x3000000007     | 声道布局为3.0.2。                              |
247| CH_LAYOUT_5POINT1              | 0x60F            | 声道布局为5.1。                                |
248| CH_LAYOUT_5POINT1_BACK         | 0x3F             | 声道布局为5.1-BACK。                           |
249| CH_LAYOUT_6POINT0              | 0x707            | 声道布局为6.0。                                |
250| CH_LAYOUT_HEXAGONAL            | 0x137            | 声道布局为HEXAGONAL。                          |
251| CH_LAYOUT_3POINT1POINT2        | 0x500F           | 声道布局为3.1.2。                              |
252| CH_LAYOUT_6POINT0_FRONT        | 0x6C3            | 声道布局为6.0-FRONT。                          |
253| CH_LAYOUT_6POINT1              | 0x70F            | 声道布局为6.1。                                |
254| CH_LAYOUT_6POINT1_BACK         | 0x13F            | 声道布局为6.1-BACK。                           |
255| CH_LAYOUT_6POINT1_FRONT        | 0x6CB            | 声道布局为6.1-FRONT。                          |
256| CH_LAYOUT_7POINT0              | 0x637            | 声道布局为7.0。                                |
257| CH_LAYOUT_7POINT0_FRONT        | 0x6C7            | 声道布局为7.0-FRONT。                          |
258| CH_LAYOUT_7POINT1              | 0x63F            | 声道布局为7.1。                                |
259| CH_LAYOUT_OCTAGONAL            | 0x737            | 声道布局为OCTAGONAL。                          |
260| CH_LAYOUT_5POINT1POINT2        | 0x300000060F     | 声道布局为5.1.2。                              |
261| CH_LAYOUT_7POINT1_WIDE         | 0x6CF            | 声道布局为7.1-WIDE。                           |
262| CH_LAYOUT_7POINT1_WIDE_BACK    | 0xFF             | 声道布局为7.1-WIDE-BACK。                      |
263| CH_LAYOUT_AMB_ORDER2_ACN_N3D   | 0x100000000002   | 声道排序为ACN_N3D(根据ITU标准)的二阶HOA文件。  |
264| CH_LAYOUT_AMB_ORDER2_ACN_SN3D  | 0x100000001002   | 声道排序为ACN_SN3D(根据ITU标准)的二阶HOA文件。 |
265| CH_LAYOUT_AMB_ORDER2_FUMA      | 0x100000000102   | 声道排序为FUMA(根据ITU标准)的二阶HOA文件。     |
266| CH_LAYOUT_5POINT1POINT4        | 0x2D60F          | 声道布局为5.1.4。                              |
267| CH_LAYOUT_7POINT1POINT2        | 0x300000063F     | 声道布局为7.1.2。                              |
268| CH_LAYOUT_7POINT1POINT4        | 0x2D63F          | 声道布局为7.1.4。                              |
269| CH_LAYOUT_10POINT2             | 0x180005737      | 声道布局为10.2。                               |
270| CH_LAYOUT_9POINT1POINT4        | 0x18002D63F      | 声道布局为9.1.4。                              |
271| CH_LAYOUT_9POINT1POINT6        | 0x318002D63F     | 声道布局为9.1.6。                              |
272| CH_LAYOUT_HEXADECAGONAL        | 0x18003F737      | 声道布局为HEXADECAGONAL。                      |
273| CH_LAYOUT_AMB_ORDER3_ACN_N3D   | 0x100000000003   | 声道排序为ACN_N3D(根据ITU标准)的三阶HOA文件。  |
274| CH_LAYOUT_AMB_ORDER3_ACN_SN3D  | 0x100000001003   | 声道排序为ACN_SN3D(根据ITU标准)的三阶HOA文件。 |
275| CH_LAYOUT_AMB_ORDER3_FUMA      | 0x100000000103   | 声道排序为FUMA(根据ITU标准)的三阶HOA文件。     |
276
277## StreamUsage
278
279表示音频流使用类型的枚举。
280
281**系统能力:** SystemCapability.Multimedia.Audio.Core
282
283| 名称                                      |  值    | 说明                                                                             |
284| ------------------------------------------| ------ |--------------------------------------------------------------------------------|
285| STREAM_USAGE_UNKNOWN                      | 0      | 未知类型。  <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
286| STREAM_USAGE_MEDIA<sup>(deprecated)</sup> | 1      | 媒体。<br/> 从API version 7开始支持,从API version 10开始废弃,建议使用该枚举中的STREAM_USAGE_MUSIC、STREAM_USAGE_MOVIE、STREAM_USAGE_GAME或STREAM_USAGE_AUDIOBOOK替代。 |
287| STREAM_USAGE_MUSIC<sup>10+</sup>          | 1      | 音乐。   <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
288| STREAM_USAGE_VOICE_COMMUNICATION          | 2      | VoIP语音通话。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
289| STREAM_USAGE_VOICE_ASSISTANT<sup>9+</sup> | 3      | 语音播报。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
290| STREAM_USAGE_ALARM<sup>10+</sup>          | 4      | 闹钟。   <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
291| STREAM_USAGE_VOICE_MESSAGE<sup>10+</sup>  | 5      | 语音消息。  <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
292| STREAM_USAGE_NOTIFICATION_RINGTONE<sup>(deprecated)</sup> | 6      | 通知铃声。<br/> 从API version 7开始支持,从API version 10开始废弃,建议使用该枚举中的STREAM_USAGE_RINGTONE替代。 |
293| STREAM_USAGE_RINGTONE<sup>10+</sup>       | 6      | 铃声。    <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
294| STREAM_USAGE_NOTIFICATION<sup>10+</sup>   | 7      | 通知音。  <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
295| STREAM_USAGE_ACCESSIBILITY<sup>10+</sup>  | 8      | 无障碍。    <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
296| STREAM_USAGE_MOVIE<sup>10+</sup>          | 10     | 电影或视频。   <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
297| STREAM_USAGE_GAME<sup>10+</sup>           | 11     | 游戏。  <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
298| STREAM_USAGE_AUDIOBOOK<sup>10+</sup>      | 12     | 有声读物(包括听书、相声、评书)、听新闻、播客等。   <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
299| STREAM_USAGE_NAVIGATION<sup>10+</sup>     | 13     | 导航。   <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
300| STREAM_USAGE_VIDEO_COMMUNICATION<sup>12+</sup>     | 17     | VoIP视频通话。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
301
302## AudioState<sup>8+</sup>
303
304表示音频状态的枚举。
305
306**系统能力:** SystemCapability.Multimedia.Audio.Core
307
308| 名称           | 值     | 说明             |
309| -------------- | ------ | ---------------- |
310| STATE_INVALID  | -1     | 无效状态。       |
311| STATE_NEW      | 0      | 创建新实例状态。 |
312| STATE_PREPARED | 1      | 准备状态。       |
313| STATE_RUNNING  | 2      | 运行状态。 |
314| STATE_STOPPED  | 3      | 停止状态。       |
315| STATE_RELEASED | 4      | 释放状态。       |
316| STATE_PAUSED   | 5      | 暂停状态。       |
317
318## AudioEffectMode<sup>10+</sup>
319
320表示音效模式的枚举。
321
322**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
323
324**系统能力:** SystemCapability.Multimedia.Audio.Renderer
325
326| 名称               | 值     | 说明       |
327| ------------------ | ------ | ---------- |
328| EFFECT_NONE        | 0      | 关闭音效。 |
329| EFFECT_DEFAULT     | 1      | 默认音效。 |
330
331## AudioRendererRate<sup>8+</sup>
332
333表示音频渲染速度的枚举。
334
335**系统能力:** SystemCapability.Multimedia.Audio.Renderer
336
337| 名称               | 值     | 说明       |
338| ------------------ | ------ | ---------- |
339| RENDER_RATE_NORMAL | 0      | 正常速度。 |
340| RENDER_RATE_DOUBLE | 1      | 2倍速。    |
341| RENDER_RATE_HALF   | 2      | 0.5倍速。  |
342
343## InterruptType
344
345表示中断类型的枚举。
346
347**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
348
349**系统能力:** SystemCapability.Multimedia.Audio.Renderer
350
351| 名称                 |  值     | 说明                   |
352| -------------------- | ------ | ---------------------- |
353| INTERRUPT_TYPE_BEGIN | 1      | 音频播放中断事件开始。 |
354| INTERRUPT_TYPE_END   | 2      | 音频播放中断事件结束。 |
355
356## InterruptForceType<sup>9+</sup>
357
358表示音频打断类型的枚举。
359
360当用户监听到音频中断(即收到[InterruptEvent](arkts-apis-audio-i.md#interruptevent9)事件)时,获取此信息。
361
362此类型表示音频打断是否已由系统强制执行,具体操作信息(如音频暂停、停止等)可通过[InterruptHint](#interrupthint)获取。关于音频打断策略的详细说明可参考文档[音频焦点和音频会话介绍](../../media/audio/audio-playback-concurrency.md)。
363
364**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
365
366**系统能力:** SystemCapability.Multimedia.Audio.Renderer
367
368| 名称            |  值    | 说明                                 |
369| --------------- | ------ | ------------------------------------ |
370| INTERRUPT_FORCE | 0      | 强制打断类型,即具体操作已由系统强制执行。   |
371| INTERRUPT_SHARE | 1      | 共享打断类型,即系统不执行具体操作,通过[InterruptHint](#interrupthint)建议并提示应用操作,应用可自行决策下一步处理方式。 |
372
373## InterruptHint
374
375表示中断提示的枚举。
376
377当用户监听到音频中断事件(即收到[InterruptEvent](arkts-apis-audio-i.md#interruptevent9)事件)时,获取此信息。
378
379此类型表示根据焦点策略,对音频流执行的具体操作(如暂停、调整音量等)。
380
381可以结合InterruptEvent中的[InterruptForceType](#interruptforcetype9)信息,判断该操作是否已由系统强制执行。详情请参阅文档[音频焦点和音频会话介绍](../../media/audio/audio-playback-concurrency.md)。
382
383**系统能力:** SystemCapability.Multimedia.Audio.Renderer
384
385| 名称                               |  值     | 说明                                         |
386| ---------------------------------- | ------ | -------------------------------------------- |
387| INTERRUPT_HINT_NONE<sup>8+</sup>   | 0      | 无提示。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
388| INTERRUPT_HINT_RESUME              | 1      | 提示音频恢复,应用可主动触发开始渲染或开始采集的相关操作。<br>此操作无法由系统强制执行,其对应的[InterruptForceType](#interruptforcetype9)一定为INTERRUPT_SHARE类型。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
389| INTERRUPT_HINT_PAUSE               | 2      | 提示音频暂停,暂时失去音频焦点。<br>待焦点可用时,会收到INTERRUPT_HINT_RESUME事件。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
390| INTERRUPT_HINT_STOP                | 3      | 提示音频停止,彻底失去音频焦点。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
391| INTERRUPT_HINT_DUCK                | 4      | 提示音频躲避开始,降低音量播放。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
392| INTERRUPT_HINT_UNDUCK<sup>8+</sup> | 5      | 提示音频躲避结束,恢复音量播放。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
393| INTERRUPT_HINT_MUTE<sup>20+</sup> | 6      | 提示音频静音。 |
394| INTERRUPT_HINT_UNMUTE<sup>20+</sup> | 7      | 提示音频解除静音。            |
395
396## AudioVolumeMode<sup>19+</sup>
397
398表示音量模式的枚举。
399
400**系统能力:** SystemCapability.Multimedia.Audio.Volume
401
402| 名称           | 值     | 说明           |
403| -------------- | ------ |--------------|
404| SYSTEM_GLOBAL  | 0 | 系统级音量(默认模式)。 |
405| APP_INDIVIDUAL | 1 | 应用级音量。       |
406
407## AudioPrivacyType<sup>10+</sup>
408
409表示对应播放音频流是否支持被其他应用录制的枚举。
410
411**系统能力:** SystemCapability.Multimedia.Audio.PlaybackCapture
412
413| 名称                 | 值   | 说明                             |
414| -------------------- | ---- | -------------------------------- |
415| PRIVACY_TYPE_PUBLIC  | 0    | 表示音频流可以被其他应用录制。   |
416| PRIVACY_TYPE_PRIVATE | 1    | 表示音频流不可以被其他应用录制。 |
417
418## ChannelBlendMode<sup>11+</sup>
419
420表示声道混合模式类型的枚举。
421
422**系统能力:** SystemCapability.Multimedia.Audio.Core
423
424| 名称                                         |  值     | 说明                   |
425| :------------------------------------------- | :----- | :--------------------- |
426| MODE_DEFAULT | 0     | 无声道混合。  |
427| MODE_BLEND_LR | 1      | 混合左右声道。 |
428| MODE_ALL_LEFT | 2      | 从左声道覆盖到右声道混合。  |
429| MODE_ALL_RIGHT | 3 | 从右声道覆盖到左声道混合。 |
430
431## AudioStreamDeviceChangeReason<sup>11+</sup>
432
433表示流设备变更原因的枚举。
434
435**系统能力:** SystemCapability.Multimedia.Audio.Device
436
437| 名称                                        |  值     | 说明              |
438|:------------------------------------------| :----- |:----------------|
439| REASON_UNKNOWN | 0 | 未知原因。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
440| REASON_NEW_DEVICE_AVAILABLE | 1 | 新设备可用。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
441| REASON_OLD_DEVICE_UNAVAILABLE | 2 | 旧设备不可用。报告此原因时,应考虑暂停音频播放。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
442| REASON_OVERRODE | 3 | 强选。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
443| REASON_SESSION_ACTIVATED<sup>20+</sup> | 4 | 音频会话已激活。 |
444| REASON_STREAM_PRIORITY_CHANGED<sup>20+</sup> | 5 | 更高优先级的音频流出现导致的系统设备切换。 |
445
446## OutputDeviceChangeRecommendedAction<sup>20+</sup>
447
448表示输出设备变更后推荐操作的枚举。
449
450**系统能力:** SystemCapability.Multimedia.Audio.Core
451
452| 名称                                        |  值     | 说明              |
453|:------------------------------------------| :----- |:----------------|
454| DEVICE_CHANGE_RECOMMEND_TO_CONTINUE | 0 | 推荐继续播放。           |
455| DEVICE_CHANGE_RECOMMEND_TO_STOP | 1 | 推荐停止播放。         |
456
457## DeviceChangeType
458
459表示设备连接状态变化的枚举。
460
461**系统能力:** SystemCapability.Multimedia.Audio.Device
462
463| 名称       | 值   | 说明           |
464| :--------- | :--- | :------------- |
465| CONNECT    | 0    | 设备连接。     |
466| DISCONNECT | 1    | 断开设备连接。 |
467
468## DeviceBlockStatus<sup>13+</sup>
469
470表示音频设备是否被堵塞的枚举。
471
472**系统能力:** SystemCapability.Multimedia.Audio.Device
473
474| 名称       | 值   | 说明           |
475| :--------- | :--- | :------------- |
476| UNBLOCKED  | 0    | 音频设备正常。    |
477| BLOCKED    | 1    | 音频设备被堵塞。 |
478
479## SourceType<sup>8+</sup>
480
481表示音源类型的枚举。
482
483| 名称                                         |  值     | 说明                   |
484| :------------------------------------------- | :----- | :--------------------- |
485| SOURCE_TYPE_INVALID                          | -1     | 无效的音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core  |
486| SOURCE_TYPE_MIC                              | 0      | Mic音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core |
487| SOURCE_TYPE_VOICE_RECOGNITION<sup>9+</sup>   | 1      | 语音识别源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core  |
488| SOURCE_TYPE_PLAYBACK_CAPTURE<sup>(deprecated)</sup>   | 2 | 播放音频流(内录)录制音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.PlaybackCapture <br/> 从API version 10开始支持,从API version 12开始废弃,建议使用[录屏接口AVScreenCapture](../apis-media-kit/capi-avscreencapture.md)替代。  |
489| SOURCE_TYPE_VOICE_COMMUNICATION              | 7      | 语音通话场景的音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core |
490| SOURCE_TYPE_VOICE_MESSAGE<sup>12+</sup>      | 10     | 短语音消息的音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core |
491| SOURCE_TYPE_CAMCORDER<sup>13+</sup>          | 13     | 录像的音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core |
492| SOURCE_TYPE_UNPROCESSED<sup>14+</sup>     | 14 |  麦克风纯净录音的音频源(系统不做任何算法处理)。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core |
493|  SOURCE_TYPE_LIVE<sup>20+</sup>     | 17 |  直播场景的音频源。<br/>**系统能力:** SystemCapability.Multimedia.Audio.Core |
494
495## AudioScene<sup>8+</sup>
496
497表示音频场景的枚举。
498
499**系统能力:** SystemCapability.Multimedia.Audio.Communication
500
501| 名称                   |  值     | 说明                                          |
502| :--------------------- | :----- | :-------------------------------------------- |
503| AUDIO_SCENE_DEFAULT                  | 0      | 默认音频场景。                                |
504| AUDIO_SCENE_RINGING<sup>12+</sup>    | 1      | 响铃模式。 |
505| AUDIO_SCENE_PHONE_CALL<sup>12+</sup> | 2      | 电话模式。 |
506| AUDIO_SCENE_VOICE_CHAT               | 3      | 语音聊天模式。                                |
507
508## AudioConcurrencyMode<sup>12+</sup>
509
510表示音频并发模式的枚举。
511
512**系统能力:** SystemCapability.Multimedia.Audio.Core
513
514| 名称                   | 值 | 说明      |
515| :--------------------- |:--|:--------|
516| CONCURRENCY_DEFAULT | 0 | 默认使用系统策略。     |
517| CONCURRENCY_MIX_WITH_OTHERS | 1 | 和其他音频并发。     |
518| CONCURRENCY_DUCK_OTHERS | 2 | 压低其他音频的音量。 |
519| CONCURRENCY_PAUSE_OTHERS | 3 | 暂停其他音频。 |
520
521## AudioSessionDeactivatedReason<sup>12+</sup>
522
523表示音频会话停用原因的枚举。
524
525**系统能力:** SystemCapability.Multimedia.Audio.Core
526
527| 名称                   | 值 | 说明     |
528| :--------------------- |:--|:-------|
529| DEACTIVATED_LOWER_PRIORITY | 0 | 应用焦点被抢占。 |
530| DEACTIVATED_TIMEOUT | 1 | 音频会话等待超时。    |
531
532## AudioSessionScene<sup>20+</sup>
533
534枚举音频会话场景。
535
536**系统能力:** SystemCapability.Multimedia.Audio.Core
537
538| 名称                   | 值 | 说明      |
539| :--------------------- |:--|:--------|
540| AUDIO_SESSION_SCENE_MEDIA | 0 | 媒体音频会话场景。     |
541| AUDIO_SESSION_SCENE_GAME | 1 | 游戏音频会话场景。     |
542| AUDIO_SESSION_SCENE_VOICE_COMMUNICATION  | 2 | VoIP语音通话音频会话场景。 |
543
544## AudioSessionStateChangeHint<sup>20+</sup>
545
546枚举用于音频会话状态变更提示。
547
548当用户监听到音频会话状态变化事件(即收到[AudioSessionStateChangedEvent](arkts-apis-audio-i.md#audiosessionstatechangedevent20)事件)时,获取相关信息。
549
550此类型表示根据焦点策略对音频会话执行的操作,包括暂停、调整音量等。
551
552详情请参阅文档[音频焦点和音频会话介绍](../../media/audio/audio-playback-concurrency.md)。
553
554**系统能力:** SystemCapability.Multimedia.Audio.Core
555
556| 名称                               |  值     | 说明                                         |
557| ---------------------------------- | ------ | -------------------------------------------- |
558| AUDIO_SESSION_STATE_CHANGE_HINT_RESUME              | 0      | 提示音频会话恢复,应用可主动触发开始渲染等操作。 |
559| AUDIO_SESSION_STATE_CHANGE_HINT_PAUSE               | 1      | 提示音频会话暂停,暂时失去音频焦点。当焦点再次可用时,会收到 AUDIO_SESSION_STATE_CHANGE_HINT_RESUME 事件。 |
560| AUDIO_SESSION_STATE_CHANGE_HINT_STOP                | 2      | 提示音频会话因焦点被抢占而停止,彻底失去音频焦点。 |
561| AUDIO_SESSION_STATE_CHANGE_HINT_TIME_OUT_STOP                | 3      | 提示音频会话因长时间无业务而被系统停止,导致失去音频焦点。 |
562| AUDIO_SESSION_STATE_CHANGE_HINT_DUCK                | 4      | 提示音频会话躲避开始,降低音量播放。 |
563| AUDIO_SESSION_STATE_CHANGE_HINT_UNDUCK | 5      | 提示音频会话躲避结束,恢复音量播放。 |
564
565## AudioDataCallbackResult<sup>12+</sup>
566
567表示音频数据回调结果的枚举。
568
569**系统能力:** SystemCapability.Multimedia.Audio.Core
570
571| 名称                 | 值      | 说明         |
572| ---------------------| --------| ----------------- |
573| INVALID  | -1 | 表示该回调数据无效。      |
574| VALID      | 0 | 表示该回调数据有效。     |
575
576## ContentType<sup>(deprecated)</sup>
577
578表示音频内容类型的枚举。
579
580> **说明:**
581> 从API version 7开始支持,从API version 10开始废弃,建议使用[StreamUsage](#streamusage)替代。
582
583**系统能力:** SystemCapability.Multimedia.Audio.Core
584
585| 名称                               |  值    | 说明       |
586| ---------------------------------- | ------ | ---------- |
587| CONTENT_TYPE_UNKNOWN               | 0      | 未知类型。 |
588| CONTENT_TYPE_SPEECH                | 1      | 语音。     |
589| CONTENT_TYPE_MUSIC                 | 2      | 音乐。     |
590| CONTENT_TYPE_MOVIE                 | 3      | 电影。     |
591| CONTENT_TYPE_SONIFICATION          | 4      | 通知音。   |
592| CONTENT_TYPE_RINGTONE<sup>8+</sup> | 5      | 铃声。     |
593
594## ActiveDeviceType<sup>(deprecated)</sup>
595
596表示活跃设备类型的枚举。
597
598> **说明:**
599>
600> 从API version 7开始支持,从API version 9开始废弃,建议使用[CommunicationDeviceType](#communicationdevicetype9)替代。
601
602**系统能力:** SystemCapability.Multimedia.Audio.Device
603
604| 名称          |  值     | 说明                                                 |
605| ------------- | ------ | ---------------------------------------------------- |
606| SPEAKER       | 2      | 扬声器。                                             |
607| BLUETOOTH_SCO | 7      | 蓝牙设备SCO(Synchronous Connection Oriented)连接。 |
608
609## InterruptActionType<sup>(deprecated)</sup>
610
611表示中断事件返回类型的枚举。
612
613> **说明:**
614>
615> 从API version 7开始支持,从API version 9开始废弃,无替代接口。
616
617**系统能力:** SystemCapability.Multimedia.Audio.Renderer
618
619| 名称           |  值     | 说明               |
620| -------------- | ------ | ------------------ |
621| TYPE_ACTIVATED | 0      | 表示触发焦点事件。 |
622| TYPE_INTERRUPT | 1      | 表示音频打断事件。 |
623
624## AudioLoopbackMode<sup>20+</sup>
625
626表示返听模式的枚举。
627
628**系统能力:** SystemCapability.Multimedia.Audio.Capturer
629
630| 名称           | 值     | 说明              |
631| -------------- | ------ | ----------------- |
632| HARDWARE       | 0      | 表示硬件返听模式。 |
633
634## AudioLoopbackStatus<sup>20+</sup>
635
636表示返听状态的枚举。
637
638**系统能力:** SystemCapability.Multimedia.Audio.Capturer
639
640| 名称               | 值     | 说明             |
641| ------------------ | ------ | ---------------- |
642| UNAVAILABLE_DEVICE | -2     | 表示返听由于输入\输出设备而不可用(如出声设备变更)。    |
643| UNAVAILABLE_SCENE  | -1     | 表示返听由于音频场景而不可用(如音频焦点、低时延管控)。 |
644| AVAILABLE_IDLE     |  0     | 表示返听可用。     |
645| AVAILABLE_RUNNING  |  1     | 表示返听运行中。   |