k4a_image_get_timestamp_usec()

K4A_DEPRECATED_EXPORT uint64_t k4a_image_get_timestamp_usec ( k4a_image_t  image_handle )

related

Get the image's device timestamp in microseconds.

Parameters

image_handle

Handle of the image for which the get operation is performed on.

Remarks

Returns the device timestamp of the image. Timestamps are recorded by the device and represent the mid-point of exposure. They may be used for relative comparison, but their absolute value has no defined meaning.

Returns

If the image_handle is invalid or if no timestamp was set for the image, this function will return 0. It is also possible for 0 to be a valid timestamp originating from the beginning of a recording or the start of streaming.

Deprecated:

Deprecated starting in 1.2.0. Please use k4a_image_get_device_timestamp_usec().