Azure Kinect Sensor SDK  refs/heads/master
Documentation for https://github.com/Microsoft/Azure-Kinect-Sensor-SDK
k4a_device_t Class Reference

Handle to an Azure Kinect device. More...

#include <k4a/k4a.h>

Related Functions

(Note that these are not member functions.)

uint32_t k4a_device_get_installed_count (void)
 Gets the number of connected devices. More...
 
k4a_result_t k4a_device_open (uint32_t index, k4a_device_t *device_handle)
 Open an Azure Kinect device. More...
 
void k4a_device_close (k4a_device_t device_handle)
 Closes an Azure Kinect device. More...
 
k4a_wait_result_t k4a_device_get_capture (k4a_device_t device_handle, k4a_capture_t *capture_handle, int32_t timeout_in_ms)
 Reads a sensor capture. More...
 
k4a_wait_result_t k4a_device_get_imu_sample (k4a_device_t device_handle, k4a_imu_sample_t *imu_sample, int32_t timeout_in_ms)
 Reads an IMU sample. More...
 
k4a_result_t k4a_device_start_cameras (k4a_device_t device_handle, const k4a_device_configuration_t *config)
 Starts color and depth camera capture. More...
 
void k4a_device_stop_cameras (k4a_device_t device_handle)
 Stops the color and depth camera capture. More...
 
k4a_result_t k4a_device_start_imu (k4a_device_t device_handle)
 Starts the IMU sample stream. More...
 
void k4a_device_stop_imu (k4a_device_t device_handle)
 Stops the IMU capture. More...
 
k4a_buffer_result_t k4a_device_get_serialnum (k4a_device_t device_handle, char *serial_number, size_t *serial_number_size)
 Get the Azure Kinect device serial number. More...
 
k4a_result_t k4a_device_get_version (k4a_device_t device_handle, k4a_hardware_version_t *version)
 Get the version numbers of the device's subsystems. More...
 
k4a_result_t k4a_device_get_color_control_capabilities (k4a_device_t device_handle, k4a_color_control_command_t command, bool *supports_auto, int32_t *min_value, int32_t *max_value, int32_t *step_value, int32_t *default_value, k4a_color_control_mode_t *default_mode)
 Get the Azure Kinect color sensor control capabilities. More...
 
k4a_result_t k4a_device_get_color_control (k4a_device_t device_handle, k4a_color_control_command_t command, k4a_color_control_mode_t *mode, int32_t *value)
 Get the Azure Kinect color sensor control value. More...
 
k4a_result_t k4a_device_set_color_control (k4a_device_t device_handle, k4a_color_control_command_t command, k4a_color_control_mode_t mode, int32_t value)
 Set the Azure Kinect color sensor control value. More...
 
k4a_buffer_result_t k4a_device_get_raw_calibration (k4a_device_t device_handle, uint8_t *data, size_t *data_size)
 Get the raw calibration blob for the entire Azure Kinect device. More...
 
k4a_result_t k4a_device_get_calibration (k4a_device_t device_handle, const k4a_depth_mode_t depth_mode, const k4a_color_resolution_t color_resolution, k4a_calibration_t *calibration)
 Get the camera calibration for the entire Azure Kinect device. More...
 
k4a_result_t k4a_device_get_sync_jack (k4a_device_t device_handle, bool *sync_in_jack_connected, bool *sync_out_jack_connected)
 Get the device jack status for the synchronization in and synchronization out connectors. More...
 
k4a_result_t k4a_calibration_get_from_raw (char *raw_calibration, size_t raw_calibration_size, const k4a_depth_mode_t depth_mode, const k4a_color_resolution_t color_resolution, k4a_calibration_t *calibration)
 Get the camera calibration for a device from a raw calibration blob. More...
 

Detailed Description

Handle to an Azure Kinect device.

Remarks
Handles are created with k4a_device_open() and closed with k4a_device_close(). Invalid handles are set to 0.

The documentation for this class was generated from the following files: