FormatFrame

Overview

Related Modules:

Format

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

  1. uint8_t*FormatFrame::data

Description:

Address of the data frame buffer

durationUs

  1. int64_tFormatFrame::durationUs

Description:

Data frame duration, in us

frameIndex

  1. uint32_tFormatFrame::frameIndex

Description:

Data frame index. For the MPF container, the value indicates the index of the sub-image frame.

frameType

  1. [FrameType]($api-api-SmartVision-Devices-Format.md#gad495a9f61af7fff07d7e97979d1ab854) FormatFrame::frameType

Description:

Data frame type. For details, see FrameType.

isKeyFrame

  1. boolFormatFrame::isKeyFrame

Description:

Keyframe flag. false: The data frame is not a keyframe. true: The data frame is a keyframe.

item

  1. [ParameterItem]($api-api-SmartVision-Devices-ParameterItem.md)*FormatFrame::item

Description:

Pointer to the parameter array

itemCnt

  1. int32_tFormatFrame::itemCnt

Description:

Number of parameters, which can be used for information such as side data, PSSH, DRM, and HDR.

len

  1. uint32_tFormatFrame::len

Description:

Data frame length

position

  1. int64_tFormatFrame::position

Description:

Position of the data frame in the file

timestampUs

  1. int64_tFormatFrame::timestampUs

Description:

Timestamp of a data frame, in us

trackId

  1. uint32_tFormatFrame::trackId

Description:

Index of the track where the data frame is located