• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# native_audio_common.h
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声明音频公共基础数据结构。<br> 定义音频接口的公共返回值的类型。
12
13**引用文件:** <ohaudio/native_audio_common.h>
14
15**库:** libohaudio.so
16
17**系统能力:** SystemCapability.Multimedia.Audio.Core
18
19**起始版本:** 12
20
21**相关模块:** [OHAudio](capi-ohaudio.md)
22
23## 汇总
24
25### 枚举
26
27| 名称 | typedef关键字 | 描述 |
28| -- | -- | -- |
29| [OH_AudioCommon_Result](#oh_audiocommon_result) | OH_AudioCommon_Result | 音频错误码。 |
30| [OH_AudioScene](#oh_audioscene) | OH_AudioScene | 定义音频场景。 |
31| [OH_AudioRingerMode](#oh_audioringermode) | OH_AudioRingerMode | 定义铃音模式。 |
32
33## 枚举类型说明
34
35### OH_AudioCommon_Result
36
37```
38enum OH_AudioCommon_Result
39```
40
41**描述**
42
43音频错误码。
44
45**起始版本:** 12
46
47| 枚举项 | 描述 |
48| -- | -- |
49| AUDIOCOMMON_RESULT_SUCCESS = 0 | 操作成功。 |
50| AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM = 6800101 | 入参错误。 |
51| AUDIOCOMMON_RESULT_ERROR_NO_MEMORY = 6800102 | 无内存。 |
52| AUDIOCOMMON_RESULT_ERROR_ILLEGAL_STATE = 6800103 | 非法状态。 |
53| AUDIOCOMMON_RESULT_ERROR_UNSUPPORTED = 6800104 | 操作不支持。 |
54| AUDIOCOMMON_RESULT_ERROR_TIMEOUT = 6800105 | 操作超时。 |
55| AUDIOCOMMON_RESULT_ERROR_STREAM_LIMIT = 6800201 | 达到系统可支持的最大数量。 |
56| AUDIOCOMMON_RESULT_ERROR_SYSTEM = 6800301 | 系统通用错误。 |
57
58### OH_AudioScene
59
60```
61enum OH_AudioScene
62```
63
64**描述**
65
66定义音频场景。
67
68**起始版本:** 12
69
70| 枚举项 | 描述 |
71| -- | -- |
72| AUDIO_SCENE_DEFAULT = 0 | 默认音频场景。 |
73| AUDIO_SCENE_RINGING = 1 | 响铃场景。 |
74| AUDIO_SCENE_PHONE_CALL = 2 | 电话场景。 |
75| AUDIO_SCENE_VOICE_CHAT = 3 | 语音聊天场景。 |
76
77### OH_AudioRingerMode
78
79```
80enum OH_AudioRingerMode
81```
82
83**描述**
84
85定义铃音模式。
86
87**起始版本:** 20
88
89| 枚举项 | 描述 |
90| -- | -- |
91| AUDIO_RINGER_MODE_SILENT = 0 | 静音模式。 |
92| AUDIO_RINGER_MODE_VIBRATE = 1 | 振动模式。 |
93| AUDIO_RINGER_MODE_NORMAL = 2 | 响铃模式。 |
94
95
96