• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OHAudio
2
3
4## 概述
5
6提供音频模块Native接口定义。
7
8\@syscap SystemCapability.Multimedia.Audio.Core
9
10**起始版本:**
11
1210
13
14
15## 汇总
16
17
18### 文件
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [native_audiocapturer.h](native__audiocapturer_8h.md) | 声明输入类型的音频流相关接口。<br/>**引用文件**:&lt;ohaudio/native_audiocapturer.h&gt;<br/>**库**:libohaudio.so |
23| [native_audiorenderer.h](native__audiorenderer_8h.md) | 声明输出类型的音频流相关接口。<br/>**引用文件**:&lt;ohaudio/native_audiorenderer.h&gt;<br/>**库**:libohaudio.so |
24| [native_audiostream_base.h](native__audiostream__base_8h.md) | 声明OHAudio基础的数据结构。<br/>**引用文件**:&lt;ohaudio/native_audiostream_base.h&gt;<br/>**库**:libohaudio.so |
25| [native_audiostreambuilder.h](native__audiostreambuilder_8h.md) | 声明音频流构造器相关接口。<br/>**引用文件**:&lt;ohaudio/native_audiostreambuilder.h&gt;<br/>**库**:libohaudio.so |
26
27
28### 结构体
29
30| 名称 | 描述 |
31| -------- | -------- |
32| [OH_AudioRenderer_Callbacks_Struct](_o_h___audio_renderer___callbacks___struct.md) | 声明输出音频流的回调函数指针。 |
33| [OH_AudioCapturer_Callbacks_Struct](_o_h___audio_capturer___callbacks___struct.md) | 声明输入音频流的回调函数指针。 |
34
35
36### 类型定义
37
38| 名称 | 描述 |
39| -------- | -------- |
40| [OH_AudioStreamBuilder](#oh_audiostreambuilder) | 声明音频流的构造器。 |
41| [OH_AudioRenderer](#oh_audiorenderer) | 声明输出音频流。 |
42| [OH_AudioCapturer](#oh_audiocapturer) | 声明输入音频流。 |
43| [OH_AudioRenderer_Callbacks](#oh_audiorenderer_callbacks) | 声明输出音频流的回调函数指针。 |
44| [OH_AudioCapturer_Callbacks](#oh_audiocapturer_callbacks) | 声明输入音频流的回调函数指针。 |
45
46
47### 枚举
48
49| 名称 | 描述 |
50| -------- | -------- |
51| [OH_AudioStream_Result](#oh_audiostream_result) { AUDIOSTREAM_SUCCESS, AUDIOSTREAM_ERROR_INVALID_PARAM, AUDIOSTREAM_ERROR_ILLEGAL_STATE, AUDIOSTREAM_ERROR_SYSTEM } | 音频结果码。 |
52| [OH_AudioStream_Type](#oh_audiostream_type) { AUDIOSTREAM_TYPE_RENDERER = 1, AUDIOSTREAM_TYPE_CAPTURER = 2 } | 音频流类型。 |
53| [OH_AudioStream_SampleFormat](#oh_audiostream_sampleformat) { AUDIOSTREAM_SAMPLE_U8 = 0, AUDIOSTREAM_SAMPLE_S16LE = 1, AUDIOSTREAM_SAMPLE_S24LE = 2, AUDIOSTREAM_SAMPLE_S32LE = 3 } | 定义音频流采样格式。 |
54| [OH_AudioStream_EncodingType](#oh_audiostream_encodingtype) { **AUDIOSTREAM_ENCODING_TYPE_RAW** = 0 } | 定义音频流编码类型。 |
55| [OH_AudioStream_Usage](#oh_audiostream_usage) { **AUDIOSTREAM_USAGE_UNKNOWN** = 0, **AUDIOSTREAM_USAGE_MUSIC** = 1, **AUDIOSTREAM_USAGE_COMMUNICATION** = 2, **AUDIOSTREAM_USAGE_GAME** = 11 } | 定义音频流使用场景。 |
56| [OH_AudioStream_LatencyMode](#oh_audiostream_latencymode) { AUDIOSTREAM_LATENCY_MODE_NORMAL = 0, AUDIOSTREAM_LATENCY_MODE_FAST = 1} | 定义音频时延模式。 |
57| [OH_AudioStream_State](#oh_audiostream_state) {<br/>AUDIOSTREAM_STATE_INVALID = -1, AUDIOSTREAM_STATE_PREPARED = 1, AUDIOSTREAM_STATE_RUNNING = 2, AUDIOSTREAM_STATE_STOPPED = 3,<br/>AUDIOSTREAM_STATE_RELEASED = 4, AUDIOSTREAM_STATE_PAUSED = 5<br/>} | 定义音频流的状态。 |
58| [OH_AudioStream_SourceType](#oh_audiostream_sourcetype) { **AUDIOSTREAM_SOURCE_TYPE_INVALID** = -1, **AUDIOSTREAM_SOURCE_TYPE_MIC**, **AUDIOSTREAM_SOURCE_TYPE_VOICE_RECOGNITION** = 1, **AUDIOSTREAM_SOURCE_TYPE_VOICE_COMMUNICATION** = 7 } | 定义音频流使用场景。 |
59
60
61### 函数
62
63| 名称 | 描述 |
64| -------- | -------- |
65| [OH_AudioCapturer_Release](#oh_audiocapturer_release) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer) | 释放输入音频流。 |
66| [OH_AudioCapturer_Start](#oh_audiocapturer_start) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer) | 开始获取音频数据。 |
67| [OH_AudioCapturer_Pause](#oh_audiocapturer_pause) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer) | 暂停输入音频流。 |
68| [OH_AudioCapturer_Stop](#oh_audiocapturer_stop) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer) | 停止输入音频流 |
69| [OH_AudioCapturer_Flush](#oh_audiocapturer_flush) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer) | 丢弃获取的音频数据。 |
70| [OH_AudioCapturer_GetCurrentState](#oh_audiocapturer_getcurrentstate) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, [OH_AudioStream_State](#oh_audiostream_state) \*state) | 查询当前输入音频流状态。 |
71| [OH_AudioCapturer_GetLatencyMode](#oh_audiocapturer_getlatencymode) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, [OH_AudioStream_LatencyMode](#oh_audiostream_latencymode) \*latencyMode) | 查询当前输入音频流时延模式。 |
72| [OH_AudioCapturer_GetStreamId](#oh_audiocapturer_getstreamid) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, uint32_t \*streamId) | 查询当前输入音频流ID。 |
73| [OH_AudioCapturer_GetSamplingRate](#oh_audiocapturer_getsamplingrate) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, int32_t \*rate) | 查询当前输入音频流采样率。 |
74| [OH_AudioCapturer_GetChannelCount](#oh_audiocapturer_getchannelcount) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, int32_t \*channelCount) | 查询当前输入音频流通道数。 |
75| [OH_AudioCapturer_GetSampleFormat](#oh_audiocapturer_getsampleformat) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, [OH_AudioStream_SampleFormat](#oh_audiostream_sampleformat) \*sampleFormat) | 查询当前输入音频流采样格式。 |
76| [OH_AudioCapturer_GetEncodingType](#oh_audiocapturer_getencodingtype) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, [OH_AudioStream_EncodingType](#oh_audiostream_encodingtype) \*encodingType) | 查询当前输入音频流编码类型。 |
77| [OH_AudioCapturer_GetCapturerInfo](#oh_audiocapturer_getcapturerinfo) ([OH_AudioCapturer](#oh_audiocapturer) \*capturer, [OH_AudioStream_SourceType](#oh_audiostream_sourcetype) \*sourceType) | 查询当前输入音频流工作场景类型。 |
78| [OH_AudioRenderer_Release](#oh_audiorenderer_release) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer) | 释放输出音频流。 |
79| [OH_AudioRenderer_Start](#oh_audiorenderer_start) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer) | 开始输出音频数据。 |
80| [OH_AudioRenderer_Pause](#oh_audiorenderer_pause) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer) | 暂停输出音频流。 |
81| [OH_AudioRenderer_Stop](#oh_audiorenderer_stop) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer) | 停止输出音频流 |
82| [OH_AudioRenderer_Flush](#oh_audiorenderer_flush) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer) | 丢弃已经写入的音频数据。 |
83| [OH_AudioRenderer_GetCurrentState](#oh_audiorenderer_getcurrentstate) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, [OH_AudioStream_State](#oh_audiostream_state) \*state) | 查询当前输出音频流状态。 |
84| [OH_AudioRenderer_GetSamplingRate](#oh_audiorenderer_getsamplingrate) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, int32_t \*rate) | 查询当前输出音频流采样率。 |
85| [OH_AudioRenderer_GetStreamId](#oh_audiorenderer_getstreamid) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, uint32_t \*streamId) | 查询当前输出音频流ID。 |
86| [OH_AudioRenderer_GetChannelCount](#oh_audiorenderer_getchannelcount) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, int32_t \*channelCount) | 查询当前输出音频流通道数。 |
87| [OH_AudioRenderer_GetSampleFormat](#oh_audiorenderer_getsampleformat) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, [OH_AudioStream_SampleFormat](#oh_audiostream_sampleformat) \*sampleFormat) | 查询当前输出音频流采样格式。 |
88| [OH_AudioRenderer_GetLatencyMode](#oh_audiorenderer_getlatencymode) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, [OH_AudioStream_LatencyMode](#oh_audiostream_latencymode) \*latencyMode) | 查询当前输出音频流时延模式。 |
89| [OH_AudioRenderer_GetRendererInfo](#oh_audiorenderer_getrendererinfo) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, [OH_AudioStream_Usage](#oh_audiostream_usage) \*usage) | 查询当前输出音频流工作场景类型。 |
90| [OH_AudioRenderer_GetEncodingType](#oh_audiorenderer_getencodingtype) ([OH_AudioRenderer](#oh_audiorenderer) \*renderer, [OH_AudioStream_EncodingType](#oh_audiostream_encodingtype) \*encodingType) | 查询当前输出音频流编码类型。 |
91| [OH_AudioStreamBuilder_Create](#oh_audiostreambuilder_create) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*\*builder, [OH_AudioStream_Type](#oh_audiostream_type) type) | 创建一个输入或者输出类型的音频流构造器。 |
92| [OH_AudioStreamBuilder_Destroy](#oh_audiostreambuilder_destroy) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder) | 销毁一个音频流构造器。 |
93| [OH_AudioStreamBuilder_SetSamplingRate](#oh_audiostreambuilder_setsamplingrate) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, int32_t rate) | 设置音频流的采样率属性。 |
94| [OH_AudioStreamBuilder_SetChannelCount](#oh_audiostreambuilder_setchannelcount) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, int32_t channelCount) | 设置音频流的通道数属性。 |
95| [OH_AudioStreamBuilder_SetSampleFormat](#oh_audiostreambuilder_setsampleformat) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioStream_SampleFormat](#oh_audiostream_sampleformat) format) | 设置音频流的采样格式属性。 |
96| [OH_AudioStreamBuilder_SetEncodingType](#oh_audiostreambuilder_setencodingtype) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioStream_EncodingType](#oh_audiostream_encodingtype) encodingType) | 设置音频流的编码类型属性。 |
97| [OH_AudioStreamBuilder_SetLatencyMode](#oh_audiostreambuilder_setlatencymode) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioStream_LatencyMode](#oh_audiostream_latencymode) latencyMode) | 设置音频流的时延模式。 |
98| [OH_AudioStreamBuilder_SetRendererInfo](#oh_audiostreambuilder_setrendererinfo) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioStream_Usage](#oh_audiostream_usage) usage) | 设置输出音频流的工作场景。 |
99| [OH_AudioStreamBuilder_SetCapturerInfo](#oh_audiostreambuilder_setcapturerinfo) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioStream_SourceType](#oh_audiostream_sourcetype) sourceType) | 设置输入音频流的工作场景。 |
100| [OH_AudioStreamBuilder_SetRendererCallback](#oh_audiostreambuilder_setrenderercallback) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioRenderer_Callbacks](#oh_audiorenderer_callbacks) callbacks, void \*userData) | 设置输出音频流的回调。 |
101| [OH_AudioStreamBuilder_SetCapturerCallback](#oh_audiostreambuilder_setcapturercallback) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioCapturer_Callbacks](#oh_audiocapturer_callbacks) callbacks, void \*userData) | 设置输入音频流的回调。 |
102| [OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioRenderer](#oh_audiorenderer) \*\*audioRenderer) | 创建输出音频流实例。 |
103| [OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer) ([OH_AudioStreamBuilder](#oh_audiostreambuilder) \*builder, [OH_AudioCapturer](#oh_audiocapturer) \*\*audioCapturer) | 创建输入音频流实例。 |
104
105
106### 变量
107
108| 名称 | 描述 |
109| -------- | -------- |
110| (\*[OH_AudioRenderer_Callbacks_Struct::OH_AudioRenderer_OnWriteData](#oh_audiorenderer_onwritedata) )([OH_AudioRenderer](#oh_audiorenderer) \*renderer, void \*userData, void \*buffer, int32_t lenth) | 该函数指针将指向用于写入音频数据的回调函数。 |
111| (\*[OH_AudioCapturer_Callbacks_Struct::OH_AudioCapturer_OnReadData](#oh_audiocapturer_onreaddata) )([OH_AudioCapturer](#oh_audiocapturer) \*capturer, void \*userData, void \*buffer, int32_t lenth) | 该函数指针将指向用于读取音频数据的回调函数。 |
112
113
114## 类型定义说明
115
116
117### OH_AudioCapturer
118
119
120```
121typedef struct OH_AudioCapturerStruct OH_AudioCapturer
122```
123
124**描述:**
125
126声明输入音频流。
127
128输入音频流的实例被用来获取音频数据。
129
130\@syscap SystemCapability.Multimedia.Audio.Core
131
132**起始版本:**
133
13410
135
136
137### OH_AudioCapturer_Callbacks
138
139
140```
141typedef struct OH_AudioCapturer_Callbacks_Struct OH_AudioCapturer_Callbacks
142```
143
144**描述:**
145
146声明输入音频流的回调函数指针。
147
148\@syscap SystemCapability.Multimedia.Audio.Core
149
150**起始版本:**
151
15210
153
154
155### OH_AudioRenderer
156
157
158```
159typedef struct OH_AudioRendererStruct OH_AudioRenderer
160```
161
162**描述:**
163
164声明输出音频流。
165
166输出音频流的实例被用来播放音频数据。
167
168\@syscap SystemCapability.Multimedia.Audio.Core
169
170**起始版本:**
171
17210
173
174
175### OH_AudioRenderer_Callbacks
176
177
178```
179typedef struct OH_AudioRenderer_Callbacks_Struct OH_AudioRenderer_Callbacks
180```
181
182**描述:**
183
184声明输出音频流的回调函数指针。
185
186\@syscap SystemCapability.Multimedia.Audio.Core
187
188**起始版本:**
189
19010
191
192
193### OH_AudioStreamBuilder
194
195
196```
197typedef struct OH_AudioStreamBuilderStruct OH_AudioStreamBuilder
198```
199
200**描述:**
201
202声明音频流的构造器。
203
204构造器实例通常被用来设置音频流属性和创建音频流。
205
206\@syscap SystemCapability.Multimedia.Audio.Core
207
208**起始版本:**
209
21010
211
212
213## 枚举类型说明
214
215
216### OH_AudioStream_EncodingType
217
218
219```
220enum OH_AudioStream_EncodingType
221```
222
223**描述:**
224
225定义音频流编码类型。
226
227\@syscap SystemCapability.Multimedia.Audio.Core
228
229**起始版本:**
230
23110
232
233  | 枚举值 | 描述 |
234| -------- | -------- |
235| AUDIOSTREAM_ENCODING_TYPE_RAW | PCM编码。 |
236
237
238### OH_AudioStream_LatencyMode
239
240
241```
242enum OH_AudioStream_LatencyMode
243```
244
245**描述:**
246
247定义音频时延模式。
248
249\@syscap SystemCapability.Multimedia.Audio.Core
250
251**起始版本:**
252
25310
254
255  | 枚举值 | 描述 |
256| -------- | -------- |
257| AUDIOSTREAM_LATENCY_MODE_NORMAL | 该模式代表一个普通时延的音频流。 |
258| AUDIOSTREAM_LATENCY_MODE_FAST | 该模式代表一个低时延的音频流。 |
259
260
261### OH_AudioStream_Result
262
263
264```
265enum OH_AudioStream_Result
266```
267
268**描述:**
269
270音频结果码。
271
272\@syscap SystemCapability.Multimedia.Audio.Core
273
274**起始版本:**
275
27610
277
278  | 枚举值 | 描述 |
279| -------- | -------- |
280| AUDIOSTREAM_SUCCESS | 操作成功 |
281| AUDIOSTREAM_ERROR_INVALID_PARAM | 入参错误。 |
282| AUDIOSTREAM_ERROR_ILLEGAL_STATE | 非法状态。 |
283| AUDIOSTREAM_ERROR_SYSTEM | 系统通用错误。 |
284
285
286### OH_AudioStream_SampleFormat
287
288
289```
290enum OH_AudioStream_SampleFormat
291```
292
293**描述:**
294
295定义音频流采样格式。
296
297\@syscap SystemCapability.Multimedia.Audio.Core
298
299**起始版本:**
300
30110
302
303  | 枚举值 | 描述 |
304| -------- | -------- |
305| AUDIOSTREAM_SAMPLE_U8 | Unsigned 8位。 |
306| AUDIOSTREAM_SAMPLE_S16LE | Short 16位小端。 |
307| AUDIOSTREAM_SAMPLE_S24LE | Short 24位小端。 |
308| AUDIOSTREAM_SAMPLE_S32LE | Short 32位小端。 |
309
310
311### OH_AudioStream_SourceType
312
313
314```
315enum OH_AudioStream_SourceType
316```
317
318**描述:**
319
320定义音频流使用场景。
321
322通常用来描述音频输入流的使用场景。
323
324\@syscap SystemCapability.Multimedia.Audio.Core
325
326**起始版本:**
327
32810
329
330  | 枚举值 | 描述 |
331| -------- | -------- |
332| AUDIOSTREAM_SOURCE_TYPE_INVALID | 不合法状态。 |
333| AUDIOSTREAM_SOURCE_TYPE_MIC | 录音。 |
334| AUDIOSTREAM_SOURCE_TYPE_VOICE_RECOGNITION | 语音识别。 |
335| AUDIOSTREAM_SOURCE_TYPE_VOICE_COMMUNICATION | 通话。 |
336
337
338### OH_AudioStream_State
339
340
341```
342enum OH_AudioStream_State
343```
344
345**描述:**
346
347定义音频流的状态。
348
349\@syscap SystemCapability.Multimedia.Audio.Core
350
351**起始版本:**
352
35310
354
355  | 枚举值 | 描述 |
356| -------- | -------- |
357| AUDIOSTREAM_STATE_INVALID | 不合法的状态。 |
358| AUDIOSTREAM_STATE_PREPARED | 准备状态。 |
359| AUDIOSTREAM_STATE_RUNNING | 工作状态。 |
360| AUDIOSTREAM_STATE_STOPPED | 停止状态。 |
361| AUDIOSTREAM_STATE_RELEASED | 释放状态。 |
362| AUDIOSTREAM_STATE_PAUSED | 暂停状态。 |
363
364
365### OH_AudioStream_Type
366
367
368```
369enum OH_AudioStream_Type
370```
371
372**描述:**
373
374音频流类型。
375
376\@syscap SystemCapability.Multimedia.Audio.Core
377
378**起始版本:**
379
38010
381
382  | 枚举值 | 描述 |
383| -------- | -------- |
384| AUDIOSTREAM_TYPE_RENDERER | 该类型代表音频流是输出流。 |
385| AUDIOSTREAM_TYPE_CAPTURER | 该类型代表音频流是输入流。 |
386
387
388### OH_AudioStream_Usage
389
390
391```
392enum OH_AudioStream_Usage
393```
394
395**描述:**
396
397定义音频流使用场景。
398
399通常用来描述音频输出流的使用场景。
400
401\@syscap SystemCapability.Multimedia.Audio.Core
402
403**起始版本:**
404
40510
406
407  | 枚举值 | 描述 |
408| -------- | -------- |
409| AUDIOSTREAM_USAGE_UNKNOWN | 未定义。 |
410| AUDIOSTREAM_USAGE_MUSIC | 音乐。 |
411| AUDIOSTREAM_USAGE_COMMUNICATION | 通话。 |
412| AUDIOSTREAM_USAGE_GAME | 游戏。 |
413
414
415## 函数说明
416
417
418### OH_AudioCapturer_Flush()
419
420
421```
422OH_AudioStream_Result OH_AudioCapturer_Flush (OH_AudioCapturer * capturer)
423```
424
425**描述:**
426
427丢弃获取的音频数据。
428
429**参数:**
430
431| 名称 | 描述 |
432| -------- | -------- |
433| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
434
435**返回:**
436
437AUDIOSTREAM_SUCCESS 或者一个预期之外的错误。
438
439**起始版本:**
440
44110
442
443
444### OH_AudioCapturer_GetCapturerInfo()
445
446
447```
448OH_AudioStream_Result OH_AudioCapturer_GetCapturerInfo (OH_AudioCapturer * capturer, OH_AudioStream_SourceType * sourceType )
449```
450
451**描述:**
452
453查询当前输入音频流工作场景类型。
454
455**参数:**
456
457| 名称 | 描述 |
458| -------- | -------- |
459| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
460| sourceType | 指向一个用来接收输入类型音频流的工作场景的变量。 |
461
462**返回:**
463
464AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
465
466**起始版本:**
467
46810
469
470
471### OH_AudioCapturer_GetChannelCount()
472
473
474```
475OH_AudioStream_Result OH_AudioCapturer_GetChannelCount (OH_AudioCapturer * capturer, int32_t * channelCount )
476```
477
478**描述:**
479
480查询当前输入音频流通道数。
481
482**参数:**
483
484| 名称 | 描述 |
485| -------- | -------- |
486| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
487| channelCount | 指向一个用来接收音频流通道数的变量。 |
488
489**返回:**
490
491AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
492
493**起始版本:**
494
49510
496
497
498### OH_AudioCapturer_GetCurrentState()
499
500
501```
502OH_AudioStream_Result OH_AudioCapturer_GetCurrentState (OH_AudioCapturer * capturer, OH_AudioStream_State * state )
503```
504
505**描述:**
506
507查询当前输入音频流状态。
508
509**参数:**
510
511| 名称 | 描述 |
512| -------- | -------- |
513| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
514| state | 指向一个用来接收音频流状态的变量。 |
515
516**返回:**
517
518AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
519
520**起始版本:**
521
52210
523
524
525### OH_AudioCapturer_GetEncodingType()
526
527
528```
529OH_AudioStream_Result OH_AudioCapturer_GetEncodingType (OH_AudioCapturer * capturer, OH_AudioStream_EncodingType * encodingType )
530```
531
532**描述:**
533
534查询当前输入音频流编码类型。
535
536**参数:**
537
538| 名称 | 描述 |
539| -------- | -------- |
540| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
541| encodingType | 指向一个用来接收音频流编码类型的变量。 |
542
543**返回:**
544
545AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
546
547**起始版本:**
548
54910
550
551
552### OH_AudioCapturer_GetLatencyMode()
553
554
555```
556OH_AudioStream_Result OH_AudioCapturer_GetLatencyMode (OH_AudioCapturer * capturer, OH_AudioStream_LatencyMode * latencyMode )
557```
558
559**描述:**
560
561查询当前输入音频流时延模式。
562
563**参数:**
564
565| 名称 | 描述 |
566| -------- | -------- |
567| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
568| latencyMode | 指向一个用来接收音频流时延模式的变量。 |
569
570**返回:**
571
572AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
573
574**起始版本:**
575
57610
577
578
579### OH_AudioCapturer_GetSampleFormat()
580
581
582```
583OH_AudioStream_Result OH_AudioCapturer_GetSampleFormat (OH_AudioCapturer * capturer, OH_AudioStream_SampleFormat * sampleFormat )
584```
585
586**描述:**
587
588查询当前输入音频流采样格式。
589
590**参数:**
591
592| 名称 | 描述 |
593| -------- | -------- |
594| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
595| sampleFormat | 指向一个用来接收音频流采样格式的变量。 |
596
597**返回:**
598
599AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
600
601**起始版本:**
602
60310
604
605
606### OH_AudioCapturer_GetSamplingRate()
607
608
609```
610OH_AudioStream_Result OH_AudioCapturer_GetSamplingRate (OH_AudioCapturer * capturer, int32_t * rate )
611```
612
613**描述:**
614
615查询当前输入音频流采样率。
616
617**参数:**
618
619| 名称 | 描述 |
620| -------- | -------- |
621| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
622| rate | 指向一个用来接收音频流采样率的变量。 |
623
624**返回:**
625
626AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
627
628**起始版本:**
629
63010
631
632
633### OH_AudioCapturer_GetStreamId()
634
635
636```
637OH_AudioStream_Result OH_AudioCapturer_GetStreamId (OH_AudioCapturer * capturer, uint32_t * streamId )
638```
639
640**描述:**
641
642查询当前输入音频流ID。
643
644**参数:**
645
646| 名称 | 描述 |
647| -------- | -------- |
648| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
649| streamId | 指向一个用来接收音频流ID的变量。 |
650
651**返回:**
652
653AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
654
655**起始版本:**
656
65710
658
659
660### OH_AudioCapturer_Pause()
661
662
663```
664OH_AudioStream_Result OH_AudioCapturer_Pause (OH_AudioCapturer * capturer)
665```
666
667**描述:**
668
669暂停输入音频流。
670
671**参数:**
672
673| 名称 | 描述 |
674| -------- | -------- |
675| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
676
677**返回:**
678
679AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
680
681**起始版本:**
682
68310
684
685
686### OH_AudioCapturer_Release()
687
688
689```
690OH_AudioStream_Result OH_AudioCapturer_Release (OH_AudioCapturer * capturer)
691```
692
693**描述:**
694
695释放输入音频流。
696
697**参数:**
698
699| 名称 | 描述 |
700| -------- | -------- |
701| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
702
703**返回:**
704
705AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
706
707**起始版本:**
708
70910
710
711
712### OH_AudioCapturer_Start()
713
714
715```
716OH_AudioStream_Result OH_AudioCapturer_Start (OH_AudioCapturer * capturer)
717```
718
719**描述:**
720
721开始获取音频数据。
722
723**参数:**
724
725| 名称 | 描述 |
726| -------- | -------- |
727| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
728
729**返回:**
730
731AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
732
733**起始版本:**
734
73510
736
737
738### OH_AudioCapturer_Stop()
739
740
741```
742OH_AudioStream_Result OH_AudioCapturer_Stop (OH_AudioCapturer * capturer)
743```
744
745**描述:**
746
747停止输入音频流
748
749**参数:**
750
751| 名称 | 描述 |
752| -------- | -------- |
753| capturer | 指向[OH_AudioStreamBuilder_GenerateCapturer](#oh_audiostreambuilder_generatecapturer)创建的音频流实例。 |
754
755**返回:**
756
757AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
758
759**起始版本:**
760
76110
762
763
764### OH_AudioRenderer_Flush()
765
766
767```
768OH_AudioStream_Result OH_AudioRenderer_Flush (OH_AudioRenderer * renderer)
769```
770
771**描述:**
772
773丢弃已经写入的音频数据。
774
775**参数:**
776
777| 名称 | 描述 |
778| -------- | -------- |
779| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
780
781**返回:**
782
783AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
784
785**起始版本:**
786
78710
788
789
790### OH_AudioRenderer_GetChannelCount()
791
792
793```
794OH_AudioStream_Result OH_AudioRenderer_GetChannelCount (OH_AudioRenderer * renderer, int32_t * channelCount )
795```
796
797**描述:**
798
799查询当前输出音频流通道数。
800
801**参数:**
802
803| 名称 | 描述 |
804| -------- | -------- |
805| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
806| channelCount | 指向一个用来接收音频流通道数的变量。 |
807
808**返回:**
809
810AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
811
812**起始版本:**
813
81410
815
816
817### OH_AudioRenderer_GetCurrentState()
818
819
820```
821OH_AudioStream_Result OH_AudioRenderer_GetCurrentState (OH_AudioRenderer * renderer, OH_AudioStream_State * state )
822```
823
824**描述:**
825
826查询当前输出音频流状态。
827
828**参数:**
829
830| 名称 | 描述 |
831| -------- | -------- |
832| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
833| state | 指向一个用来接收音频流状态的变量。 |
834
835**返回:**
836
837AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
838
839**起始版本:**
840
84110
842
843
844### OH_AudioRenderer_GetEncodingType()
845
846
847```
848OH_AudioStream_Result OH_AudioRenderer_GetEncodingType (OH_AudioRenderer * renderer, OH_AudioStream_EncodingType * encodingType )
849```
850
851**描述:**
852
853查询当前输出音频流编码类型。
854
855**参数:**
856
857| 名称 | 描述 |
858| -------- | -------- |
859| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
860| encodingType | 指向一个用来接收音频流编码类型的变量。 |
861
862**返回:**
863
864AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
865
866**起始版本:**
867
86810
869
870
871### OH_AudioRenderer_GetLatencyMode()
872
873
874```
875OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode (OH_AudioRenderer * renderer, OH_AudioStream_LatencyMode * latencyMode )
876```
877
878**描述:**
879
880查询当前输出音频流时延模式。
881
882**参数:**
883
884| 名称 | 描述 |
885| -------- | -------- |
886| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
887| latencyMode | 指向一个用来接收音频流时延模式的变量。 |
888
889**返回:**
890
891AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
892
893**起始版本:**
894
89510
896
897
898### OH_AudioRenderer_GetRendererInfo()
899
900
901```
902OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo (OH_AudioRenderer * renderer, OH_AudioStream_Usage * usage )
903```
904
905**描述:**
906
907查询当前输出音频流工作场景类型。
908
909**参数:**
910
911| 名称 | 描述 |
912| -------- | -------- |
913| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
914| usage | 指向一个用来接收输出类型音频流的工作场景的变量。 |
915
916**返回:**
917
918AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
919
920**起始版本:**
921
92210
923
924
925### OH_AudioRenderer_GetSampleFormat()
926
927
928```
929OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat (OH_AudioRenderer * renderer, OH_AudioStream_SampleFormat * sampleFormat )
930```
931
932**描述:**
933
934查询当前输出音频流采样格式。
935
936**参数:**
937
938| 名称 | 描述 |
939| -------- | -------- |
940| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
941| sampleFormat | 指向一个用来接收音频流采样格式的变量。 |
942
943**返回:**
944
945AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
946
947**起始版本:**
948
94910
950
951
952### OH_AudioRenderer_GetSamplingRate()
953
954
955```
956OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate (OH_AudioRenderer * renderer, int32_t * rate )
957```
958
959**描述:**
960
961查询当前输出音频流采样率。
962
963**参数:**
964
965| 名称 | 描述 |
966| -------- | -------- |
967| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
968| rate | 指向一个用来接收音频流采样率的变量。 |
969
970**返回:**
971
972AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
973
974**起始版本:**
975
97610
977
978
979### OH_AudioRenderer_GetStreamId()
980
981
982```
983OH_AudioStream_Result OH_AudioRenderer_GetStreamId (OH_AudioRenderer * renderer, uint32_t * streamId )
984```
985
986**描述:**
987
988查询当前输出音频流ID。
989
990**参数:**
991
992| 名称 | 描述 |
993| -------- | -------- |
994| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
995| streamId | 指向一个用来接收音频流ID的变量。 |
996
997**返回:**
998
999AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1000
1001**起始版本:**
1002
100310
1004
1005
1006### OH_AudioRenderer_Pause()
1007
1008
1009```
1010OH_AudioStream_Result OH_AudioRenderer_Pause (OH_AudioRenderer * renderer)
1011```
1012
1013**描述:**
1014
1015暂停输出音频流。
1016
1017**参数:**
1018
1019| 名称 | 描述 |
1020| -------- | -------- |
1021| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
1022
1023**返回:**
1024
1025AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1026
1027**起始版本:**
1028
102910
1030
1031
1032### OH_AudioRenderer_Release()
1033
1034
1035```
1036OH_AudioStream_Result OH_AudioRenderer_Release (OH_AudioRenderer * renderer)
1037```
1038
1039**描述:**
1040
1041释放输出音频流。
1042
1043**参数:**
1044
1045| 名称 | 描述 |
1046| -------- | -------- |
1047| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
1048
1049**返回:**
1050
1051AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1052
1053**起始版本:**
1054
105510
1056
1057
1058### OH_AudioRenderer_Start()
1059
1060
1061```
1062OH_AudioStream_Result OH_AudioRenderer_Start (OH_AudioRenderer * renderer)
1063```
1064
1065**描述:**
1066
1067开始输出音频数据。
1068
1069**参数:**
1070
1071| 名称 | 描述 |
1072| -------- | -------- |
1073| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
1074
1075**返回:**
1076
1077AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1078
1079**起始版本:**
1080
108110
1082
1083
1084### OH_AudioRenderer_Stop()
1085
1086
1087```
1088OH_AudioStream_Result OH_AudioRenderer_Stop (OH_AudioRenderer * renderer)
1089```
1090
1091**描述:**
1092
1093停止输出音频流
1094
1095**参数:**
1096
1097| 名称 | 描述 |
1098| -------- | -------- |
1099| renderer | 指向[OH_AudioStreamBuilder_GenerateRenderer](#oh_audiostreambuilder_generaterenderer)创建的音频流实例。 |
1100
1101**返回:**
1102
1103AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1104
1105**起始版本:**
1106
110710
1108
1109
1110### OH_AudioStreamBuilder_Create()
1111
1112
1113```
1114OH_AudioStream_Result OH_AudioStreamBuilder_Create (OH_AudioStreamBuilder ** builder, OH_AudioStream_Type type )
1115```
1116
1117**描述:**
1118
1119创建一个输入或者输出类型的音频流构造器。
1120
1121当构造器不再使用时,需要调用OH_AudioStreamBuilder_Destroy()销毁它。
1122
1123**参数:**
1124
1125| 名称 | 描述 |
1126| -------- | -------- |
1127| builder | 该引用指向创建的构造器的结果。 |
1128| type | 构造器的流类型。AUDIOSTREAM_TYPE_RENDERER or AUDIOSTREAM_TYPE_CAPTURER |
1129
1130**返回:**
1131
1132AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1133
1134**起始版本:**
1135
113610
1137
1138
1139### OH_AudioStreamBuilder_Destroy()
1140
1141
1142```
1143OH_AudioStream_Result OH_AudioStreamBuilder_Destroy (OH_AudioStreamBuilder * builder)
1144```
1145
1146**描述:**
1147
1148销毁一个音频流构造器。
1149
1150当构造器不再使用时,需要调用该函数销毁它。
1151
1152**参数:**
1153
1154| 名称 | 描述 |
1155| -------- | -------- |
1156| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1157
1158**返回:**
1159
1160AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1161
1162**起始版本:**
1163
116410
1165
1166
1167### OH_AudioStreamBuilder_GenerateCapturer()
1168
1169
1170```
1171OH_AudioStream_Result OH_AudioStreamBuilder_GenerateCapturer (OH_AudioStreamBuilder * builder, OH_AudioCapturer ** audioCapturer )
1172```
1173
1174**描述:**
1175
1176创建输入音频流实例。
1177
1178**参数:**
1179
1180| 名称 | 描述 |
1181| -------- | -------- |
1182| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1183| audioCapturer | 指向输入音频流实例的指针,将被用来接收函数创建的结果。 |
1184
1185**返回:**
1186
1187AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1188
1189**起始版本:**
1190
119110
1192
1193
1194### OH_AudioStreamBuilder_GenerateRenderer()
1195
1196
1197```
1198OH_AudioStream_Result OH_AudioStreamBuilder_GenerateRenderer (OH_AudioStreamBuilder * builder, OH_AudioRenderer ** audioRenderer )
1199```
1200
1201**描述:**
1202
1203创建输出音频流实例。
1204
1205**参数:**
1206
1207| 名称 | 描述 |
1208| -------- | -------- |
1209| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1210| audioRenderer | 指向输出音频流实例的指针,将被用来接收函数创建的结果。 |
1211
1212**返回:**
1213
1214AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1215
1216**起始版本:**
1217
121810
1219
1220
1221### OH_AudioStreamBuilder_SetCapturerCallback()
1222
1223
1224```
1225OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerCallback (OH_AudioStreamBuilder * builder, OH_AudioCapturer_Callbacks callbacks, void * userData )
1226```
1227
1228**描述:**
1229
1230设置输入音频流的回调。
1231
1232**参数:**
1233
1234| 名称 | 描述 |
1235| -------- | -------- |
1236| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1237| callbacks | 将被用来处理输入音频流相关事件的回调函数。 |
1238| userData | 指向通过回调函数传递的应用数据指针。 |
1239
1240**返回:**
1241
1242AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1243
1244**起始版本:**
1245
124610
1247
1248
1249### OH_AudioStreamBuilder_SetCapturerInfo()
1250
1251
1252```
1253OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerInfo (OH_AudioStreamBuilder * builder, OH_AudioStream_SourceType sourceType )
1254```
1255
1256**描述:**
1257
1258设置输入音频流的工作场景。
1259
1260**参数:**
1261
1262| 名称 | 描述 |
1263| -------- | -------- |
1264| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1265| sourceType | 输入音频流属性,使用的工作场景。 |
1266
1267**返回:**
1268
1269AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1270
1271**起始版本:**
1272
127310
1274
1275
1276### OH_AudioStreamBuilder_SetChannelCount()
1277
1278
1279```
1280OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelCount (OH_AudioStreamBuilder * builder, int32_t channelCount )
1281```
1282
1283**描述:**
1284
1285设置音频流的通道数属性。
1286
1287**参数:**
1288
1289| 名称 | 描述 |
1290| -------- | -------- |
1291| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1292| channelCount | 音频流通道数。 |
1293
1294**返回:**
1295
1296AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1297
1298**起始版本:**
1299
130010
1301
1302
1303### OH_AudioStreamBuilder_SetEncodingType()
1304
1305
1306```
1307OH_AudioStream_Result OH_AudioStreamBuilder_SetEncodingType (OH_AudioStreamBuilder * builder, OH_AudioStream_EncodingType encodingType )
1308```
1309
1310**描述:**
1311
1312设置音频流的编码类型属性。
1313
1314**参数:**
1315
1316| 名称 | 描述 |
1317| -------- | -------- |
1318| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1319| encodingType | 音频流编码类型, **AUDIOSTREAM_ENCODING_PCM** |
1320
1321**返回:**
1322
1323AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1324
1325**起始版本:**
1326
132710
1328
1329
1330### OH_AudioStreamBuilder_SetLatencyMode()
1331
1332
1333```
1334OH_AudioStream_Result OH_AudioStreamBuilder_SetLatencyMode (OH_AudioStreamBuilder * builder, OH_AudioStream_LatencyMode latencyMode )
1335```
1336
1337**描述:**
1338
1339设置音频流的时延模式。
1340
1341**参数:**
1342
1343| 名称 | 描述 |
1344| -------- | -------- |
1345| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1346| latencyMode | 音频流时延模式。 |
1347
1348**返回:**
1349
1350AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1351
1352**起始版本:**
1353
135410
1355
1356
1357### OH_AudioStreamBuilder_SetRendererCallback()
1358
1359
1360```
1361OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererCallback (OH_AudioStreamBuilder * builder, OH_AudioRenderer_Callbacks callbacks, void * userData )
1362```
1363
1364**描述:**
1365
1366设置输出音频流的回调。
1367
1368**参数:**
1369
1370| 名称 | 描述 |
1371| -------- | -------- |
1372| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1373| callbacks | 将被用来处理输出音频流相关事件的回调函数。 |
1374| userData | 指向通过回调函数传递的应用数据指针。 |
1375
1376**返回:**
1377
1378AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1379
1380**起始版本:**
1381
138210
1383
1384
1385### OH_AudioStreamBuilder_SetRendererInfo()
1386
1387
1388```
1389OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererInfo (OH_AudioStreamBuilder * builder, OH_AudioStream_Usage usage )
1390```
1391
1392**描述:**
1393
1394设置输出音频流的工作场景。
1395
1396**参数:**
1397
1398| 名称 | 描述 |
1399| -------- | -------- |
1400| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1401| usage | 输出音频流属性,使用的工作场景。 |
1402
1403**返回:**
1404
1405AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1406
1407**起始版本:**
1408
140910
1410
1411
1412### OH_AudioStreamBuilder_SetSampleFormat()
1413
1414
1415```
1416OH_AudioStream_Result OH_AudioStreamBuilder_SetSampleFormat (OH_AudioStreamBuilder * builder, OH_AudioStream_SampleFormat format )
1417```
1418
1419**描述:**
1420
1421设置音频流的采样格式属性。
1422
1423**参数:**
1424
1425| 名称 | 描述 |
1426| -------- | -------- |
1427| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1428| format | 音频流采样格式。 |
1429
1430**返回:**
1431
1432AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1433
1434**起始版本:**
1435
143610
1437
1438
1439### OH_AudioStreamBuilder_SetSamplingRate()
1440
1441
1442```
1443OH_AudioStream_Result OH_AudioStreamBuilder_SetSamplingRate (OH_AudioStreamBuilder * builder, int32_t rate )
1444```
1445
1446**描述:**
1447
1448设置音频流的采样率属性。
1449
1450**参数:**
1451
1452| 名称 | 描述 |
1453| -------- | -------- |
1454| builder | 指向OH_AudioStreamBuilder_Create()创建的构造器实例。 |
1455| channelCount | 音频流采样率。 |
1456
1457**返回:**
1458
1459AUDIOSTREAM_SUCCESS 或者一个不期望发生的错误。
1460
1461**起始版本:**
1462
146310
1464
1465
1466## 变量说明
1467
1468
1469### OH_AudioCapturer_OnReadData
1470
1471
1472```
1473int32_t(* OH_AudioCapturer_Callbacks_Struct::OH_AudioCapturer_OnReadData) (OH_AudioCapturer *capturer, void *userData, void *buffer, int32_t lenth)
1474```
1475
1476**描述:**
1477
1478该函数指针将指向用于读取音频数据的回调函数。
1479
1480**起始版本:**
1481
148210
1483
1484
1485### OH_AudioRenderer_OnWriteData
1486
1487
1488```
1489int32_t(* OH_AudioRenderer_Callbacks_Struct::OH_AudioRenderer_OnWriteData) (OH_AudioRenderer *renderer, void *userData, void *buffer, int32_t lenth)
1490```
1491
1492**描述:**
1493
1494该函数指针将指向用于写入音频数据的回调函数。
1495
1496**起始版本:**
1497
149810
1499