◆ k4abt_tracker_enqueue_capture()

k4a_wait_result_t k4abt_tracker_enqueue_capture	(	k4abt_tracker_t	tracker_handle,
		k4a_capture_t	sensor_capture_handle,
		int32_t	timeout_in_ms
	)

Parameters

tracker_handle	Handle obtained by k4abt_tracker_create().
sensor_capture_handle	Handle to a sensor capture returned by k4a_device_get_capture() from k4a SDK. It should contain the depth data for this function to work. Otherwise the function will return failure.
timeout_in_ms	Specifies the time in milliseconds the function should block waiting to add the sensor capture to the tracker process queue. 0 is a check of the status without blocking. Passing a value of K4A_WAIT_INFINITE will block indefinitely until the capture is added to the process queue.

Returns: K4A_WAIT_RESULT_SUCCEEDED if a sensor capture is successfully added to the processing queue. If the queue is still full before the timeout elapses, the function will return K4A_WAIT_RESULT_TIMEOUT. All other failures will return K4A_WAIT_RESULT_FAILED.

Remarks: Add a k4a capture to the tracker input queue so that it can be processed asynchronously to generate the body tracking result. The processed results will be added to an output queue maintained by k4abt_tracker_t instance. Call k4abt_tracker_pop_result to get the result and pop it from the output queue. If the input queue or output queue is full, this function will block up until the timeout is reached. Once body_frame data is read, the user must call k4abt_frame_release() to return the allocated memory to the SDK; Upon successfully insert a sensor capture to the input queue this function will return success.; This function returns K4A_WAIT_RESULT_FAILED when either the tracker is shut down by k4abt_tracker_shutdown() API, or an internal problem is encountered before adding to the input queue: such as low memory condition, sensor_capture_handle not containing the depth data, or other unexpected issues.