未验证 提交 80c39033 编写于 作者: O openharmony_ci 提交者: Gitee

!20541 IsValid 接口说明修改,新增flac编码 输入长度说明

Merge pull request !20541 from guoyao/master
...@@ -152,7 +152,7 @@ constexpr int32_t COMPLIANCE_LEVEL = 0; ...@@ -152,7 +152,7 @@ constexpr int32_t COMPLIANCE_LEVEL = 0;
// 配置音频精度(必须) SAMPLE_S16LE和SAMPLE_S24LE和SAMPLE_S32LE // 配置音频精度(必须) SAMPLE_S16LE和SAMPLE_S24LE和SAMPLE_S32LE
constexpr BITS_PER_CODED_SAMPLE BITS_PER_CODED_SAMPLE =OH_BitsPerSample::SAMPLE_S24LE; constexpr BITS_PER_CODED_SAMPLE BITS_PER_CODED_SAMPLE =OH_BitsPerSample::SAMPLE_S24LE;
// 配置最大输入长度(可选) // 配置最大输入长度(可选)
constexpr uint32_t DEFAULT_MAX_INPUT_SIZE = 1024*2*4;//aac constexpr uint32_t DEFAULT_MAX_INPUT_SIZE = 1024*DEFAULT_CHANNEL_COUNT *sizeof(float);//aac
OH_AVFormat *format = OH_AVFormat_Create(); OH_AVFormat *format = OH_AVFormat_Create();
// 写入format // 写入format
OH_AVFormat_SetIntValue(format,MediaDescriptionKey::MD_KEY_SAMPLE_RATE.data(),DEFAULT_SMAPLERATE); OH_AVFormat_SetIntValue(format,MediaDescriptionKey::MD_KEY_SAMPLE_RATE.data(),DEFAULT_SMAPLERATE);
...@@ -199,9 +199,29 @@ if (ret != AV_ERR_OK) { ...@@ -199,9 +199,29 @@ if (ret != AV_ERR_OK) {
6. 调用OH_AudioEncoder_PushInputData(),写入待编码器的数据。 6. 调用OH_AudioEncoder_PushInputData(),写入待编码器的数据。
如果是结束,需要对flag标识成AVCODEC_BUFFER_FLAGS_EOS 如果是结束,需要对flag标识成AVCODEC_BUFFER_FLAGS_EOS
aac: 样点数(FRAME_SIZE)固定为1024
flac: 样点数(FRAME_SIZE)比较特殊需要,根据如下表格进行设置
| 采样率 | 样点数 |
| :----: | :----: |
| 8000 | 576 |
| 16000 | 1152 |
| 22050 | 2304 |
| 24000 | 2304 |
| 32000 | 2304 |
| 44100 | 4608 |
| 48000 | 4608 |
| 88200 | 8192 |
| 96000 | 8192 |
**注意**:aac的样点数固定为1024,其他值会直接返回错误码,flac的样点数建议根据采样率按照表格传入,大于这个值也会返回错误码,如果小于有可能出现编码文件损坏问题。
```c++ ```c++
constexpr int32_t INPUT_FRAME_BYTES = 2 * 1024 * 4; constexpr int32_t FRAME_SIZE = 1024; //aac
constexpr int32_t DEFAULT_CHANNEL_COUNT =2;
constexpr int32_t INPUT_FRAME_BYTES = DEFAULT_CHANNEL_COUNT * FRAME_SIZE * sizeof(float); //aac
// 配置buffer info信息 // 配置buffer info信息
OH_AVCodecBufferAttr info; OH_AVCodecBufferAttr info;
// 设置输入pkt尺寸、偏移量、时间戳等信息 // 设置输入pkt尺寸、偏移量、时间戳等信息
......
# AudioDecoder # AudioDecoder
## 概述 ## 概述
AudioDecoder模块提供用于音频解码的函数。该模块在部分设备上可能不支持,可以通过[CanIUse](../syscap.md)接口确认。 AudioDecoder模块提供用于音频解码的函数。该模块在部分设备上可能不支持,可以通过[CanIUse](../syscap.md)接口确认。
...@@ -11,53 +10,46 @@ AudioDecoder模块提供用于音频解码的函数。该模块在部分设备 ...@@ -11,53 +10,46 @@ AudioDecoder模块提供用于音频解码的函数。该模块在部分设备
9 9
## 汇总 ## 汇总
### 文件 ### 文件
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) | 声明用于音频解码的Native API。<br>引用文件:<multimedia/player_framework/native_avcodec_audiodecoder.h> | | [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) | 声明用于音频解码的Native API。`<br>`引用文件:<multimedia/player_framework/native_avcodec_audiodecoder.h> |
| [avcodec_audio_channel_layout.h](avcodec__audio__channel__layout_8h.md) | 声明用于音频编解码的枚举。<br>引用文件:<multimedia/avcodec_audio_channel_layout.h> | | [avcodec_audio_channel_layout.h](avcodec__audio__channel__layout_8h.md) | 声明用于音频编解码的枚举。`<br>`引用文件:<multimedia/avcodec_audio_channel_layout.h> |
### 枚举 ### 枚举
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [OHOS::Media::AudioChannelSet](#audiochannelset) : uint64_t {<br/>**FRONT_LEFT** = 1ULL &lt;&lt; 0U, **FRONT_RIGHT** = 1ULL &lt;&lt; 1U, **FRONT_CENTER** = 1ULL &lt;&lt; 2U, **LOW_FREQUENCY** = 1ULL &lt;&lt; 3U,<br/>**BACK_LEFT** = 1ULL &lt;&lt; 4U, **BACK_RIGHT** = 1ULL &lt;&lt; 5U, **FRONT_LEFT_OF_CENTER** = 1ULL &lt;&lt; 6U, **FRONT_RIGHT_OF_CENTER** = 1ULL &lt;&lt; 7U,<br/>**BACK_CENTER** = 1ULL &lt;&lt; 8U, **SIDE_LEFT** = 1ULL &lt;&lt; 9U, **SIDE_RIGHT** = 1ULL &lt;&lt; 10U, **TOP_CENTER** = 1ULL &lt;&lt; 11U,<br/>**TOP_FRONT_LEFT** = 1ULL &lt;&lt; 12U, **TOP_FRONT_CENTER** = 1ULL &lt;&lt; 13U, **TOP_FRONT_RIGHT** = 1ULL &lt;&lt; 14U, **TOP_BACK_LEFT** = 1ULL &lt;&lt; 15U,<br/>**TOP_BACK_CENTER** = 1ULL &lt;&lt; 16U, **TOP_BACK_RIGHT** = 1ULL &lt;&lt; 17U, **STEREO_LEFT** = 1ULL &lt;&lt; 29U, **STEREO_RIGHT** = 1ULL &lt;&lt; 30U,<br/>**WIDE_LEFT** = 1ULL &lt;&lt; 31U, **WIDE_RIGHT** = 1ULL &lt;&lt; 32U, **SURROUND_DIRECT_LEFT** = 1ULL &lt;&lt; 33U, **SURROUND_DIRECT_RIGHT** = 1ULL &lt;&lt; 34U,<br/>**LOW_FREQUENCY_2** = 1ULL &lt;&lt; 35U, **TOP_SIDE_LEFT** = 1ULL &lt;&lt; 36U, **TOP_SIDE_RIGHT** = 1ULL &lt;&lt; 37U, **BOTTOM_FRONT_CENTER** = 1ULL &lt;&lt; 38U,<br/>**BOTTOM_FRONT_LEFT** = 1ULL &lt;&lt; 39U, **BOTTOM_FRONT_RIGHT** = 1ULL &lt;&lt; 40U, **AMBISONICS_ACN0** = 1ULL &lt;&lt; 41U, OHOS::Media::AMBISONICS_ACN1 = 1ULL &lt;&lt; 42U,<br/>OHOS::Media::AMBISONICS_ACN2 = 1ULL &lt;&lt; 43U, OHOS::Media::AMBISONICS_ACN3 = 1ULL &lt;&lt; 44U, OHOS::Media::AMBISONICS_W = AMBISONICS_ACN0, OHOS::Media::AMBISONICS_Y = AMBISONICS_ACN1,<br/>OHOS::Media::AMBISONICS_Z = AMBISONICS_ACN2, OHOS::Media::AMBISONICS_X = AMBISONICS_ACN3, OHOS::Media::AMBISONICS_ACN4 = 1ULL &lt;&lt; 45U, OHOS::Media::AMBISONICS_ACN5 = 1ULL &lt;&lt; 46U,<br/>OHOS::Media::AMBISONICS_ACN6 = 1ULL &lt;&lt; 47U, OHOS::Media::AMBISONICS_ACN7 = 1ULL &lt;&lt; 48U, OHOS::Media::AMBISONICS_ACN8 = 1ULL &lt;&lt; 49U, OHOS::Media::AMBISONICS_ACN9 = 1ULL &lt;&lt; 50U,<br/>OHOS::Media::AMBISONICS_ACN10 = 1ULL &lt;&lt; 51U, OHOS::Media::AMBISONICS_ACN11 = 1ULL &lt;&lt; 52U, OHOS::Media::AMBISONICS_ACN12 = 1ULL &lt;&lt; 53U, OHOS::Media::AMBISONICS_ACN13 = 1ULL &lt;&lt; 54U,<br/>OHOS::Media::AMBISONICS_ACN14 = 1ULL &lt;&lt; 55U, OHOS::Media::AMBISONICS_ACN15 = 1ULL &lt;&lt; 56U<br/>} | 音频声道数集合, 将每一个声道数映射为int64的变量。 | | [OHOS::Media::AudioChannelSet](#audiochannelset) : uint64_t {``**FRONT_LEFT** = 1ULL &lt;&lt; 0U, **FRONT_RIGHT** = 1ULL &lt;&lt; 1U, **FRONT_CENTER** = 1ULL &lt;&lt; 2U, **LOW_FREQUENCY** = 1ULL &lt;&lt; 3U,``**BACK_LEFT** = 1ULL &lt;&lt; 4U, **BACK_RIGHT** = 1ULL &lt;&lt; 5U, **FRONT_LEFT_OF_CENTER** = 1ULL &lt;&lt; 6U, **FRONT_RIGHT_OF_CENTER** = 1ULL &lt;&lt; 7U,``**BACK_CENTER** = 1ULL &lt;&lt; 8U, **SIDE_LEFT** = 1ULL &lt;&lt; 9U, **SIDE_RIGHT** = 1ULL &lt;&lt; 10U, **TOP_CENTER** = 1ULL &lt;&lt; 11U,``**TOP_FRONT_LEFT** = 1ULL &lt;&lt; 12U, **TOP_FRONT_CENTER** = 1ULL &lt;&lt; 13U, **TOP_FRONT_RIGHT** = 1ULL &lt;&lt; 14U, **TOP_BACK_LEFT** = 1ULL &lt;&lt; 15U,``**TOP_BACK_CENTER** = 1ULL &lt;&lt; 16U, **TOP_BACK_RIGHT** = 1ULL &lt;&lt; 17U, **STEREO_LEFT** = 1ULL &lt;&lt; 29U, **STEREO_RIGHT** = 1ULL &lt;&lt; 30U,``**WIDE_LEFT** = 1ULL &lt;&lt; 31U, **WIDE_RIGHT** = 1ULL &lt;&lt; 32U, **SURROUND_DIRECT_LEFT** = 1ULL &lt;&lt; 33U, **SURROUND_DIRECT_RIGHT** = 1ULL &lt;&lt; 34U,``**LOW_FREQUENCY_2** = 1ULL &lt;&lt; 35U, **TOP_SIDE_LEFT** = 1ULL &lt;&lt; 36U, **TOP_SIDE_RIGHT** = 1ULL &lt;&lt; 37U, **BOTTOM_FRONT_CENTER** = 1ULL &lt;&lt; 38U,``**BOTTOM_FRONT_LEFT** = 1ULL &lt;&lt; 39U, **BOTTOM_FRONT_RIGHT** = 1ULL &lt;&lt; 40U, **AMBISONICS_ACN0** = 1ULL &lt;&lt; 41U, OHOS::Media::AMBISONICS_ACN1 = 1ULL &lt;&lt; 42U,``OHOS::Media::AMBISONICS_ACN2 = 1ULL &lt;&lt; 43U, OHOS::Media::AMBISONICS_ACN3 = 1ULL &lt;&lt; 44U, OHOS::Media::AMBISONICS_W = AMBISONICS_ACN0, OHOS::Media::AMBISONICS_Y = AMBISONICS_ACN1,``OHOS::Media::AMBISONICS_Z = AMBISONICS_ACN2, OHOS::Media::AMBISONICS_X = AMBISONICS_ACN3, OHOS::Media::AMBISONICS_ACN4 = 1ULL &lt;&lt; 45U, OHOS::Media::AMBISONICS_ACN5 = 1ULL &lt;&lt; 46U,``OHOS::Media::AMBISONICS_ACN6 = 1ULL &lt;&lt; 47U, OHOS::Media::AMBISONICS_ACN7 = 1ULL &lt;&lt; 48U, OHOS::Media::AMBISONICS_ACN8 = 1ULL &lt;&lt; 49U, OHOS::Media::AMBISONICS_ACN9 = 1ULL &lt;&lt; 50U,``OHOS::Media::AMBISONICS_ACN10 = 1ULL &lt;&lt; 51U, OHOS::Media::AMBISONICS_ACN11 = 1ULL &lt;&lt; 52U, OHOS::Media::AMBISONICS_ACN12 = 1ULL &lt;&lt; 53U, OHOS::Media::AMBISONICS_ACN13 = 1ULL &lt;&lt; 54U,``OHOS::Media::AMBISONICS_ACN14 = 1ULL &lt;&lt; 55U, OHOS::Media::AMBISONICS_ACN15 = 1ULL &lt;&lt; 56U``} | 音频声道数集合, 将每一个声道数映射为int64的变量。 |
| [OHOS::Media::AudioChannelLayout](#audiochannellayout) : uint64_t {<br/>**UNKNOWN_CHANNEL_LAYOUT** = 0, **MONO** = (AudioChannelSet::FRONT_CENTER), **STEREO** = (AudioChannelSet::FRONT_LEFT \| AudioChannelSet::FRONT_RIGHT), **CH_2POINT1** = (STEREO \| AudioChannelSet::LOW_FREQUENCY),<br/>**CH_2_1** = (STEREO \| AudioChannelSet::BACK_CENTER), **SURROUND** = (STEREO \| AudioChannelSet::FRONT_CENTER), **CH_3POINT1** = (SURROUND \| AudioChannelSet::LOW_FREQUENCY), **CH_4POINT0** = (SURROUND \| AudioChannelSet::BACK_CENTER),<br/>**CH_4POINT1** = (CH_4POINT0 \| AudioChannelSet::LOW_FREQUENCY), **CH_2_2** = (STEREO \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT), **QUAD** = (STEREO \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT), **CH_5POINT0** = (SURROUND \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT),<br/>**CH_5POINT1** = (CH_5POINT0 \| AudioChannelSet::LOW_FREQUENCY), **CH_5POINT0_BACK** = (SURROUND \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT), **CH_5POINT1_BACK** = (CH_5POINT0_BACK \| AudioChannelSet::LOW_FREQUENCY), **CH_6POINT0** = (CH_5POINT0 \| AudioChannelSet::BACK_CENTER),<br/>**CH_6POINT0_FRONT** = (CH_2_2 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER), **HEXAGONAL** = (CH_5POINT0_BACK \| AudioChannelSet::BACK_CENTER), **CH_6POINT1** = (CH_5POINT1 \| AudioChannelSet::BACK_CENTER), **CH_6POINT1_BACK** = (CH_5POINT1_BACK \| AudioChannelSet::BACK_CENTER),<br/>**CH_6POINT1_FRONT** = (CH_6POINT0_FRONT \| AudioChannelSet::LOW_FREQUENCY), **CH_7POINT0** = (CH_5POINT0 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT), **CH_7POINT0_FRONT** = (CH_5POINT0 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER), **CH_7POINT1** = (CH_5POINT1 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT),<br/>**CH_7POINT1_WIDE** = (CH_5POINT1 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER), **CH_7POINT1_WIDE_BACK**, **CH_3POINT1POINT2** = (CH_3POINT1 \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT), **CH_5POINT1POINT2** = (CH_5POINT1 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT),<br/>**CH_5POINT1POINT4**, **CH_7POINT1POINT2** = (CH_7POINT1 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT), **CH_7POINT1POINT4**, **CH_9POINT1POINT4** = (CH_7POINT1POINT4 \| AudioChannelSet::WIDE_LEFT \| AudioChannelSet::WIDE_RIGHT),<br/>**CH_9POINT1POINT6** = (CH_9POINT1POINT4 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT), **CH_10POINT2**, **CH_22POINT2**, **OCTAGONAL** = (CH_5POINT0 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_CENTER \| AudioChannelSet::BACK_RIGHT),<br/>**HEXADECAGONAL**, **STEREO_DOWNMIX** = (AudioChannelSet::STEREO_LEFT \| AudioChannelSet::STEREO_RIGHT), **HOA_FIRST**, **HOA_SECOND**,<br/>**HOA_THIRD**<br/>} | 音频声道数类型, 将用户申请的解码器输出格式表示为编解码器的声道类型。 | | [OHOS::Media::AudioChannelLayout](#audiochannellayout) : uint64_t {``**UNKNOWN_CHANNEL_LAYOUT** = 0, **MONO** = (AudioChannelSet::FRONT_CENTER), **STEREO** = (AudioChannelSet::FRONT_LEFT \| AudioChannelSet::FRONT_RIGHT), **CH_2POINT1** = (STEREO \| AudioChannelSet::LOW_FREQUENCY),``**CH_2_1** = (STEREO \| AudioChannelSet::BACK_CENTER), **SURROUND** = (STEREO \| AudioChannelSet::FRONT_CENTER), **CH_3POINT1** = (SURROUND \| AudioChannelSet::LOW_FREQUENCY), **CH_4POINT0** = (SURROUND \| AudioChannelSet::BACK_CENTER),``**CH_4POINT1** = (CH_4POINT0 \| AudioChannelSet::LOW_FREQUENCY), **CH_2_2** = (STEREO \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT), **QUAD** = (STEREO \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT), **CH_5POINT0** = (SURROUND \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT),``**CH_5POINT1** = (CH_5POINT0 \| AudioChannelSet::LOW_FREQUENCY), **CH_5POINT0_BACK** = (SURROUND \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT), **CH_5POINT1_BACK** = (CH_5POINT0_BACK \| AudioChannelSet::LOW_FREQUENCY), **CH_6POINT0** = (CH_5POINT0 \| AudioChannelSet::BACK_CENTER),``**CH_6POINT0_FRONT** = (CH_2_2 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER), **HEXAGONAL** = (CH_5POINT0_BACK \| AudioChannelSet::BACK_CENTER), **CH_6POINT1** = (CH_5POINT1 \| AudioChannelSet::BACK_CENTER), **CH_6POINT1_BACK** = (CH_5POINT1_BACK \| AudioChannelSet::BACK_CENTER),``**CH_6POINT1_FRONT** = (CH_6POINT0_FRONT \| AudioChannelSet::LOW_FREQUENCY), **CH_7POINT0** = (CH_5POINT0 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT), **CH_7POINT0_FRONT** = (CH_5POINT0 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER), **CH_7POINT1** = (CH_5POINT1 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT),``**CH_7POINT1_WIDE** = (CH_5POINT1 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER), **CH_7POINT1_WIDE_BACK**, **CH_3POINT1POINT2** = (CH_3POINT1 \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT), **CH_5POINT1POINT2** = (CH_5POINT1 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT),``**CH_5POINT1POINT4**, **CH_7POINT1POINT2** = (CH_7POINT1 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT), **CH_7POINT1POINT4**, **CH_9POINT1POINT4** = (CH_7POINT1POINT4 \| AudioChannelSet::WIDE_LEFT \| AudioChannelSet::WIDE_RIGHT),``**CH_9POINT1POINT6** = (CH_9POINT1POINT4 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT), **CH_10POINT2**, **CH_22POINT2**, **OCTAGONAL** = (CH_5POINT0 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_CENTER \| AudioChannelSet::BACK_RIGHT),``**HEXADECAGONAL**, **STEREO_DOWNMIX** = (AudioChannelSet::STEREO_LEFT \| AudioChannelSet::STEREO_RIGHT), **HOA_FIRST**, **HOA_SECOND**,``**HOA_THIRD**``} | 音频声道数类型, 将用户申请的解码器输出格式表示为编解码器的声道类型。 |
### 函数 ### 函数
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| \*[OHOS::Media::OH_AudioDecoder_CreateByMime](#oh_audiodecoder_createbymime) (const char \*mime) | 根据MIME类型创建音频解码器实例,大多数场景下建议使用此方式。 | | \*[OHOS::Media::OH_AudioDecoder_CreateByMime](#oh_audiodecoder_createbymime) (const char \*mime) | 根据MIME类型创建音频解码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioDecoder_CreateByName](#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建音频解码器实例,使用此接口的前提是知道解码器的确切名称。 | | \*[OHOS::Media::OH_AudioDecoder_CreateByName](#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建音频解码器实例,使用此接口的前提是知道解码器的确切名称。 |
| [OHOS::Media::OH_AudioDecoder_Destroy](#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源,销毁解码器实例。 | | [OHOS::Media::OH_AudioDecoder_Destroy](#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源,销毁解码器实例。 |
| [OHOS::Media::OH_AudioDecoder_SetCallback](#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频解码器生成的事件。 | | [OHOS::Media::OH_AudioDecoder_SetCallback](#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频解码器生成的事件。 |
| [OHOS::Media::OH_AudioDecoder_Configure](#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频解码器,通常需要配置从容器中提取的音频描述信息。 | | [OHOS::Media::OH_AudioDecoder_Configure](#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频解码器,通常需要配置从容器中提取的音频描述信息。 |
| [OHOS::Media::OH_AudioDecoder_Prepare](#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | 准备解码器的内部资源,在调用此接口之前必须调用Configure接口。 | | [OHOS::Media::OH_AudioDecoder_Prepare](#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | 准备解码器的内部资源,在调用此接口之前必须调用Configure接口。 |
| [OHOS::Media::OH_AudioDecoder_Start](#oh_audiodecoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动解码器。 | | [OHOS::Media::OH_AudioDecoder_Start](#oh_audiodecoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动解码器。 |
| [OHOS::Media::OH_AudioDecoder_Stop](#oh_audiodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。 | | [OHOS::Media::OH_AudioDecoder_Stop](#oh_audiodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。 |
| [OHOS::Media::OH_AudioDecoder_Flush](#oh_audiodecoder_flush) (OH_AVCodec \*codec) | 清除解码器中缓存的输入和输出数据。 | | [OHOS::Media::OH_AudioDecoder_Flush](#oh_audiodecoder_flush) (OH_AVCodec \*codec) | 清除解码器中缓存的输入和输出数据。 |
| [OHOS::Media::OH_AudioDecoder_Reset](#oh_audiodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。如果要继续解码,需要再次调用Configure接口配置解码器实例 。 | | [OHOS::Media::OH_AudioDecoder_Reset](#oh_audiodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。如果要继续解码,需要再次调用Configure接口配置解码器实例 。 |
| \*[OHOS::Media::OH_AudioDecoder_GetOutputDescription](#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取解码器输出数据的描述信息,详细信息请参见**OH_AVFormat**。 | | \*[OHOS::Media::OH_AudioDecoder_GetOutputDescription](#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取解码器输出数据的描述信息,详细信息请参见**OH_AVFormat**。 |
| [OHOS::Media::OH_AudioDecoder_SetParameter](#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置解码器的动态参数。注意:该接口必须在解码器启动后才能调用。另外,参数配置错误可能会导致解码失败。 | | [OHOS::Media::OH_AudioDecoder_SetParameter](#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置解码器的动态参数。注意:该接口必须在解码器启动后才能调用。另外,参数配置错误可能会导致解码失败。 |
| [OHOS::Media::OH_AudioDecoder_PushInputData](#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频解码器。 | | [OHOS::Media::OH_AudioDecoder_PushInputData](#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频解码器。 |
| [OHOS::Media::OH_AudioDecoder_FreeOutputData](#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给解码器。 | | [OHOS::Media::OH_AudioDecoder_FreeOutputData](#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给解码器。 |
| [OHOS::Media::OH_AudioDecoder_IsValid](#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。 | | [OHOS::Media::OH_AudioDecoder_IsValid](#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效。 |
## 枚举类型说明 ## 枚举类型说明
### AudioChannelLayout ### AudioChannelLayout
``` ```
enum OHOS::Media::AudioChannelLayout : uint64_t enum OHOS::Media::AudioChannelLayout : uint64_t
``` ```
...@@ -72,10 +64,8 @@ enum OHOS::Media::AudioChannelLayout : uint64_t ...@@ -72,10 +64,8 @@ enum OHOS::Media::AudioChannelLayout : uint64_t
10 10
### AudioChannelSet ### AudioChannelSet
``` ```
enum OHOS::Media::AudioChannelSet : uint64_t enum OHOS::Media::AudioChannelSet : uint64_t
``` ```
...@@ -90,35 +80,32 @@ enum OHOS::Media::AudioChannelSet : uint64_t ...@@ -90,35 +80,32 @@ enum OHOS::Media::AudioChannelSet : uint64_t
10 10
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | ---------------- | ---------------------- |
| AMBISONICS_ACN1 | 零阶立体声声道数 0 | | AMBISONICS_ACN1 | 零阶立体声声道数 0 |
| AMBISONICS_ACN2 | 一阶立体声声道数 1 | | AMBISONICS_ACN2 | 一阶立体声声道数 1 |
| AMBISONICS_ACN3 | 一阶立体声声道数 2 | | AMBISONICS_ACN3 | 一阶立体声声道数 2 |
| AMBISONICS_W | 一阶立体声声道数 3 | | AMBISONICS_W | 一阶立体声声道数 3 |
| AMBISONICS_Y | 同于零阶立体声声道数 0 | | AMBISONICS_Y | 同于零阶立体声声道数 0 |
| AMBISONICS_Z | 同于一阶立体声声道数 1 | | AMBISONICS_Z | 同于一阶立体声声道数 1 |
| AMBISONICS_X | 同于一阶立体声声道数 2 | | AMBISONICS_X | 同于一阶立体声声道数 2 |
| AMBISONICS_ACN4 | 同于一阶立体声声道数 3 | | AMBISONICS_ACN4 | 同于一阶立体声声道数 3 |
| AMBISONICS_ACN5 | 二阶立体声声道数 4 | | AMBISONICS_ACN5 | 二阶立体声声道数 4 |
| AMBISONICS_ACN6 | 二阶立体声声道数 5 | | AMBISONICS_ACN6 | 二阶立体声声道数 5 |
| AMBISONICS_ACN7 | 二阶立体声声道数 6 | | AMBISONICS_ACN7 | 二阶立体声声道数 6 |
| AMBISONICS_ACN8 | 二阶立体声声道数 7 | | AMBISONICS_ACN8 | 二阶立体声声道数 7 |
| AMBISONICS_ACN9 | 二阶立体声声道数 8 | | AMBISONICS_ACN9 | 二阶立体声声道数 8 |
| AMBISONICS_ACN10 | 三阶立体声声道数 9 | | AMBISONICS_ACN10 | 三阶立体声声道数 9 |
| AMBISONICS_ACN11 | 三阶立体声声道数 10 | | AMBISONICS_ACN11 | 三阶立体声声道数 10 |
| AMBISONICS_ACN12 | 三阶立体声声道数 11 | | AMBISONICS_ACN12 | 三阶立体声声道数 11 |
| AMBISONICS_ACN13 | 三阶立体声声道数 12 | | AMBISONICS_ACN13 | 三阶立体声声道数 12 |
| AMBISONICS_ACN14 | 三阶立体声声道数 13 | | AMBISONICS_ACN14 | 三阶立体声声道数 13 |
| AMBISONICS_ACN15 | 三阶立体声声道数 14 | | AMBISONICS_ACN15 | 三阶立体声声道数 14 |
## 函数说明 ## 函数说明
### OH_AudioDecoder_Configure() ### OH_AudioDecoder_Configure()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFormat * format )
``` ```
...@@ -133,10 +120,10 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFo ...@@ -133,10 +120,10 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFo
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------ | --------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| format | 指向OH_AVFormat的指针,给出要解码的音频轨道的描述。 | | format | 指向OH_AVFormat的指针,给出要解码的音频轨道的描述。 |
**返回:** **返回:**
...@@ -146,10 +133,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFo ...@@ -146,10 +133,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFo
9 9
### OH_AudioDecoder_CreateByMime() ### OH_AudioDecoder_CreateByMime()
``` ```
OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByMime (const char * mime) OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByMime (const char * mime)
``` ```
...@@ -162,9 +147,9 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByMime (const char * mime) ...@@ -162,9 +147,9 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByMime (const char * mime)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---- | ------------------------------------------------------- |
| mime | MIME类型描述字符串,请参阅**AVCODEC_MIME_TYPE**。 | | mime | MIME类型描述字符串,请参阅**AVCODEC_MIME_TYPE**。 |
**返回:** **返回:**
...@@ -174,10 +159,8 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByMime (const char * mime) ...@@ -174,10 +159,8 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByMime (const char * mime)
9 9
### OH_AudioDecoder_CreateByName() ### OH_AudioDecoder_CreateByName()
``` ```
OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByName (const char * name) OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByName (const char * name)
``` ```
...@@ -190,9 +173,9 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByName (const char * name) ...@@ -190,9 +173,9 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByName (const char * name)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---- | ---------------- |
| name | 音频解码器名称。 | | name | 音频解码器名称。 |
**返回:** **返回:**
...@@ -202,10 +185,8 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByName (const char * name) ...@@ -202,10 +185,8 @@ OH_AVCodec* OHOS::Media::OH_AudioDecoder_CreateByName (const char * name)
9 9
### OH_AudioDecoder_Destroy() ### OH_AudioDecoder_Destroy()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Destroy (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Destroy (OH_AVCodec * codec)
``` ```
...@@ -218,9 +199,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Destroy (OH_AVCodec * codec) ...@@ -218,9 +199,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Destroy (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -230,10 +211,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Destroy (OH_AVCodec * codec) ...@@ -230,10 +211,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Destroy (OH_AVCodec * codec)
9 9
### OH_AudioDecoder_Flush() ### OH_AudioDecoder_Flush()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Flush (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Flush (OH_AVCodec * codec)
``` ```
...@@ -248,9 +227,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Flush (OH_AVCodec * codec) ...@@ -248,9 +227,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Flush (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -260,10 +239,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Flush (OH_AVCodec * codec) ...@@ -260,10 +239,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Flush (OH_AVCodec * codec)
9 9
### OH_AudioDecoder_FreeOutputData() ### OH_AudioDecoder_FreeOutputData()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) OH_AVErrCode OHOS::Media::OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, uint32_t index )
``` ```
...@@ -276,10 +253,10 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, ui ...@@ -276,10 +253,10 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, ui
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | ------------------------------ |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| index | 输出缓冲区Buffer对应的索引值。 | | index | 输出缓冲区Buffer对应的索引值。 |
**返回:** **返回:**
...@@ -289,10 +266,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, ui ...@@ -289,10 +266,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, ui
9 9
### OH_AudioDecoder_GetOutputDescription() ### OH_AudioDecoder_GetOutputDescription()
``` ```
OH_AVFormat* OHOS::Media::OH_AudioDecoder_GetOutputDescription (OH_AVCodec * codec) OH_AVFormat* OHOS::Media::OH_AudioDecoder_GetOutputDescription (OH_AVCodec * codec)
``` ```
...@@ -305,9 +280,9 @@ OH_AVFormat* OHOS::Media::OH_AudioDecoder_GetOutputDescription (OH_AVCodec * cod ...@@ -305,9 +280,9 @@ OH_AVFormat* OHOS::Media::OH_AudioDecoder_GetOutputDescription (OH_AVCodec * cod
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -317,26 +292,24 @@ OH_AVFormat* OHOS::Media::OH_AudioDecoder_GetOutputDescription (OH_AVCodec * cod ...@@ -317,26 +292,24 @@ OH_AVFormat* OHOS::Media::OH_AudioDecoder_GetOutputDescription (OH_AVCodec * cod
9 9
### OH_AudioDecoder_IsValid() ### OH_AudioDecoder_IsValid()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_IsValid (OH_AVCodec * codec, bool * isValid ) OH_AVErrCode OHOS::Media::OH_AudioDecoder_IsValid (OH_AVCodec * codec, bool * isValid )
``` ```
**描述:** **描述:**
检查当前解码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态 检查当前解码器实例是否有效。
\@syscap SystemCapability.Multimedia.Media.AudioDecoder \@syscap SystemCapability.Multimedia.Media.AudioDecoder
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------- | ----------------------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| isValid | 指向布尔实例的指针,true:解码器实例有效,false:解码器实例无效。 | | isValid | 指向布尔实例的指针,true:解码器实例有效,false:解码器实例无效。 |
**返回:** **返回:**
...@@ -346,10 +319,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_IsValid (OH_AVCodec * codec, bool * is ...@@ -346,10 +319,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_IsValid (OH_AVCodec * codec, bool * is
10 10
### OH_AudioDecoder_Prepare() ### OH_AudioDecoder_Prepare()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Prepare (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Prepare (OH_AVCodec * codec)
``` ```
...@@ -362,9 +333,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Prepare (OH_AVCodec * codec) ...@@ -362,9 +333,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Prepare (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -374,10 +345,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Prepare (OH_AVCodec * codec) ...@@ -374,10 +345,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Prepare (OH_AVCodec * codec)
9 9
### OH_AudioDecoder_PushInputData() ### OH_AudioDecoder_PushInputData()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr ) OH_AVErrCode OHOS::Media::OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr )
``` ```
...@@ -392,11 +361,11 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uin ...@@ -392,11 +361,11 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uin
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | ------------------------------ |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| index | 输入缓冲区Buffer对应的索引值。 | | index | 输入缓冲区Buffer对应的索引值。 |
| attr | 描述缓冲区中包含的数据的信息。 | | attr | 描述缓冲区中包含的数据的信息。 |
**返回:** **返回:**
...@@ -406,10 +375,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uin ...@@ -406,10 +375,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uin
9 9
### OH_AudioDecoder_Reset() ### OH_AudioDecoder_Reset()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Reset (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Reset (OH_AVCodec * codec)
``` ```
...@@ -422,9 +389,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Reset (OH_AVCodec * codec) ...@@ -422,9 +389,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Reset (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -434,10 +401,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Reset (OH_AVCodec * codec) ...@@ -434,10 +401,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Reset (OH_AVCodec * codec)
9 9
### OH_AudioDecoder_SetCallback() ### OH_AudioDecoder_SetCallback()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData )
``` ```
...@@ -452,11 +417,11 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AV ...@@ -452,11 +417,11 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AV
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | ------------------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| callback | 所有回调函数的集合,请参见 **OH_AVCodecAsyncCallback**。 | | callback | 所有回调函数的集合,请参见**OH_AVCodecAsyncCallback**。 |
| userData | 用户特定数据。 | | userData | 用户特定数据。 |
**返回:** **返回:**
...@@ -466,10 +431,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AV ...@@ -466,10 +431,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AV
9 9
### OH_AudioDecoder_SetParameter() ### OH_AudioDecoder_SetParameter()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format )
``` ```
...@@ -484,10 +447,10 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_A ...@@ -484,10 +447,10 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_A
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------ | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| format | OH_AVFormat句柄指针。 | | format | OH_AVFormat句柄指针。 |
**返回:** **返回:**
...@@ -497,10 +460,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_A ...@@ -497,10 +460,8 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_A
9 9
### OH_AudioDecoder_Start() ### OH_AudioDecoder_Start()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Start (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Start (OH_AVCodec * codec)
``` ```
...@@ -515,9 +476,9 @@ Prepare成功后调用此接口启动解码器。 ...@@ -515,9 +476,9 @@ Prepare成功后调用此接口启动解码器。
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -527,10 +488,8 @@ Prepare成功后调用此接口启动解码器。 ...@@ -527,10 +488,8 @@ Prepare成功后调用此接口启动解码器。
9 9
### OH_AudioDecoder_Stop() ### OH_AudioDecoder_Stop()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioDecoder_Stop (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioDecoder_Stop (OH_AVCodec * codec)
``` ```
...@@ -545,9 +504,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Stop (OH_AVCodec * codec) ...@@ -545,9 +504,9 @@ OH_AVErrCode OHOS::Media::OH_AudioDecoder_Stop (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
......
# AudioEncoder # AudioEncoder
## 概述 ## 概述
AudioEncoder模块提供用于音频编码的函数。该模块在部分设备上可能不支持,可以通过[CanIUse](../syscap.md)接口确认。 AudioEncoder模块提供用于音频编码的函数。该模块在部分设备上可能不支持,可以通过[CanIUse](../syscap.md)接口确认。
...@@ -11,44 +10,38 @@ AudioEncoder模块提供用于音频编码的函数。该模块在部分设备 ...@@ -11,44 +10,38 @@ AudioEncoder模块提供用于音频编码的函数。该模块在部分设备
9 9
## 汇总 ## 汇总
### 文件 ### 文件
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) | 声明用于音频编码的Native API。<br>引用文件:<multimedia/player_framework/native_avcodec_audioencoder.h> | | [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) | 声明用于音频编码的Native API。`<br>`引用文件:<multimedia/player_framework/native_avcodec_audioencoder.h> |
### 函数 ### 函数
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| \*[OHOS::Media::OH_AudioEncoder_CreateByMime](#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例,大多数场景下建议使用此方式。 | | \*[OHOS::Media::OH_AudioEncoder_CreateByMime](#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioEncoder_CreateByName](#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例,使用此接口的前提是知道编码器的确切名称。 | | \*[OHOS::Media::OH_AudioEncoder_CreateByName](#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例,使用此接口的前提是知道编码器的确切名称。 |
| [OHOS::Media::OH_AudioEncoder_Destroy](#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源,销毁编码器实例。 | | [OHOS::Media::OH_AudioEncoder_Destroy](#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源,销毁编码器实例。 |
| [OHOS::Media::OH_AudioEncoder_SetCallback](#oh_audioencoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频编码器生成的事件。 | | [OHOS::Media::OH_AudioEncoder_SetCallback](#oh_audioencoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频编码器生成的事件。 |
| [OHOS::Media::OH_AudioEncoder_Configure](#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频编码器,通常需要配置编码后的音轨的描述信息。 | | [OHOS::Media::OH_AudioEncoder_Configure](#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频编码器,通常需要配置编码后的音轨的描述信息。 |
| [OHOS::Media::OH_AudioEncoder_Prepare](#oh_audioencoder_prepare) (OH_AVCodec \*codec) | 准备编码器的内部资源,在调用此接口之前必须调用Configure接口。 | | [OHOS::Media::OH_AudioEncoder_Prepare](#oh_audioencoder_prepare) (OH_AVCodec \*codec) | 准备编码器的内部资源,在调用此接口之前必须调用Configure接口。 |
| [OHOS::Media::OH_AudioEncoder_Start](#oh_audioencoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动编码器。 | | [OHOS::Media::OH_AudioEncoder_Start](#oh_audioencoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动编码器。 |
| [OHOS::Media::OH_AudioEncoder_Stop](#oh_audioencoder_stop) (OH_AVCodec \*codec) | 停止编码器。 | | [OHOS::Media::OH_AudioEncoder_Stop](#oh_audioencoder_stop) (OH_AVCodec \*codec) | 停止编码器。 |
| [OHOS::Media::OH_AudioEncoder_Flush](#oh_audioencoder_flush) (OH_AVCodec \*codec) | 清除编码器中缓存的输入和输出数据。 | | [OHOS::Media::OH_AudioEncoder_Flush](#oh_audioencoder_flush) (OH_AVCodec \*codec) | 清除编码器中缓存的输入和输出数据。 |
| [OHOS::Media::OH_AudioEncoder_Reset](#oh_audioencoder_reset) (OH_AVCodec \*codec) | 重置编码器。 | | [OHOS::Media::OH_AudioEncoder_Reset](#oh_audioencoder_reset) (OH_AVCodec \*codec) | 重置编码器。 |
| \*[OHOS::Media::OH_AudioEncoder_GetOutputDescription](#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | 获取编码器输出数据的描述信息,详细信息请参见[OH_AVFormat](native__avformat_8h.md)。 | | \*[OHOS::Media::OH_AudioEncoder_GetOutputDescription](#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | 获取编码器输出数据的描述信息,详细信息请参见[OH_AVFormat](native__avformat_8h.md)。 |
| [OHOS::Media::OH_AudioEncoder_SetParameter](#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 | | [OHOS::Media::OH_AudioEncoder_SetParameter](#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 |
| [OHOS::Media::OH_AudioEncoder_PushInputData](#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频编码器。 | | [OHOS::Media::OH_AudioEncoder_PushInputData](#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频编码器。 |
| [OHOS::Media::OH_AudioEncoder_FreeOutputData](#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 | | [OHOS::Media::OH_AudioEncoder_FreeOutputData](#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
| [OHOS::Media::OH_AudioEncoder_IsValid](#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态。 | | [OHOS::Media::OH_AudioEncoder_IsValid](#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效。 |
## 函数说明 ## 函数说明
### OH_AudioEncoder_Configure() ### OH_AudioEncoder_Configure()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFormat * format )
``` ```
...@@ -63,10 +56,10 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFo ...@@ -63,10 +56,10 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFo
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------ | --------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| format | 指向OH_AVFormat的指针,给出要编码的音频轨道的描述。 | | format | 指向OH_AVFormat的指针,给出要编码的音频轨道的描述。 |
**返回:** **返回:**
...@@ -76,10 +69,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFo ...@@ -76,10 +69,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFo
9 9
### OH_AudioEncoder_CreateByMime() ### OH_AudioEncoder_CreateByMime()
``` ```
OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime) OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime)
``` ```
...@@ -92,9 +83,9 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime) ...@@ -92,9 +83,9 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---- | ------------------------------------------------------- |
| mime | MIME类型描述字符串,请参阅 **AVCODEC_MIME_TYPE**。 | | mime | MIME类型描述字符串,请参阅**AVCODEC_MIME_TYPE**。 |
**返回:** **返回:**
...@@ -104,10 +95,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime) ...@@ -104,10 +95,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime)
9 9
### OH_AudioEncoder_CreateByName() ### OH_AudioEncoder_CreateByName()
``` ```
OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name) OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name)
``` ```
...@@ -120,9 +109,9 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name) ...@@ -120,9 +109,9 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---- | ---------------- |
| name | 音频编码器名称。 | | name | 音频编码器名称。 |
**返回:** **返回:**
...@@ -132,10 +121,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name) ...@@ -132,10 +121,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name)
9 9
### OH_AudioEncoder_Destroy() ### OH_AudioEncoder_Destroy()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec)
``` ```
...@@ -148,9 +135,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec) ...@@ -148,9 +135,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -160,10 +147,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec) ...@@ -160,10 +147,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec)
9 9
### OH_AudioEncoder_Flush() ### OH_AudioEncoder_Flush()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec)
``` ```
...@@ -178,9 +163,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec) ...@@ -178,9 +163,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -190,10 +175,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec) ...@@ -190,10 +175,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec)
9 9
### OH_AudioEncoder_FreeOutputData() ### OH_AudioEncoder_FreeOutputData()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, uint32_t index )
``` ```
...@@ -206,10 +189,10 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, ui ...@@ -206,10 +189,10 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, ui
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | ------------------------------ |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| index | 输出缓冲区Buffer对应的索引值。 | | index | 输出缓冲区Buffer对应的索引值。 |
**返回:** **返回:**
...@@ -219,10 +202,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, ui ...@@ -219,10 +202,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, ui
9 9
### OH_AudioEncoder_GetOutputDescription() ### OH_AudioEncoder_GetOutputDescription()
``` ```
OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * codec) OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * codec)
``` ```
...@@ -237,9 +218,9 @@ OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * cod ...@@ -237,9 +218,9 @@ OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * cod
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -249,26 +230,24 @@ OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * cod ...@@ -249,26 +230,24 @@ OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * cod
9 9
### OH_AudioEncoder_IsValid() ### OH_AudioEncoder_IsValid()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec * codec, bool * isValid ) OH_AVErrCode OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec * codec, bool * isValid )
``` ```
**描述:** **描述:**
检查当前编码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态 检查当前编码器实例是否有效。
\@syscap SystemCapability.Multimedia.Media.AudioEncoder \@syscap SystemCapability.Multimedia.Media.AudioEncoder
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------- | ----------------------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| isValid | 指向布尔实例的指针,true:编码器实例有效,false:编码器实例无效。 | | isValid | 指向布尔实例的指针,true:编码器实例有效,false:编码器实例无效。 |
**返回:** **返回:**
...@@ -278,10 +257,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec * codec, bool * is ...@@ -278,10 +257,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec * codec, bool * is
10 10
### OH_AudioEncoder_Prepare() ### OH_AudioEncoder_Prepare()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec)
``` ```
...@@ -294,9 +271,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec) ...@@ -294,9 +271,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -306,10 +283,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec) ...@@ -306,10 +283,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec)
9 9
### OH_AudioEncoder_PushInputData() ### OH_AudioEncoder_PushInputData()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr ) OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr )
``` ```
...@@ -324,11 +299,11 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uin ...@@ -324,11 +299,11 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uin
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | ------------------------------ |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| index | 输入缓冲区Buffer对应的索引值。 | | index | 输入缓冲区Buffer对应的索引值。 |
| attr | 描述缓冲区中包含的数据的信息。 | | attr | 描述缓冲区中包含的数据的信息。 |
**返回:** **返回:**
...@@ -338,10 +313,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uin ...@@ -338,10 +313,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uin
9 9
### OH_AudioEncoder_Reset() ### OH_AudioEncoder_Reset()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec * codec)
``` ```
...@@ -354,18 +327,16 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec * codec) ...@@ -354,18 +327,16 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅[OH_AVErrCode](_core.md#oh_averrcode) 如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅[OH_AVErrCode](_core.md#oh_averrcode)
### OH_AudioEncoder_SetCallback() ### OH_AudioEncoder_SetCallback()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData )
``` ```
...@@ -380,11 +351,11 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AV ...@@ -380,11 +351,11 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AV
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | ------------------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| callback | 所有回调函数的集合,请参见 **OH_AVCodecAsyncCallback**。 | | callback | 所有回调函数的集合,请参见**OH_AVCodecAsyncCallback**。 |
| userData | 用户特定数据。 | | userData | 用户特定数据。 |
**返回:** **返回:**
...@@ -394,10 +365,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AV ...@@ -394,10 +365,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AV
9 9
### OH_AudioEncoder_SetParameter() ### OH_AudioEncoder_SetParameter()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format )
``` ```
...@@ -412,10 +381,10 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_A ...@@ -412,10 +381,10 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_A
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------ | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
| format | OH_AVFormat句柄指针。 | | format | OH_AVFormat句柄指针。 |
**返回:** **返回:**
...@@ -425,10 +394,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_A ...@@ -425,10 +394,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_A
9 9
### OH_AudioEncoder_Start() ### OH_AudioEncoder_Start()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Start (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Start (OH_AVCodec * codec)
``` ```
...@@ -443,9 +410,9 @@ Prepare成功后调用此接口启动编码器。 ...@@ -443,9 +410,9 @@ Prepare成功后调用此接口启动编码器。
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
...@@ -455,10 +422,8 @@ Prepare成功后调用此接口启动编码器。 ...@@ -455,10 +422,8 @@ Prepare成功后调用此接口启动编码器。
9 9
### OH_AudioEncoder_Stop() ### OH_AudioEncoder_Stop()
``` ```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec * codec) OH_AVErrCode OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec * codec)
``` ```
...@@ -471,9 +436,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec * codec) ...@@ -471,9 +436,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec * codec)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 | | codec | 指向OH_AVCodec实例的指针。 |
**返回:** **返回:**
......
# native_avcodec_audiodecoder.h # native_avcodec_audiodecoder.h
## 概述 ## 概述
声明用于音频解码的Native API。 声明用于音频解码的Native API。
...@@ -13,26 +12,24 @@ ...@@ -13,26 +12,24 @@
[AudioDecoder](_audio_decoder.md) [AudioDecoder](_audio_decoder.md)
## 汇总 ## 汇总
### 函数 ### 函数
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| \*[OHOS::Media::OH_AudioDecoder_CreateByMime](_audio_decoder.md#oh_audiodecoder_createbymime) (const char \*mime) | 根据MIME类型创建音频解码器实例,大多数场景下建议使用此方式。 | | \*[OHOS::Media::OH_AudioDecoder_CreateByMime](_audio_decoder.md#oh_audiodecoder_createbymime) (const char \*mime) | 根据MIME类型创建音频解码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioDecoder_CreateByName](_audio_decoder.md#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建音频解码器实例,使用此接口的前提是知道解码器的确切名称。 | | \*[OHOS::Media::OH_AudioDecoder_CreateByName](_audio_decoder.md#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建音频解码器实例,使用此接口的前提是知道解码器的确切名称。 |
| [OHOS::Media::OH_AudioDecoder_Destroy](_audio_decoder.md#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源,销毁解码器实例。 | | [OHOS::Media::OH_AudioDecoder_Destroy](_audio_decoder.md#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源,销毁解码器实例。 |
| [OHOS::Media::OH_AudioDecoder_SetCallback](_audio_decoder.md#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频解码器生成的事件。 | | [OHOS::Media::OH_AudioDecoder_SetCallback](_audio_decoder.md#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频解码器生成的事件。 |
| [OHOS::Media::OH_AudioDecoder_Configure](_audio_decoder.md#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频解码器,通常需要配置从容器中提取的音频描述信息。 | | [OHOS::Media::OH_AudioDecoder_Configure](_audio_decoder.md#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频解码器,通常需要配置从容器中提取的音频描述信息。 |
| [OHOS::Media::OH_AudioDecoder_Prepare](_audio_decoder.md#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | 准备解码器的内部资源,在调用此接口之前必须调用Configure接口。 | | [OHOS::Media::OH_AudioDecoder_Prepare](_audio_decoder.md#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | 准备解码器的内部资源,在调用此接口之前必须调用Configure接口。 |
| [OHOS::Media::OH_AudioDecoder_Start](_audio_decoder.md#oh_audiodecoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动解码器。 | | [OHOS::Media::OH_AudioDecoder_Start](_audio_decoder.md#oh_audiodecoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动解码器。 |
| [OHOS::Media::OH_AudioDecoder_Stop](_audio_decoder.md#oh_audiodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。 | | [OHOS::Media::OH_AudioDecoder_Stop](_audio_decoder.md#oh_audiodecoder_stop) (OH_AVCodec \*codec) | 停止解码器。 |
| [OHOS::Media::OH_AudioDecoder_Flush](_audio_decoder.md#oh_audiodecoder_flush) (OH_AVCodec \*codec) | 清除解码器中缓存的输入和输出数据。 | | [OHOS::Media::OH_AudioDecoder_Flush](_audio_decoder.md#oh_audiodecoder_flush) (OH_AVCodec \*codec) | 清除解码器中缓存的输入和输出数据。 |
| [OHOS::Media::OH_AudioDecoder_Reset](_audio_decoder.md#oh_audiodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。如果要继续解码,需要再次调用Configure接口配置解码器实例 。 | | [OHOS::Media::OH_AudioDecoder_Reset](_audio_decoder.md#oh_audiodecoder_reset) (OH_AVCodec \*codec) | 重置解码器。如果要继续解码,需要再次调用Configure接口配置解码器实例 。 |
| \*[OHOS::Media::OH_AudioDecoder_GetOutputDescription](_audio_decoder.md#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取解码器输出数据的描述信息,详细信息请参见**OH_AVFormat**。 | | \*[OHOS::Media::OH_AudioDecoder_GetOutputDescription](_audio_decoder.md#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | 获取解码器输出数据的描述信息,详细信息请参见**OH_AVFormat**。 |
| [OHOS::Media::OH_AudioDecoder_SetParameter](_audio_decoder.md#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置解码器的动态参数。注意:该接口必须在解码器启动后才能调用。另外,参数配置错误可能会导致解码失败。 | | [OHOS::Media::OH_AudioDecoder_SetParameter](_audio_decoder.md#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置解码器的动态参数。注意:该接口必须在解码器启动后才能调用。另外,参数配置错误可能会导致解码失败。 |
| [OHOS::Media::OH_AudioDecoder_PushInputData](_audio_decoder.md#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频解码器。 | | [OHOS::Media::OH_AudioDecoder_PushInputData](_audio_decoder.md#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频解码器。 |
| [OHOS::Media::OH_AudioDecoder_FreeOutputData](_audio_decoder.md#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给解码器。 | | [OHOS::Media::OH_AudioDecoder_FreeOutputData](_audio_decoder.md#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给解码器。 |
| [OHOS::Media::OH_AudioDecoder_IsValid](_audio_decoder.md#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。 | | [OHOS::Media::OH_AudioDecoder_IsValid](_audio_decoder.md#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效。 |
# native_avcodec_audioencoder.h # native_avcodec_audioencoder.h
## 概述 ## 概述
声明用于音频编码的Native API。 声明用于音频编码的Native API。
...@@ -13,26 +12,24 @@ ...@@ -13,26 +12,24 @@
[AudioEncoder](_audio_encoder.md) [AudioEncoder](_audio_encoder.md)
## 汇总 ## 汇总
### 函数 ### 函数
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| \*[OHOS::Media::OH_AudioEncoder_CreateByMime](_audio_encoder.md#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例,大多数场景下建议使用此方式。 | | \*[OHOS::Media::OH_AudioEncoder_CreateByMime](_audio_encoder.md#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioEncoder_CreateByName](_audio_encoder.md#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例,使用此接口的前提是知道编码器的确切名称。 | | \*[OHOS::Media::OH_AudioEncoder_CreateByName](_audio_encoder.md#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例,使用此接口的前提是知道编码器的确切名称。 |
| [OHOS::Media::OH_AudioEncoder_Destroy](_audio_encoder.md#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源,销毁编码器实例。 | | [OHOS::Media::OH_AudioEncoder_Destroy](_audio_encoder.md#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源,销毁编码器实例。 |
| [OHOS::Media::OH_AudioEncoder_SetCallback](_audio_encoder.md#oh_audioencoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频编码器生成的事件。 | | [OHOS::Media::OH_AudioEncoder_SetCallback](_audio_encoder.md#oh_audioencoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | 设置异步回调函数,使您的应用程序可以响应音频编码器生成的事件。 |
| [OHOS::Media::OH_AudioEncoder_Configure](_audio_encoder.md#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频编码器,通常需要配置编码后的音轨的描述信息。 | | [OHOS::Media::OH_AudioEncoder_Configure](_audio_encoder.md#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | 要配置音频编码器,通常需要配置编码后的音轨的描述信息。 |
| [OHOS::Media::OH_AudioEncoder_Prepare](_audio_encoder.md#oh_audioencoder_prepare) (OH_AVCodec \*codec) | 准备编码器的内部资源,在调用此接口之前必须调用Configure接口。 | | [OHOS::Media::OH_AudioEncoder_Prepare](_audio_encoder.md#oh_audioencoder_prepare) (OH_AVCodec \*codec) | 准备编码器的内部资源,在调用此接口之前必须调用Configure接口。 |
| [OHOS::Media::OH_AudioEncoder_Start](_audio_encoder.md#oh_audioencoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动编码器。 | | [OHOS::Media::OH_AudioEncoder_Start](_audio_encoder.md#oh_audioencoder_start) (OH_AVCodec \*codec) | Prepare成功后调用此接口启动编码器。 |
| [OHOS::Media::OH_AudioEncoder_Stop](_audio_encoder.md#oh_audioencoder_stop) (OH_AVCodec \*codec) | 停止编码器。 | | [OHOS::Media::OH_AudioEncoder_Stop](_audio_encoder.md#oh_audioencoder_stop) (OH_AVCodec \*codec) | 停止编码器。 |
| [OHOS::Media::OH_AudioEncoder_Flush](_audio_encoder.md#oh_audioencoder_flush) (OH_AVCodec \*codec) | 清除编码器中缓存的输入和输出数据。 | | [OHOS::Media::OH_AudioEncoder_Flush](_audio_encoder.md#oh_audioencoder_flush) (OH_AVCodec \*codec) | 清除编码器中缓存的输入和输出数据。 |
| [OHOS::Media::OH_AudioEncoder_Reset](_audio_encoder.md#oh_audioencoder_reset) (OH_AVCodec \*codec) | 重置编码器。 | | [OHOS::Media::OH_AudioEncoder_Reset](_audio_encoder.md#oh_audioencoder_reset) (OH_AVCodec \*codec) | 重置编码器。 |
| \*[OHOS::Media::OH_AudioEncoder_GetOutputDescription](_audio_encoder.md#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | 获取编码器输出数据的描述信息,详细信息请参见**OH_AVFormat**。 | | \*[OHOS::Media::OH_AudioEncoder_GetOutputDescription](_audio_encoder.md#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | 获取编码器输出数据的描述信息,详细信息请参见**OH_AVFormat**。 |
| [OHOS::Media::OH_AudioEncoder_SetParameter](_audio_encoder.md#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 | | [OHOS::Media::OH_AudioEncoder_SetParameter](_audio_encoder.md#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 |
| [OHOS::Media::OH_AudioEncoder_PushInputData](_audio_encoder.md#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频编码器。 | | [OHOS::Media::OH_AudioEncoder_PushInputData](_audio_encoder.md#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频编码器。 |
| [OHOS::Media::OH_AudioEncoder_FreeOutputData](_audio_encoder.md#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 | | [OHOS::Media::OH_AudioEncoder_FreeOutputData](_audio_encoder.md#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
| [OHOS::Media::OH_AudioEncoder_IsValid](_audio_encoder.md#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态。 | | [OHOS::Media::OH_AudioEncoder_IsValid](_audio_encoder.md#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册