HarmonyOS API：AudioEncoder

版本：v3.1 Beta

AudioEncoder

更新时间: 2023-02-17 09:19

概述

AudioEncoder模块提供用于音频编码功能的函数。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

起始版本：

9

汇总

文件

函数

函数说明

OH_AudioEncoder_Configure()

OH_AVErrCode OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFormat * format )

描述:

配置音频编码器，典型地，需要配置被编码音频轨道的描述信息，该接口被调用必须是在Prepare被调用前。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_CreateByMime()

OH_AVCodec* OH_AudioEncoder_CreateByMime (const char * mime)

描述:

通过mime类型创建一个音频编码器实例，大多数情况下推荐使用该接口。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

返回一个指向OH_AVCodec实例的指针

OH_AudioEncoder_CreateByName()

OH_AVCodec* OH_AudioEncoder_CreateByName (const char * name)

描述:

通过音频编码器名称创建一个音频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

返回一个指向OH_AVCodec实例的指针

OH_AudioEncoder_Destroy()

OH_AVErrCode OH_AudioEncoder_Destroy (OH_AVCodec * codec)

描述:

清空编码器内部资源，并销毁编码器实例。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_Flush()

OH_AVErrCode OH_AudioEncoder_Flush (OH_AVCodec * codec)

描述:

清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_FreeOutputData()

OH_AVErrCode OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, uint32_t index )

描述:

将处理结束的输出Buffer交还给编码器。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_GetOutputDescription()

OH_AVFormat* OH_AudioEncoder_GetOutputDescription (OH_AVCodec * codec)

描述:

获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

返回OH_AVFormat句柄指针，需调用者手动释放;

OH_AudioEncoder_Prepare()

OH_AVErrCode OH_AudioEncoder_Prepare (OH_AVCodec * codec)

描述:

准备编码器内部资源，调用该接口前必须先调用Configure接口。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_PushInputData()

OH_AVErrCode OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr )

描述:

将填充好数据的输入Buffer提交给音频编码器。​​OH_AVCodecOnNeedInputData​​​回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给编码器，直到再一次收到​​OH_AVCodecOnNeedInputData​​ 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_Reset()

OH_AVErrCode OH_AudioEncoder_Reset (OH_AVCodec * codec)

描述:

重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_SetCallback()

OH_AVErrCode OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData )

描述:

设置异步回调函数，使得你的应用能够响应音频编码器产生的事件，该接口被调用必须是在Prepare被调用前。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_SetParameter()

OH_AVErrCode OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format )

描述:

向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_Start()

OH_AVErrCode OH_AudioEncoder_Start (OH_AVCodec * codec)

描述:

启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告​​OH_AVCodecOnNeedInputData​​事件。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

OH_AudioEncoder_Stop()

OH_AVErrCode OH_AudioEncoder_Stop (OH_AVCodec * codec)

描述:

停止编码器。在停止后可通过Start重新进入Started状态。

@syscap SystemCapability.Multimedia.Media.AudioEncoder

参数:

返回:

执行成功返回AV_ERR_OK

执行失败返回具体错误码，参考​​OH_AVErrCode​​

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/_audio_encoder-0000001446970468-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001446970468__概述​​