• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AudioEncoder
2
3
4## 概述
5
6AudioEncoder模块提供用于音频编码的函数。
7
8**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
9
10**起始版本：** 9
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) | 声明用于音频编码的Native API。 |
21
22
23### 函数
24
25| 名称 | 描述 |
26| -------- | -------- |
27| OH_AVCodec \* [OH_AudioEncoder_CreateByMime](#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例。 |
28| OH_AVCodec \* [OH_AudioEncoder_CreateByName](#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例。 |
29| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Destroy](#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源，销毁编码器实例。 |
30| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_SetCallback](#oh_audioencoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | 设置异步回调函数，使应用可以响应音频编码器生成的事件。 |
31| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Configure](#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频编码器，通常需要配置编码后的音轨的描述信息。 |
32| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Prepare](#oh_audioencoder_prepare) (OH_AVCodec \*codec) | 准备编码器的内部资源。 |
33| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Start](#oh_audioencoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动编码器。 |
34| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Stop](#oh_audioencoder_stop) (OH_AVCodec \*codec) | 停止编码器。 |
35| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Flush](#oh_audioencoder_flush) (OH_AVCodec \*codec) | 清除编码器中缓存的输入和输出数据。 |
36| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_Reset](#oh_audioencoder_reset) (OH_AVCodec \*codec) | 重置编码器。 |
37| OH_AVFormat \* [OH_AudioEncoder_GetOutputDescription](#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | 获取编码器输出数据的描述信息。 |
38| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_SetParameter](#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 |
39| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_PushInputData](#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | 将填充有数据的输入缓冲区提交给音频编码器。 |
40| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_FreeOutputData](#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
41| [OH_AVErrCode](_core.md#oh_averrcode)[OH_AudioEncoder_IsValid](#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效，可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态。 |
42
43
44## 函数说明
45
46
47### OH_AudioEncoder_Configure()
48
49```
50OH_AVErrCode OH_AudioEncoder_Configure (OH_AVCodec *codec, OH_AVFormat *format)
51```
52
53**描述**
54
55要配置音频编码器，通常需要配置编码后的音轨的描述信息。在调用Prepare之前，必须调用此接口。
56
57**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
58
59**起始版本：** 9
60
61**废弃版本：** 11
62
63**替代接口：**[OH_AudioCodec_Configure](_audio_codec.md#oh_audiocodec_configure)
64
65**参数:**
66
67| 名称 | 描述 |
68| -------- | -------- |
69| codec | 指向OH_AVCodec实例的指针。 |
70| format | 指向OH_AVFormat的指针，给出要编码的音频轨道的描述。 |
71
72**返回：**
73
74如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
75
76
77### OH_AudioEncoder_CreateByMime()
78
79```
80OH_AVCodec* OH_AudioEncoder_CreateByMime (const char *mime)
81```
82
83**描述**
84
85根据MIME类型创建音频编码器实例，大多数场景下建议使用此方式。
86
87**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
88
89**起始版本：** 9
90
91**废弃版本：** 11
92
93**替代接口：**[OH_AudioCodec_CreateByMime](_audio_codec.md#oh_audiocodec_createbymime)
94
95**参数:**
96
97| 名称 | 描述 |
98| -------- | -------- |
99| mime | MIME类型描述字符串，请参阅[AVCODEC_MIMETYPE](_codec_base.md#变量)。 |
100
101**返回：**
102
103返回指向OH_AVCodec实例的指针。
104
105
106### OH_AudioEncoder_CreateByName()
107
108```
109OH_AVCodec* OH_AudioEncoder_CreateByName (const char *name)
110```
111
112**描述**
113
114通过音频编码器名称创建音频编码器实例，使用此接口的前提是知道编码器的确切名称。
115
116**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
117
118**起始版本：** 9
119
120**废弃版本：** 11
121
122**替代接口：**[OH_AudioCodec_CreateByName](_audio_codec.md#oh_audiocodec_createbyname)
123
124**参数:**
125
126| 名称 | 描述 |
127| -------- | -------- |
128| name | 音频编码器名称。 |
129
130**返回：**
131
132返回指向OH_AVCodec实例的指针。
133
134
135### OH_AudioEncoder_Destroy()
136
137```
138OH_AVErrCode OH_AudioEncoder_Destroy (OH_AVCodec *codec)
139```
140
141**描述**
142
143清理编码器内部资源，销毁编码器实例。
144
145**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
146
147**起始版本：** 9
148
149**废弃版本：** 11
150
151**替代接口：**[OH_AudioCodec_Destroy](_audio_codec.md#oh_audiocodec_destroy)
152
153**参数:**
154
155| 名称 | 描述 |
156| -------- | -------- |
157| codec | 指向OH_AVCodec实例的指针。 |
158
159**返回：**
160
161如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
162
163
164### OH_AudioEncoder_Flush()
165
166```
167OH_AVErrCode OH_AudioEncoder_Flush (OH_AVCodec *codec)
168```
169
170**描述**
171
172清除编码器中缓存的输入和输出数据。
173
174调用此接口后，以前通过异步回调上报的所有缓冲区索引都将失效，请确保不要访问这些索引对应的缓冲区。
175
176**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
177
178**起始版本：** 9
179
180**废弃版本：** 11
181
182**替代接口：**[OH_AudioCodec_Flush](_audio_codec.md#oh_audiocodec_flush)
183
184**参数:**
185
186| 名称 | 描述 |
187| -------- | -------- |
188| codec | 指向OH_AVCodec实例的指针。 |
189
190**返回：**
191
192如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
193
194
195### OH_AudioEncoder_FreeOutputData()
196
197```
198OH_AVErrCode OH_AudioEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index)
199```
200
201**描述**
202
203将处理后的输出缓冲区返回给编码器。
204
205**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
206
207**起始版本：** 9
208
209**废弃版本：** 11
210
211**替代接口：**[OH_AudioCodec_FreeOutputBuffer](_audio_codec.md#oh_audiocodec_freeoutputbuffer)
212
213**参数:**
214
215| 名称 | 描述 |
216| -------- | -------- |
217| codec | 指向OH_AVCodec实例的指针。 |
218| index | 输出缓冲区Buffer对应的索引值。 |
219
220**返回：**
221
222如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
223
224
225### OH_AudioEncoder_GetOutputDescription()
226
227```
228OH_AVFormat* OH_AudioEncoder_GetOutputDescription (OH_AVCodec *codec)
229```
230
231**描述**
232
233获取编码器输出数据的描述信息。 需要注意的是，返回值所指向的OH_AVFormat实例的生命周期需要调用者手动释放。
234
235**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
236
237**起始版本：** 9
238
239**废弃版本：** 11
240
241**替代接口：**[OH_AudioCodec_GetOutputDescription](_audio_codec.md#oh_audiocodec_getoutputdescription)
242
243**参数:**
244
245| 名称 | 描述 |
246| -------- | -------- |
247| codec | 指向OH_AVCodec实例的指针。 |
248
249**返回：**
250
251返回OH_AVFormat句柄指针，生命周期将使用下一个GetOutputDescription 刷新，或使用OH_AVCodec销毁。
252
253
254### OH_AudioEncoder_IsValid()
255
256```
257OH_AVErrCode OH_AudioEncoder_IsValid (OH_AVCodec *codec, bool *isValid)
258```
259
260**描述**
261
262检查当前编码器实例是否有效，可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态。
263
264**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
265
266**起始版本：** 10
267
268**废弃版本：** 11
269
270**替代接口：**[OH_AudioCodec_IsValid](_audio_codec.md#oh_audiocodec_isvalid)
271
272**参数:**
273
274| 名称 | 描述 |
275| -------- | -------- |
276| codec | 指向OH_AVCodec实例的指针。 |
277| isValid | 指向布尔实例的指针，true：编码器实例有效，false：编码器实例无效。 |
278
279**返回：**
280
281如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
282
283
284### OH_AudioEncoder_Prepare()
285
286```
287OH_AVErrCode OH_AudioEncoder_Prepare (OH_AVCodec *codec)
288```
289
290**描述**
291
292准备编码器的内部资源，在调用此接口之前必须调用Configure接口。
293
294**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
295
296**起始版本：** 9
297
298**废弃版本：** 11
299
300**替代接口：**[OH_AudioCodec_Prepare](_audio_codec.md#oh_audiocodec_prepare)
301
302**参数:**
303
304| 名称 | 描述 |
305| -------- | -------- |
306| codec | 指向OH_AVCodec实例的指针。 |
307
308**返回：**
309
310如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
311
312
313### OH_AudioEncoder_PushInputData()
314
315```
316OH_AVErrCode OH_AudioEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr)
317```
318
319**描述**
320
321将填充有数据的输入缓冲区提交给音频编码器。
322
323[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调 将报告可用的输入缓冲区和相应的索引值。一旦具有指定索引的缓冲区提交到音频编码器，则无法再次访问此缓冲区， 直到再次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调，收到相同索引时此缓冲区才可使用。
324
325此外，对于某些编码器，需要在开始时向编码器输入特定配置参数，以初始化编码器的编码过程。
326
327**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
328
329**起始版本：** 9
330
331**废弃版本：** 11
332
333**替代接口：**[OH_AudioCodec_PushInputBuffer](_audio_codec.md#oh_audiocodec_pushinputbuffer)
334
335**参数:**
336
337| 名称 | 描述 |
338| -------- | -------- |
339| codec | 指向OH_AVCodec实例的指针。 |
340| index | 输入缓冲区Buffer对应的索引值。 |
341| attr | 描述缓冲区中包含的数据的信息。 |
342
343**返回：**
344
345如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
346
347
348### OH_AudioEncoder_Reset()
349
350```
351OH_AVErrCode OH_AudioEncoder_Reset (OH_AVCodec *codec)
352```
353
354**描述**
355
356重置编码器。如果要继续编码，需要再次调用Configure接口配置编码器实例。
357
358**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
359
360**起始版本：** 9
361
362**废弃版本：** 11
363
364**替代接口：**[OH_AudioCodec_Reset](_audio_codec.md#oh_audiocodec_reset)
365
366**参数:**
367
368| 名称 | 描述 |
369| -------- | -------- |
370| codec | 指向OH_AVCodec实例的指针。 |
371
372**返回：**
373
374如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
375
376
377### OH_AudioEncoder_SetCallback()
378
379```
380OH_AVErrCode OH_AudioEncoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData)
381```
382
383**描述**
384
385设置异步回调函数，使应用可以响应音频编码器生成的事件。在调用Prepare之前，必须调用此接口。
386
387**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
388
389**起始版本：** 9
390
391**废弃版本：** 11
392
393**替代接口：**[OH_AudioCodec_RegisterCallback](_audio_codec.md#oh_audiocodec_registercallback)
394
395**参数:**
396
397| 名称 | 描述 |
398| -------- | -------- |
399| codec | 指向OH_AVCodec实例的指针。 |
400| callback | 所有回调函数的集合，请参见 [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)。 |
401| userData | 用户特定数据。 |
402
403**返回：**
404
405如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)
406
407
408### OH_AudioEncoder_SetParameter()
409
410```
411OH_AVErrCode OH_AudioEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format)
412```
413
414**描述**
415
416配置编码器的动态参数。
417
418注意：该接口必须在编码器启动后才能调用。另外，参数配置错误可能会导致编码失败。
419
420**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
421
422**起始版本：** 9
423
424**废弃版本：** 11
425
426**替代接口：**[OH_AudioCodec_SetParameter](_audio_codec.md#oh_audiocodec_setparameter)
427
428**参数:**
429
430| 名称 | 描述 |
431| -------- | -------- |
432| codec | 指向OH_AVCodec实例的指针。 |
433| format | OH_AVFormat句柄指针。 |
434
435**返回：**
436
437如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
438
439
440### OH_AudioEncoder_Start()
441
442```
443OH_AVErrCode OH_AudioEncoder_Start (OH_AVCodec *codec)
444```
445
446**描述**
447
448Prepare成功后调用此接口启动编码器。启动后，编码器将开始上报OH_AVCodecOnNeedInputData事件。
449
450**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
451
452**起始版本：** 9
453
454**废弃版本：** 11
455
456**替代接口：**[OH_AudioCodec_Start](_audio_codec.md#oh_audiocodec_start)
457
458**参数:**
459
460| 名称 | 描述 |
461| -------- | -------- |
462| codec | 指向OH_AVCodec实例的指针。 |
463
464**返回：**
465
466如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
467
468
469### OH_AudioEncoder_Stop()
470
471```
472OH_AVErrCode OH_AudioEncoder_Stop (OH_AVCodec *codec)
473```
474
475**描述**
476
477停止编码器。停止后，您可以通过Start重新进入已启动状态。
478
479**系统能力：** SystemCapability.Multimedia.Media.AudioEncoder
480
481**起始版本：** 9
482
483**废弃版本：** 11
484
485**替代接口：**[OH_AudioCodec_Stop](_audio_codec.md#oh_audiocodec_stop)
486
487**参数:**
488
489| 名称 | 描述 |
490| -------- | -------- |
491| codec | 指向OH_AVCodec实例的指针。 |
492
493**返回：**
494
495如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅 [OH_AVErrCode](_core.md#oh_averrcode)。
496