native_avcodec_audioencoder.h

Overview

The native_avcodec_audioencoder.h file declares the native APIs used for audio encoding.

Since

9

Related Modules

AudioEncoder

Summary

Functions

Name Description
*OHOS::Media::OH_AudioEncoder_CreateByMime (const char *mime) Creates an audio encoder instance based on a Multipurpose Internet Mail Extension (MIME) type. This function is recommended in most cases.
*OHOS::Media::OH_AudioEncoder_CreateByName (const char *name) Creates an audio encoder instance based on an encoder name. To use this function, you must know the exact name of the encoder.
OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec *codec) Clears the internal resources of an audio encoder and destroys the encoder instance.
OHOS::Media::OH_AudioEncoder_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 encoder.
OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec *codec, OH_AVFormat *format) Configures an audio encoder. Typically, you need to configure the description information about the audio track to be encoded.
OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec *codec) Prepares internal resources for an audio encoder. This function must be called after Configure.
OHOS::Media::OH_AudioEncoder_Start (OH_AVCodec *codec) Starts an audio encoder. This function can be called only after the encoder is prepared successfully.
OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec *codec) Stops an audio encoder.
OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec *codec) Clears the input and output data in the internal buffer of an audio encoder.
OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec *codec) Resets an audio encoder.
*OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec *codec) Obtains the description information about the output data of an audio encoder. For details, see OH_AVFormat.
OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format) Sets dynamic parameters for an audio encoder.
OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr) Pushes the input buffer filled with data to an audio encoder.
OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index) Frees an output buffer of an audio encoder.
OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec *codec, bool *isValid) Checks whether an audio encoder instance is valid.