openharmony 鸿蒙 capi-native-avcodec-audiodecoder-h

2026-08-25 浏览 (1)

native_avcodec_audiodecoder.h

概述

音频解码Native API的声明。

引用文件： <multimedia/player_framework/native_avcodec_audiodecoder.h>

库： libnative_media_adec.so

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代建议： 当前模块下的接口均已废弃，开发者可使用native_avcodec_audiocodec.h完成对应功能开发，单个接口的替代关系可查阅具体的接口说明。

相关模块： AudioDecoder

汇总

函数

名称描述
OH_AVCodec *OH_AudioDecoder_CreateByMime(const char *mime)根据MIME类型创建音频解码器实例，大多数场景下建议使用此方式。(API11废弃)
OH_AVCodec *OH_AudioDecoder_CreateByName(const char *name)通过音频解码器名称创建音频解码器实例，使用此接口的前提是知道解码器的确切名称。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Destroy(OH_AVCodec *codec)清理解码器内部资源，销毁解码器实例。(API11废弃)
OH_AVErrCode OH_AudioDecoder_SetCallback(OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData)设置异步回调函数，使应用可以响应音频解码器生成的事件。在调用Prepare之前，必须调用此接口。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Configure(OH_AVCodec *codec, OH_AVFormat *format)要配置音频解码器，通常需要配置从容器中提取的音频描述信息。在调用Prepare之前，必须调用此接口。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Prepare(OH_AVCodec *codec)准备解码器的内部资源，在调用此接口之前必须调用Configure接口。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Start(OH_AVCodec *codec)调用此接口启动解码器，在Prepare成功后执行。启动后，解码器将开始上报OH_AVCodecOnNeedInputData事件。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Stop(OH_AVCodec *codec)停止解码器。
停止后，您可以通过Start重新进入已启动状态，但需要注意的是，如果解码器之前已输入数据，则需要重新输入解码器数据。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Flush(OH_AVCodec *codec)清除解码器中缓存的输入和输出数据。
调用此接口后，以前通过异步回调上报的所有缓冲区索引都将失效，请确保不要访问这些索引对应的缓冲区。(API11废弃)
OH_AVErrCode OH_AudioDecoder_Reset(OH_AVCodec *codec)重置解码器。如果要继续解码，需要再次调用Configure接口配置解码器实例。(API11废弃)
OH_AVFormat *OH_AudioDecoder_GetOutputDescription(OH_AVCodec *codec)获取解码器输出数据的描述信息。
需要注意的是，返回值所指向的OH_AVFormat实例的生命周期需要调用者手动释放。(API11废弃)
OH_AVErrCode OH_AudioDecoder_SetParameter(OH_AVCodec *codec, OH_AVFormat *format)配置解码器的动态参数。
注意：该接口必须在解码器启动后才能调用。另外，参数配置错误可能会导致解码失败。(API11废弃)
OH_AVErrCode OH_AudioDecoder_PushInputData(OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr)通知音频解码器已完成对index所对应缓冲区进行输入数据的填充。
OH_AVCodecOnNeedInputData回调将报告可用的输入缓冲区和相应的索引值。一旦具有指定索引的缓冲区提交到音频解码器，则无法再次访问此缓冲区，直到再次收到OH_AVCodecOnNeedInputData回调，收到相同索引时此缓冲区才可使用。
此外，对于某些解码器，需要在开始时向解码器输入特定配置参数，以初始化解码器的解码过程。(API11废弃)
OH_AVErrCode OH_AudioDecoder_FreeOutputData(OH_AVCodec *codec, uint32_t index)将处理后的输出缓冲区返回给解码器。(API11废弃)
OH_AVErrCode OH_AudioDecoder_IsValid(OH_AVCodec *codec, bool *isValid)检查当前解码器实例是否有效，可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。(API11废弃)

函数说明

OH_AudioDecoder_CreateByMime()

OH_AVCodec *OH_AudioDecoder_CreateByMime(const char *mime)

描述

根据MIME类型创建音频解码器实例，大多数场景下建议使用此方式。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_CreateByMime

参数：

参数项描述
const char *mimeMIME类型描述字符串，请参阅AVCODEC_MIMETYPE。

返回：

类型说明
OH_AVCodec *返回指向OH_AVCodec实例的指针。

OH_AudioDecoder_CreateByName()

OH_AVCodec *OH_AudioDecoder_CreateByName(const char *name)

描述

通过音频解码器名称创建音频解码器实例，使用此接口的前提是知道解码器的确切名称。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_CreateByName

参数：

参数项描述
const char *name音频解码器名称。

返回：

类型说明
OH_AVCodec *返回指向OH_AVCodec实例的指针。

OH_AudioDecoder_Destroy()

OH_AVErrCode OH_AudioDecoder_Destroy(OH_AVCodec *codec)

描述

清理解码器内部资源，销毁解码器实例。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Destroy

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_SetCallback()

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

描述

