• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# native_avcodec_audiodecoder.h
2
3## Overview
4
5The **native_avcodec_audiodecoder.h** file declares the native APIs used for audio decoding.
6
7**Since**
8
99
10
11**Related Modules**
12
13[AudioDecoder](_audio_decoder.md)
14
15## Summary
16
17### Functions
18
19| Name                                                                                                                                                          | Description                                                                                                |
20| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
21| \*[OHOS::Media::OH_AudioDecoder_CreateByMime](_audio_decoder.md#oh_audiodecoder_createbymime) (const char \*mime)                                                 | Creates an audio decoder instance based on a Multipurpose Internet Mail Extension (MIME) type. This function is recommended in most cases.                                        |
22| \*[OHOS::Media::OH_AudioDecoder_CreateByName](_audio_decoder.md#oh_audiodecoder_createbyname) (const char \*name)                                                 | Creates an audio decoder instance based on a decoder name. To use this function, you must know the exact name of the decoder.                      |
23| [OHOS::Media::OH_AudioDecoder_Destroy](_audio_decoder.md#oh_audiodecoder_destroy) (OH_AVCodec \*codec)                                                            | Clears the internal resources of an audio decoder and destroys the decoder instance.                                                                |
24| [OHOS::Media::OH_AudioDecoder_SetCallback](_audio_decoder.md#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, OH_AVCodecAsyncCallback callback, void \*userData) | Sets an asynchronous callback so that your application can respond to events generated by an audio decoder.                                      |
25| [OHOS::Media::OH_AudioDecoder_Configure](_audio_decoder.md#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format)                                  | Configures an audio decoder. Typically, you need to configure the audio description information that can be extracted from the container.                                          |
26| [OHOS::Media::OH_AudioDecoder_Prepare](_audio_decoder.md#oh_audiodecoder_prepare) (OH_AVCodec \*codec)                                                            | Prepares internal resources for an audio decoder. This function must be called after **Configure**.                                       |
27| [OHOS::Media::OH_AudioDecoder_Start](_audio_decoder.md#oh_audiodecoder_start) (OH_AVCodec \*codec)                                                                | Starts an audio decoder. This function can be called only after the decoder is prepared successfully.                                                                 |
28| [OHOS::Media::OH_AudioDecoder_Stop](_audio_decoder.md#oh_audiodecoder_stop) (OH_AVCodec \*codec)                                                                  | Stops an audio decoder.                                                                                        |
29| [OHOS::Media::OH_AudioDecoder_Flush](_audio_decoder.md#oh_audiodecoder_flush) (OH_AVCodec \*codec)                                                                | Clears the input and output data in the internal buffer of an audio decoder.                                                                  |
30| [OHOS::Media::OH_AudioDecoder_Reset](_audio_decoder.md#oh_audiodecoder_reset) (OH_AVCodec \*codec)                                                                | Resets an audio decoder. To continue decoding, you must call **Configure** to configure the decoder again.                              |
31| \*[OHOS::Media::OH_AudioDecoder_GetOutputDescription](_audio_decoder.md#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec)                                | Obtains the description information about the output data of an audio decoder. For details, see **OH_AVFormat**.                                 |
32| [OHOS::Media::OH_AudioDecoder_SetParameter](_audio_decoder.md#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format)                            | Sets dynamic parameters for an audio decoder. This function can be called only after the decoder is started. Incorrect parameter settings may cause decoding failure.|
33| [OHOS::Media::OH_AudioDecoder_PushInputData](_audio_decoder.md#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr)     | Pushes the input buffer filled with data to an audio decoder.                                                          |
34| [OHOS::Media::OH_AudioDecoder_FreeOutputData](_audio_decoder.md#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index)                              | Frees an output buffer of an audio decoder.                                                                  |
35| [OHOS::Media::OH_AudioDecoder_IsValid](_audio_decoder.md#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid)                                            | Checks whether an audio decoder instance is valid.                                                                        |
36