[][src]Function k4a_sys_temp::k4a_image_get_device_timestamp_usec

pub unsafe extern "C" fn k4a_image_get_device_timestamp_usec(
    image_handle: k4a_image_t
) -> u64

Get the image's device timestamp in microseconds.

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

\remarks Returns the device timestamp of the image, as captured by the hardware. 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 \p 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.

\relates k4a_image_t

\xmlonly k4a.h (include k4a/k4a.h) k4a.lib k4a.dll \endxmlonly