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

Enumeration types used by APIs. More...

Details

Enumeration types used by APIs.

Enumerations

enum  k4a_result_t { K4A_RESULT_SUCCEEDED = 0, K4A_RESULT_FAILED }
 Result code returned by Azure Kinect APIs. More...
 
enum  k4a_buffer_result_t { K4A_BUFFER_RESULT_SUCCEEDED = 0, K4A_BUFFER_RESULT_FAILED, K4A_BUFFER_RESULT_TOO_SMALL }
 Result code returned by Azure Kinect APIs. More...
 
enum  k4a_wait_result_t { K4A_WAIT_RESULT_SUCCEEDED = 0, K4A_WAIT_RESULT_FAILED, K4A_WAIT_RESULT_TIMEOUT }
 Result code returned by Azure Kinect APIs. More...
 
enum  k4a_log_level_t {
  K4A_LOG_LEVEL_CRITICAL = 0, K4A_LOG_LEVEL_ERROR, K4A_LOG_LEVEL_WARNING, K4A_LOG_LEVEL_INFO,
  K4A_LOG_LEVEL_TRACE, K4A_LOG_LEVEL_OFF
}
 Verbosity levels of debug messaging. More...
 
enum  k4a_depth_mode_t {
  K4A_DEPTH_MODE_OFF = 0, K4A_DEPTH_MODE_NFOV_2X2BINNED, K4A_DEPTH_MODE_NFOV_UNBINNED, K4A_DEPTH_MODE_WFOV_2X2BINNED,
  K4A_DEPTH_MODE_WFOV_UNBINNED, K4A_DEPTH_MODE_PASSIVE_IR
}
 Depth sensor capture modes. More...
 
enum  k4a_color_resolution_t {
  K4A_COLOR_RESOLUTION_OFF = 0, K4A_COLOR_RESOLUTION_720P, K4A_COLOR_RESOLUTION_1080P, K4A_COLOR_RESOLUTION_1440P,
  K4A_COLOR_RESOLUTION_1536P, K4A_COLOR_RESOLUTION_2160P, K4A_COLOR_RESOLUTION_3072P
}
 Color sensor resolutions. More...
 
enum  k4a_image_format_t {
  K4A_IMAGE_FORMAT_COLOR_MJPG = 0, K4A_IMAGE_FORMAT_COLOR_NV12, K4A_IMAGE_FORMAT_COLOR_YUY2, K4A_IMAGE_FORMAT_COLOR_BGRA32,
  K4A_IMAGE_FORMAT_DEPTH16, K4A_IMAGE_FORMAT_IR16, K4A_IMAGE_FORMAT_CUSTOM8, K4A_IMAGE_FORMAT_CUSTOM16,
  K4A_IMAGE_FORMAT_CUSTOM
}
 Image format type. More...
 
enum  k4a_transformation_interpolation_type_t { K4A_TRANSFORMATION_INTERPOLATION_TYPE_NEAREST = 0, K4A_TRANSFORMATION_INTERPOLATION_TYPE_LINEAR }
 Transformation interpolation type. More...
 
enum  k4a_fps_t { K4A_FRAMES_PER_SECOND_5 = 0, K4A_FRAMES_PER_SECOND_15, K4A_FRAMES_PER_SECOND_30 }
 Color and depth sensor frame rate. More...
 
enum  k4a_color_control_command_t {
  K4A_COLOR_CONTROL_EXPOSURE_TIME_ABSOLUTE = 0, K4A_COLOR_CONTROL_AUTO_EXPOSURE_PRIORITY, K4A_COLOR_CONTROL_BRIGHTNESS, K4A_COLOR_CONTROL_CONTRAST,
  K4A_COLOR_CONTROL_SATURATION, K4A_COLOR_CONTROL_SHARPNESS, K4A_COLOR_CONTROL_WHITEBALANCE, K4A_COLOR_CONTROL_BACKLIGHT_COMPENSATION,
  K4A_COLOR_CONTROL_GAIN, K4A_COLOR_CONTROL_POWERLINE_FREQUENCY
}
 Color sensor control commands. More...
 
enum  k4a_color_control_mode_t { K4A_COLOR_CONTROL_MODE_AUTO = 0, K4A_COLOR_CONTROL_MODE_MANUAL }
 Color sensor control mode. More...
 
enum  k4a_wired_sync_mode_t { K4A_WIRED_SYNC_MODE_STANDALONE, K4A_WIRED_SYNC_MODE_MASTER, K4A_WIRED_SYNC_MODE_SUBORDINATE }
 Synchronization mode when connecting two or more devices together. More...
 
enum  k4a_calibration_type_t {
  K4A_CALIBRATION_TYPE_UNKNOWN = -1, K4A_CALIBRATION_TYPE_DEPTH, K4A_CALIBRATION_TYPE_COLOR, K4A_CALIBRATION_TYPE_GYRO,
  K4A_CALIBRATION_TYPE_ACCEL, K4A_CALIBRATION_TYPE_NUM
}
 Calibration types. More...
 
enum  k4a_calibration_model_type_t {
  K4A_CALIBRATION_LENS_DISTORTION_MODEL_UNKNOWN = 0, K4A_CALIBRATION_LENS_DISTORTION_MODEL_THETA, K4A_CALIBRATION_LENS_DISTORTION_MODEL_POLYNOMIAL_3K, K4A_CALIBRATION_LENS_DISTORTION_MODEL_RATIONAL_6KT,
  K4A_CALIBRATION_LENS_DISTORTION_MODEL_BROWN_CONRADY
}
 Calibration model type. More...
 
enum  k4a_firmware_build_t { K4A_FIRMWARE_BUILD_RELEASE, K4A_FIRMWARE_BUILD_DEBUG }
 Firmware build type. More...
 
enum  k4a_firmware_signature_t { K4A_FIRMWARE_SIGNATURE_MSFT, K4A_FIRMWARE_SIGNATURE_TEST, K4A_FIRMWARE_SIGNATURE_UNSIGNED }
 Firmware signature type. More...
 
enum  k4a_stream_result_t { K4A_STREAM_RESULT_SUCCEEDED = 0, K4A_STREAM_RESULT_FAILED, K4A_STREAM_RESULT_EOF }
 Return codes returned by Azure Kinect playback API. More...
 
enum  k4a_playback_seek_origin_t { K4A_PLAYBACK_SEEK_BEGIN, K4A_PLAYBACK_SEEK_END, K4A_PLAYBACK_SEEK_DEVICE_TIME }
 Playback seeking positions. More...