The file declares the struct and enums used by the AVTranscoder.
File to include: <multimedia/player_framework/avtranscoder_base.h>
Library: libavtranscoder.so
System capability: SystemCapability.Multimedia.Media.AVTranscoder
Since: 20
Related module: AVTranscoder
| Name | typedef Keyword | Description |
|---|---|---|
| OH_AVTranscoder | OH_AVTranscoder | Initializes an AVTranscoder. |
| OH_AVTranscoder_Config | OH_AVTranscoder_Config | Initializes an AVTranscoder_Config. |
| Name | typedef Keyword | Description |
|---|---|---|
| OH_AVTranscoder_State | OH_AVTranscoder_State | Enumerates the transcoding states. |
| Name | typedef Keyword | Description |
|---|---|---|
| typedef void (*OH_AVTranscoder_OnStateChange)(OH_AVTranscoder *transcoder, OH_AVTranscoder_State state, void *userData) | OH_AVTranscoder_OnStateChange | Defines a callback invoked when the state of the transcoding process changes. |
| typedef void (*OH_AVTranscoder_OnError)(OH_AVTranscoder *transcoder, int32_t errorCode, const char *errorMsg, void *userData) | OH_AVTranscoder_OnError | Defines a callback invoked when an error occurs during the transcoding process. |
| typedef void (*OH_AVTranscoder_OnProgressUpdate)(OH_AVTranscoder *transcoder, int32_t progress, void *userData) | OH_AVTranscoder_OnProgressUpdate | Defines a callback invoked when the progress of the transcoding process is updated. |
enum OH_AVTranscoder_State
Description
Enumerates the transcoding states.
System capability: SystemCapability.Multimedia.Media.AVTranscoder
Since: 20
| Enum Item | Description |
|---|---|
| AVTRANSCODER_PREPARED = 1 | The transcoding process is prepared and ready to start. |
| AVTRANSCODER_STARTED = 2 | The transcoding process has started. |
| AVTRANSCODER_PAUSED = 3 | The transcoding process is paused. |
| AVTRANSCODER_CANCELLED = 4 | The transcoding process has been canceled. |
| AVTRANSCODER_COMPLETED = 5 | The transcoding process is completed. |
typedef void (*OH_AVTranscoder_OnStateChange)(OH_AVTranscoder *transcoder, OH_AVTranscoder_State state, void *userData)
Description
Defines a callback invoked when the state of the transcoding process changes.
System capability: SystemCapability.Multimedia.Media.AVTranscoder
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_AVTranscoder *transcoder | Pointer to an OH_AVTranscoder instance. |
| OH_AVTranscoder_State state | Transcoding state. For details, see OH_AVTranscoder_State. |
| void *userData | Pointer to user-defined data. |
typedef void (*OH_AVTranscoder_OnError)(OH_AVTranscoder *transcoder, int32_t errorCode, const char *errorMsg,void *userData)
Description
Defines a callback invoked when an error occurs during the transcoding process.
System capability: SystemCapability.Multimedia.Media.AVTranscoder
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_AVTranscoder *transcoder | Pointer to an OH_AVTranscoder instance. |
| int32_t errorCode | Error code. AV_ERR_NO_MEMORY: No memory. The value is 1. AV_ERR_OPERATE_NOT_PERMIT: The operation is not allowed. The value is 2. AV_ERR_INVALID_VAL: The parameter check fails. The value is 3. AV_ERR_IO: I/O error. The value is 4. AV_ERR_INVALID_STATE: The operation is not supported in the current state. The value is 8. AV_ERR_UNSUPPORT: The function is not supported. The value is 9. |
| const char *errorMsg | Pointer to the error message. |
| void *userData | Pointer to user-defined data. |
typedef void (*OH_AVTranscoder_OnProgressUpdate)(OH_AVTranscoder *transcoder, int32_t progress, void *userData)
Description
Defines a callback invoked when the progress of the transcoding process is updated.
System capability: SystemCapability.Multimedia.Media.AVTranscoder
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_AVTranscoder *transcoder | Pointer to an OH_AVTranscoder instance. |
| int32_t progress | Transcoding progress, in percentage. |
| void *userData | Pointer to user-defined data. |