RetrieveFrameData
Function Usage
Retrieves decoded data of one frame. This API is synchronous. The CopyFrame function provided in SetCopyFrameFunc needs to be used for copying data.
Restrictions
N/A
Prototype
DecoderRetCode RetrieveFrameData(uint8_t *buffer, uint32_t maxLen, uint32_t *filledLen)
Parameter Description
Field Name |
Input/Output |
Field Type |
Description |
|---|---|---|---|
buffer |
Input |
uint8_t * |
Buffer for receiving output data. |
Field Name |
Input/Output |
Field Type |
Description |
|---|---|---|---|
maxLen |
Input |
uint32_t |
Maximum length of the output buffer. |
Field Name |
Input/Output |
Field Type |
Description |
|---|---|---|---|
filledLen |
Output |
uint32_t * |
Actual length of the output data. |
Return Value Description
Data type: DecoderRetCode
The value can be any of the following:
- VIDEO_DECODER_SUCCESS: The decoded data is successfully retrieved.
- VIDEO_DECODER_DECODE_FAIL: Failed to retrieve the decoded data.
- VIDEO_DECODER_READ_UNDERFLOW: Read underflow.
Parent topic: Decoding APIs (C and C++)