_TAG_FRAME_INFO Struct Reference

Collaboration diagram for _TAG_FRAME_INFO:

Data Fields
PVCAM_FRAME_INFO_GUID	FrameInfoGUID
int16	hCam
int32	FrameNr
long64	TimeStamp
int32	ReadoutTime
long64	TimeStampBOF

Detailed Description

Structure used to uniquely identify frames in the camera.

Please note that this information is generated by the low level device driver. While the information is accurate for slower acquisitions and most legacy CCD cameras, the timestamps are still obtained from the operating systems. For that reason the timestamps may not always represent the time of actual, in-camera acquisition. This is especially true for fast CMOS cameras that implement an internal frame buffer. Such cameras often report both the BOF and EOF timestamps as identical numbers with the readout time reported as 0. For accurate hardware timestamps please see Embedded Frame Metadata feature.

Field Documentation

FrameInfoGUID

PVCAM_FRAME_INFO_GUID _TAG_FRAME_INFO::FrameInfoGUID

FrameNr

int32 _TAG_FRAME_INFO::FrameNr

Frame number, 1-based.

hCam

int16 _TAG_FRAME_INFO::hCam

Handle of the camera that sent this structure.

ReadoutTime

int32 _TAG_FRAME_INFO::ReadoutTime

Frame readout time.

TimeStamp

long64 _TAG_FRAME_INFO::TimeStamp

Frame EOF (end-of-frame) timestamp.

TimeStampBOF

long64 _TAG_FRAME_INFO::TimeStampBOF

Frame BOF (beginning-of-frame timestamp.