设置异步回调函数，使应用可以响应音频解码器生成的事件。在调用Prepare之前，必须调用此接口。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_RegisterCallback

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。
OH_AVCodecAsyncCallback callback所有回调函数的集合。
void *userData用户特定数据。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_Configure()

OH_AVErrCode OH_AudioDecoder_Configure(OH_AVCodec *codec, OH_AVFormat *format)

描述

要配置音频解码器，通常需要配置从容器中提取的音频描述信息。在调用Prepare之前，必须调用此接口。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Configure

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。
OH_AVFormat *format指向OH_AVFormat的指针，给出要解码的音频轨道的描述。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_Prepare()

OH_AVErrCode OH_AudioDecoder_Prepare(OH_AVCodec *codec)

描述

准备解码器的内部资源，在调用此接口之前必须调用Configure接口。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Prepare

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_Start()

OH_AVErrCode OH_AudioDecoder_Start(OH_AVCodec *codec)

描述

调用此接口启动解码器，在Prepare成功后执行。启动后，解码器将开始上报OH_AVCodecOnNeedInputData事件。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Start

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_Stop()

OH_AVErrCode OH_AudioDecoder_Stop(OH_AVCodec *codec)

描述

停止解码器。
停止后，您可以通过Start重新进入已启动状态，但需要注意的是，如果解码器之前已输入数据，则需要重新输入解码器数据。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Stop

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_Flush()

OH_AVErrCode OH_AudioDecoder_Flush(OH_AVCodec *codec)

描述

清除解码器中缓存的输入和输出数据。
调用此接口后，以前通过异步回调上报的所有缓冲区索引都将失效，请确保不要访问这些索引对应的缓冲区。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Flush

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_Reset()

OH_AVErrCode OH_AudioDecoder_Reset(OH_AVCodec *codec)

描述

重置解码器。如果要继续解码，需要再次调用Configure接口配置解码器实例。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_Reset

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_GetOutputDescription()

OH_AVFormat *OH_AudioDecoder_GetOutputDescription(OH_AVCodec *codec)

描述

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

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_GetOutputDescription

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。

返回：

类型说明
OH_AVFormat *返回OH_AVFormat句柄指针，生命周期将使用下一个GetOutputDescription刷新，或使用OH_AVCodec销毁。

OH_AudioDecoder_SetParameter()

OH_AVErrCode OH_AudioDecoder_SetParameter(OH_AVCodec *codec, OH_AVFormat *format)

描述

配置解码器的动态参数。
注意：该接口必须在解码器启动后才能调用。另外，参数配置错误可能会导致解码失败。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_SetParameter

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。
OH_AVFormat *formatOH_AVFormat句柄指针。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_PushInputData()

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

描述

通知音频解码器已完成对index所对应缓冲区进行输入数据的填充。
OH_AVCodecOnNeedInputData回调将报告可用的输入缓冲区和相应的索引值。一旦具有指定索引的缓冲区提交到音频解码器，则无法再次访问此缓冲区，直到再次收到OH_AVCodecOnNeedInputData回调，收到相同索引时此缓冲区才可使用。
此外，对于某些解码器，需要在开始时向解码器输入特定配置参数，以初始化解码器的解码过程。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_PushInputBuffer

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。
uint32_t index输入缓冲区Buffer对应的索引值。
OH_AVCodecBufferAttr attr描述缓冲区中包含的数据的信息。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_FreeOutputData()

OH_AVErrCode OH_AudioDecoder_FreeOutputData(OH_AVCodec *codec, uint32_t index)

描述

将处理后的输出缓冲区返回给解码器。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 9

废弃版本： 11

替代接口： OH_AudioCodec_FreeOutputBuffer

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。
uint32_t index输出缓冲区Buffer对应的索引值。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

OH_AudioDecoder_IsValid()

OH_AVErrCode OH_AudioDecoder_IsValid(OH_AVCodec *codec, bool *isValid)

描述

检查当前解码器实例是否有效，可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。

系统能力： SystemCapability.Multimedia.Media.AudioDecoder

起始版本： 10

废弃版本： 11

替代接口： OH_AudioCodec_IsValid

参数：

参数项描述
OH_AVCodec *codec指向OH_AVCodec实例的指针。
bool *isValid指向布尔类型的指针，true：解码器实例有效，false：解码器实例无效。

返回：

类型说明
OH_AVErrCode如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码。

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-native-avcodec-audiocodec-h

openharmony 鸿蒙 capi-avsource-oh-avsource

openharmony 鸿蒙 capi-native-cencinfo-h

openharmony 鸿蒙 capi-avmuxer

openharmony 鸿蒙 capi-multimedia-drm-oh-avcencinfo

openharmony 鸿蒙 capi-native-avdemuxer-h

openharmony 鸿蒙 capi-media-types-h

openharmony 鸿蒙 capi-native-audio-channel-layout-h

openharmony 鸿蒙 capi-native-avbuffer-info-h

openharmony 鸿蒙 capi-codecbase-oh-avcodecasynccallback

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/8FFjTyo2