1# 使用OHAudio开发音频录制功能(C/C++)
2
3OHAudio是系统在API version 10中引入的一套C API，此API在设计上实现归一，同时支持普通音频通路和低时延通路。仅支持PCM格式，适用于依赖Native层实现音频输入功能的场景。
4
5OHAudio音频频录状态变化示意图：
6![OHAudioCapturer status change](figures/ohaudiocapturer-status-change.png)
7
8## 使用入门
9
10开发者要使用OHAudio提供的录制能力，需要添加对应的头文件。
11
12### 在 CMake 脚本中链接动态库
13
14``` cmake
15target_link_libraries(sample PUBLIC libohaudio.so)
16```
17### 添加头文件
18开发者通过引入<[native_audiostreambuilder.h](../../reference/apis-audio-kit/native__audiostreambuilder_8h.md)>和<[native_audiocapturer.h](../../reference/apis-audio-kit/native__audiocapturer_8h.md)>头文件，使用音频录制相关API。
19
20```cpp
21#include <ohaudio/native_audiocapturer.h>
22#include <ohaudio/native_audiostreambuilder.h>
23```
24## 音频流构造器
25
26OHAudio提供OH_AudioStreamBuilder接口，遵循构造器设计模式，用于构建音频流。开发者需要根据业务场景，指定对应的[OH_AudioStream_Type](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostream_type) 。
27
28`OH_AudioStream_Type`包含两种类型：
29
30- AUDIOSTREAM_TYPE_RENDERER
31- AUDIOSTREAM_TYPE_CAPTURER
32
33使用[OH_AudioStreamBuilder_Create](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_create)创建构造器示例：
34
35```cpp
36OH_AudioStreamBuilder* builder;
37OH_AudioStreamBuilder_Create(&builder, streamType);
38```
39
40在音频业务结束之后，开发者应该执行[OH_AudioStreamBuilder_Destroy](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_destroy)接口来销毁构造器。
41
42```cpp
43OH_AudioStreamBuilder_Destroy(builder);
44```
45
46## 开发步骤及注意事项
47
48详细的API说明请参考[OHAudio API参考](../../reference/apis-audio-kit/_o_h_audio.md)。
49
50开发者可以通过以下几个步骤来实现一个简单的录制功能。
51
52
531. 创建构造器
54
55    ```cpp
56    OH_AudioStreamBuilder* builder;
57    OH_AudioStreamBuilder_Create(&builder, AUDIOSTREAM_TYPE_CAPTURER);
58    ```
59
602. 配置音频流参数
61
62    创建音频录制构造器后，可以设置音频流所需要的参数，可以参考下面的案例。
63
64    ```cpp
65    // 设置音频采样率
66    OH_AudioStreamBuilder_SetSamplingRate(builder, 48000);
67    // 设置音频声道
68    OH_AudioStreamBuilder_SetChannelCount(builder, 2);
69    // 设置音频采样格式
70    OH_AudioStreamBuilder_SetSampleFormat(builder, AUDIOSTREAM_SAMPLE_S16LE);
71    // 设置音频流的编码类型
72    OH_AudioStreamBuilder_SetEncodingType(builder, AUDIOSTREAM_ENCODING_TYPE_RAW);
73    // 设置输入音频流的工作场景
74    OH_AudioStreamBuilder_SetCapturerInfo(builder, AUDIOSTREAM_SOURCE_TYPE_MIC);
75    ```
76
77    同样，音频录制的音频数据要通过回调接口读入，开发者要实现回调接口，使用`OH_AudioStreamBuilder_SetCapturerCallback`设置回调函数。回调函数的声明请查看[OH_AudioCapturer_Callbacks](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiocapturer_callbacks) 。
78
793. 设置音频回调函数
80
81    多音频并发处理可参考文档[处理音频焦点事件](audio-playback-concurrency.md)，仅接口语言差异。
82
83    ```cpp
84    // 自定义读入数据函数
85    int32_t MyOnReadData(
86        OH_AudioCapturer* capturer,
87        void* userData,
88        void* buffer,
89        int32_t length)
90    {
91        // 从buffer中取出length长度的录音数据
92        return 0;
93    }
94    // 自定义音频流事件函数
95    int32_t MyOnStreamEvent(
96        OH_AudioCapturer* capturer,
97        void* userData,
98        OH_AudioStream_Event event)
99    {
100        // 根据event表示的音频流事件信息，更新播放器状态和界面
101        return 0;
102    }
103    // 自定义音频中断事件函数
104    int32_t MyOnInterruptEvent(
105        OH_AudioCapturer* capturer,
106        void* userData,
107        OH_AudioInterrupt_ForceType type,
108        OH_AudioInterrupt_Hint hint)
109    {
110        // 根据type和hint表示的音频中断信息，更新录制器状态和界面
111        return 0;
112    }
113    // 自定义异常回调函数
114    int32_t MyOnError(
115        OH_AudioCapturer* capturer,
116        void* userData,
117        OH_AudioStream_Result error)
118    {
119        // 根据error表示的音频异常信息，做出相应的处理
120        return 0;
121    }
122
123    OH_AudioCapturer_Callbacks callbacks;
124
125    // 配置回调函数
126    callbacks.OH_AudioCapturer_OnReadData = MyOnReadData;
127    callbacks.OH_AudioCapturer_OnStreamEvent = MyOnStreamEvent;
128    callbacks.OH_AudioCapturer_OnInterruptEvent = MyOnInterruptEvent;
129    callbacks.OH_AudioCapturer_OnError = MyOnError;
130
131    // 设置音频输入流的回调
132    OH_AudioStreamBuilder_SetCapturerCallback(builder, callbacks, nullptr);
133    ```
134
135    为了避免不可预期的行为，在设置音频回调函数时，可以通过下面两种方式中的任意一种来设置音频回调函数：
136
137    - 请确保[OH_AudioCapturer_Callbacks](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiocapturer_callbacks)的每一个回调都被**自定义的回调方法**或**空指针**初始化。
138
139      ```cpp
140      // 自定义读入数据函数
141      int32_t MyOnReadData(
142          OH_AudioCapturer* capturer,
143          void* userData,
144          void* buffer,
145          int32_t length)
146      {
147          // 从buffer中取出length长度的录音数据
148          return 0;
149      }
150      // 自定义音频中断事件函数
151      int32_t MyOnInterruptEvent(
152          OH_AudioCapturer* capturer,
153          void* userData,
154          OH_AudioInterrupt_ForceType type,
155          OH_AudioInterrupt_Hint hint)
156      {
157          // 根据type和hint表示的音频中断信息，更新录制器状态和界面
158          return 0;
159      }
160      OH_AudioCapturer_Callbacks callbacks;
161
162      // 配置回调函数，如果需要监听，则赋值
163      callbacks.OH_AudioCapturer_OnReadData = MyOnReadData;
164      callbacks.OH_AudioCapturer_OnInterruptEvent = MyOnInterruptEvent;
165
166      // （必选）如果不需要监听，使用空指针初始化
167      callbacks.OH_AudioCapturer_OnStreamEvent = nullptr;
168      callbacks.OH_AudioCapturer_OnError = nullptr;
169      ```
170
171    - 使用前，初始化并清零结构体。
172
173      ```cpp
174      // 自定义读入数据函数
175      int32_t MyOnReadData(
176          OH_AudioCapturer* capturer,
177          void* userData,
178          void* buffer,
179          int32_t length)
180      {
181          // 从buffer中取出length长度的录音数据
182          return 0;
183      }
184      // 自定义音频中断事件函数
185      int32_t MyOnInterruptEvent(
186          OH_AudioCapturer* capturer,
187          void* userData,
188          OH_AudioInterrupt_ForceType type,
189          OH_AudioInterrupt_Hint hint)
190      {
191          // 根据type和hint表示的音频中断信息，更新录制器状态和界面
192          return 0;
193      }
194      OH_AudioCapturer_Callbacks callbacks;
195
196      // 使用前，初始化并清零结构体
197      memset(&callbacks, 0, sizeof(OH_AudioCapturer_Callbacks));
198
199      // 配置需要的回调函数
200      callbacks.OH_AudioCapturer_OnReadData = MyOnReadData;
201      callbacks.OH_AudioCapturer_OnInterruptEvent = MyOnInterruptEvent;
202      ```
203
2044. 构造录制音频流
205
206    ```cpp
207    OH_AudioCapturer* audioCapturer;
208    OH_AudioStreamBuilder_GenerateCapturer(builder, &audioCapturer);
209    ```
210
2115. 使用音频流
212
213    录制音频流包含下面接口，用来实现对音频流的控制。
214
215    | 接口                                                         | 说明         |
216    | ------------------------------------------------------------ | ------------ |
217    | OH_AudioStream_Result OH_AudioCapturer_Start(OH_AudioCapturer* capturer) | 开始录制     |
218    | OH_AudioStream_Result OH_AudioCapturer_Pause(OH_AudioCapturer* capturer) | 暂停录制     |
219    | OH_AudioStream_Result OH_AudioCapturer_Stop(OH_AudioCapturer* capturer) | 停止录制     |
220    | OH_AudioStream_Result OH_AudioCapturer_Flush(OH_AudioCapturer* capturer) | 释放缓存数据 |
221    | OH_AudioStream_Result OH_AudioCapturer_Release(OH_AudioCapturer* capturer) | 释放录制实例 |
222
2236. 释放构造器
224
225    构造器不再使用时，需要释放相关资源。
226
227    ```cpp
228    OH_AudioStreamBuilder_Destroy(builder);
229    ```
230
231## 设置低时延模式
232
233当设备支持低时延通路时，开发者可以使用低时延模式创建音频录制构造器，获得更高质量的音频体验。
234
235开发流程与普通录制场景一致，仅需要在创建音频录制构造器时，调用[OH_AudioStreamBuilder_SetLatencyMode()](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setlatencymode)设置低时延模式。
236
237> **注意：**
238> 当音频录制场景[OH_AudioStream_SourceType](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostream_sourcetype)为`AUDIOSTREAM_SOURCE_TYPE_VOICE_COMMUNICATION`时，不支持主动设置低时延模式，系统会根据设备的能力，决策输出的音频通路。
239
240开发示例
241
242```cpp
243OH_AudioStream_LatencyMode latencyMode = AUDIOSTREAM_LATENCY_MODE_FAST;
244OH_AudioStreamBuilder_SetLatencyMode(builder, latencyMode);
245```
246
247## 相关实例
248
249针对OHAudio开发音频录制，有以下相关实例可供参考：
250
251- [OHAudio录制和播放](https://gitee.com/openharmony/applications_app_samples/tree/master/code/DocsSample/Media/Audio/OHAudio)
252
253<!--RP1-->
254<!--RP1End-->