AudioDecoder

概述

AudioDecoder模块提供用于音频解码的函数。该模块在部分设备上可能不支持，可以通过CanIUse接口确认。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

起始版本：

9

汇总

文件

枚举

函数

枚举类型说明

AudioChannelLayout

enum AudioChannelLayout : uint64_t

描述：

音频声道数类型， 将用户申请的解码器输出格式表示为编解码器的声道类型。

@syscap SystemCapability.Multimedia.Media.CodecBase

起始版本：

10

AudioChannelSet

enum AudioChannelSet : uint64_t

描述：

音频声道数集合， 将每一个声道数映射为int64的变量。

@syscap SystemCapability.Multimedia.Media.CodecBase

起始版本：

10

函数说明

OH_AudioDecoder_Configure()

OH_AVErrCode OH_AudioDecoder_Configure(OH_AVCodec * codec, OH_AVFormat * format )

描述：

要配置音频解码器，通常需要配置从容器中提取的音频描述信息。

在调用Prepare之前，必须调用此接口。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_CreateByMime()

OH_AVCodec* OH_AudioDecoder_CreateByMime(const char * mime)

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

返回指向OH_AVCodec实例的指针。

起始版本：

9

OH_AudioDecoder_CreateByName()

OH_AVCodec* OH_AudioDecoder_CreateByName(const char * name)

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

返回指向OH_AVCodec实例的指针。

起始版本：

9

OH_AudioDecoder_Destroy()

OH_AVErrCode OH_AudioDecoder_Destroy(OH_AVCodec * codec)

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_Flush()

OH_AVErrCode OH_AudioDecoder_Flush(OH_AVCodec * codec)

描述：

清除解码器中缓存的输入和输出数据。

调用此接口后，以前通过异步回调上报的所有缓冲区索引都将失效，请确保不要访问这些索引对应的缓冲区。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_FreeOutputData()

OH_AVErrCode OH_AudioDecoder_FreeOutputData(OH_AVCodec * codec, uint32_t index )

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_GetOutputDescription()

OH_AVFormat* OH_AudioDecoder_GetOutputDescription(OH_AVCodec * codec)

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

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

起始版本：

9

OH_AudioDecoder_IsValid()

OH_AVErrCode OH_AudioDecoder_IsValid(OH_AVCodec * codec, bool * isValid )

描述：

检查当前解码器实例是否有效。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

10

OH_AudioDecoder_Prepare()

OH_AVErrCode OH_AudioDecoder_Prepare(OH_AVCodec * codec)

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_PushInputData()

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

描述：

将填充有数据的输入缓冲区提交给音频解码器。

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_Reset()

OH_AVErrCode OH_AudioDecoder_Reset(OH_AVCodec * codec)

描述：

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。。

起始版本：

9

OH_AudioDecoder_SetCallback()

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

描述：

设置异步回调函数，使您的应用程序可以响应音频解码器生成的事件。

在调用Prepare之前，必须调用此接口。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_SetParameter()

OH_AVErrCode OH_AudioDecoder_SetParameter(OH_AVCodec * codec, OH_AVFormat * format )

描述：

配置解码器的动态参数。

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_Start()

OH_AVErrCode OH_AudioDecoder_Start(OH_AVCodec * codec)

描述：

Prepare成功后调用此接口启动解码器。

启动后，解码器将开始上报OH_AVCodecOnNeedInputData事件。

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_AudioDecoder_Stop()

OH_AVErrCode OH_AudioDecoder_Stop(OH_AVCodec * codec)

描述：

停止解码器。

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

@syscap SystemCapability.Multimedia.Media.AudioDecoder

参数：

返回：

如果执行成功，则返回AV_ERR_OK，否则返回特定错误代码，请参阅OH_AVErrCode。

起始版本：

9