# FormatFrame ## **Overview** **Related Modules:** [Format](format.md) **Description:** Defines the data frame, which is used for data transferring. **Since:** 1.0 **Version:** 1.0 ## **Summary** ## Data Fields

Variable Name

Description

frameType

FrameType

trackId

uint32_t

isKeyFrame

bool

timestampUs

int64_t

durationUs

int64_t

data

uint8_t *

len

uint32_t

frameIndex

uint32_t

position

int64_t

itemCnt

int32_t

item

ParameterItem *

## **Details** ## **Field Documentation** ## data ``` uint8_t* FormatFrame::data ``` **Description:** Address of the data frame buffer ## durationUs ``` int64_t FormatFrame::durationUs ``` **Description:** Data frame duration, in us ## frameIndex ``` uint32_t FormatFrame::frameIndex ``` **Description:** Data frame index. For the MPF container, the value indicates the index of the sub-image frame. ## frameType ``` [FrameType](format.md#gad495a9f61af7fff07d7e97979d1ab854) FormatFrame::frameType ``` **Description:** Data frame type. For details, see [FrameType](format.md#gad495a9f61af7fff07d7e97979d1ab854). ## isKeyFrame ``` bool FormatFrame::isKeyFrame ``` **Description:** Keyframe flag. **false**: The data frame is not a keyframe. **true**: The data frame is a keyframe. ## item ``` [ParameterItem](parameteritem.md)* FormatFrame::item ``` **Description:** Pointer to the parameter array ## itemCnt ``` int32_t FormatFrame::itemCnt ``` **Description:** Number of parameters, which can be used for information such as side data, PSSH, DRM, and HDR. ## len ``` uint32_t FormatFrame::len ``` **Description:** Data frame length ## position ``` int64_t FormatFrame::position ``` **Description:** Position of the data frame in the file ## timestampUs ``` int64_t FormatFrame::timestampUs ``` **Description:** Timestamp of a data frame, in us ## trackId ``` uint32_t FormatFrame::trackId ``` **Description:** Index of the track where the data frame is located