ob2types.h 文件参考

#include <stdbool.h>
#include <stdint.h>

浏览源代码.

类
struct	ob2_status_t
	用户函数调用返回的状态结构体 更多...
struct	ob2_version_t
	版本号 更多...
struct	ob2_device_installation_info_t
	设备安装信息，可以用于打开设备 更多...
struct	ob2_device_info_t
	设备详细信息，需要先打开设备后获取 更多...
struct	ob2_3d_point_t
	三维点定义 更多...
struct	ob2_colored_3d_point_t
	带彩色信息的三维点定义 更多...
struct	ob2_camera_stream_profile_t
	相机流配置 更多...
struct	ob2_gyro_stream_profile_t
	陀螺仪流配置 更多...
struct	ob2_accel_stream_profile_t
	加速度计流配置 更多...
struct	ob2_accel_sample_t
	加速度计 / 陀螺仪采样数据定义 更多...
struct	ob2_command_info_t
	命令信息 更多...
struct	ob2_int_property_capability_t
	整型属性命令能力 更多...
struct	ob2_float_property_capability_t
	浮点型属性命令能力 更多...
struct	ob2_enum_property_capability_t
	枚举型属性命令能力 更多...
struct	ob2_data_bundle_t
	数据捆 更多...
struct	ob2_camera_intrinsic_t
	相机内参 更多...
struct	ob2_camera_distortion_t
	畸变参数 更多...
struct	ob2_d2c_transform_t
	旋转 / 变换矩阵 更多...
struct	ob2_cameras_calibration_t
	相机参数 更多...

宏定义
#define	OB2_DEFAULT_SDK_CONFIG_FILE_PATH   ("")
	默认 SDK 配置文件路径 更多...
#define	OB2_DEFAULT_DEVICE   (0)
	默认设备索引 更多...
#define	OB2_DEFAULT_STREAM_PROFILE   (0)
	默认流配置索引 更多...
#define	OB2_DEFAULT_CAMERAS_CONFIG   (nullptr)
	默认相机配置 更多...
#define	OB2_DEFAULT_IMU_CONFIG   (nullptr)
	默认 IMU 配置 更多...
#define	OB2_ANY_WIDTH   (0)
	用于模糊匹，标识可以任意宽度 更多...
#define	OB2_ANY_HEIGHT   (0)
	用于模糊匹，标识可以任意高度 更多...
#define	OB2_ANY_FRAME_RATE   (0)
	用于模糊匹，标识可以任意帧率 更多...
#define	OB2_ANY_IAMGE_FORMAT   (OB2_FORMAT_ANY)
	用于模糊匹，标识可以任意图像格式 更多...
#define	OB2_WAIT_INFINITE   (-1)
	用于等待，标识可以一直等待，不会超时 更多...
#define	OB2_FIRST_SAMPLE   (0)
	第一个采样数据索引 更多...

类型定义
typedef struct OB2ContextImpl *	ob2_context_t
	context 句柄定义 更多...
typedef struct OB2DeviceImpl *	ob2_device_t
	设备句柄定义 更多...
typedef struct OB2CamerasConfigImpl *	ob2_cameras_config_t
	相机配置句柄定义 更多...
typedef struct OB2CaptureImpl *	ob2_capture_t
	capture 句柄定义 更多...
typedef struct OB2ImageImpl *	ob2_image_t
	图像句柄定义 更多...
typedef struct OB2ImuConfigImpl *	ob2_imu_config_t
	IMU 配置句柄定义 更多...
typedef struct OB2ImuSampleImpl *	ob2_imu_sample_t
	IMU 采样数据句柄定义 更多...
typedef struct OB2TransformationImpl *	ob2_transformation_t
	图像转换器句柄定义 更多...
typedef struct OB2ImageFormatConverterImpl *	ob2_image_format_converter_t
	图像格式转换器句柄定义 更多...
typedef struct OB2RecordImpl *	ob2_record_t
	录制器句柄定义 更多...
typedef struct OB2PlaybackImpl *	ob2_playback_t
	回放器句柄定义 更多...
typedef struct OB2CompressionImpl *	ob2_compression_t
	图像数据压缩器句柄定义 更多...
typedef struct OB2DecompressionImpl *	ob2_decompression_t
	图像数据解压器句柄定义 更多...
typedef enum ob2_gyro_sample_rate_t	ob2_accel_sample_rate_t
typedef struct ob2_accel_sample_t	ob2_gyro_sample_t
typedef void(*	ob2_device_info_cb_t) (ob2_device_installation_info_t device_info, void *user_data)
	设备信息回调，用于设备安装 / 移除监控 更多...
typedef void(*	ob2_firmware_update_state_cb_t) (ob2_update_state_t state, const char *message, uint8_t percent, void *user_data)
	固件升级状态回调 更多...
typedef void(*	ob2_capture_cb_t) (ob2_capture_t capture_handle, void *user_data)
typedef void(*	ob2_buffer_release_cb_t) (uint8_t *buffer, void *user_data)
	buffer 释放回调，用于用户自定义 buffer 创建 image 释放时回收内存 更多...
typedef void(*	ob2_imu_sample_cb_t) (ob2_imu_sample_t imu_sample_handle, void *user_data)
	IMU 采样数据回调 更多...
typedef void(*	ob2_playback_state_cb_t) (ob2_playback_state_t state, void *user_data)
	回放状态回调 更多...

枚举
enum	ob2_status_code_t { OB2_STATUS_OK = 0 , OB2_STATUS_LOGIC_ERROR = 1 , OB2_STATUS_RUNTIME_ERROR = 2 , OB2_STATUS_UNKNOWN_ERROR = 255 }
	状态码 更多...
enum	ob2_log_severity_t {   OB2_LOG_SEVERITY_DEBUG = 0 , OB2_LOG_SEVERITY_INFO = 1 , OB2_LOG_SEVERITY_WARN = 2 , OB2_LOG_SEVERITY_ERROR = 3 ,   OB2_LOG_SEVERITY_FATAL = 4 , OB2_LOG_SEVERITY_NONE = 5 }
enum	ob2_logger_type_t { OB2_LOGGER_CONSOLE = 1 , OB2_LOGGER_FILE = 2 , OB2_LOGGER_ALL = 3 }
enum	ob2_3d_technology_type_t { OB2_3D_TECH_MONOCULAR_STRUCTURED_LIGHT = 0 , OB2_3D_TECH_BINOCULAR_STRUCTURED_LIGHT = 1 , OB2_3D_TECH_INDIRECT_TOF = 2 , OB2_3D_TECH_DIRECT_TOF = 3 }
	3D（Depth）成像技术类型 更多...
enum	ob2_camera_type_t { OB2_CAMERA_UNKNOWN = 0 , OB2_CAMERA_COLOR = 1 , OB2_CAMERA_DEPTH = 2 , OB2_CAMERA_IR = 3 }
	相机类型 更多...
enum	ob2_image_format_t {   OB2_FORMAT_YUYV = 0 , OB2_FORMAT_YUY2 = 1 , OB2_FORMAT_UYVY = 2 , OB2_FORMAT_NV12 = 3 ,   OB2_FORMAT_NV21 = 4 , OB2_FORMAT_MJPG = 5 , OB2_FORMAT_H264 = 6 , OB2_FORMAT_H265 = 7 ,   OB2_FORMAT_Y16 = 8 , OB2_FORMAT_Y8 = 9 , OB2_FORMAT_Y10 = 10 , OB2_FORMAT_Y11 = 11 ,   OB2_FORMAT_Y12 = 12 , OB2_FORMAT_GRAY = 13 , OB2_FORMAT_HEVC = 14 , OB2_FORMAT_I420 = 15 ,   OB2_FORMAT_POINT = 19 , OB2_FORMAT_COLORED_POINT = 20 , OB2_FORMAT_RLE = 21 , OB2_FORMAT_RGB = 22 ,   OB2_FORMAT_BGR = 23 , OB2_FORMAT_Y14 = 24 , OB2_FORMAT_BGRA = 25 , OB2_FORMAT_COMPRESSED = 26 ,   OB2_FORMAT_ANY = 0xfe , OB2_FORMAT_UNKNOWN = 0xff }
	图像数据格式 更多...
enum	ob2_point_cloud_type_t { OB2_POINT_CLOUD = 0 , OB2_COLORED_POINT_CLOUD = 1 }
	点云类型 更多...
enum	ob2_enable_ctrl_t { OB2_DISABLE = 0 , OB2_ENABLE = 1 }
	使能 / 去使能定义 更多...
enum	ob2_images_sync_mode_t { OB2_IMAGES_SYNC_MODE_WAIT_LATER_COMER = 0 , OB2_IMAGES_SYNC_MODE_DEVICE_TIMESTAMP_MATCH = 1 }
	图像同步模式，用于控制生成 capture 时如何同步不同相机的图像 更多...
enum	ob2_produce_capture_policy_t { OB2_PRODUCE_CAPTURE_SYNC_IMAGES_ONLY = 0 , OB2_PRODUCE_CAPTURE_KEEP_COLOR_IMAGE = 1 , OB2_PRODUCE_CAPTURE_KEEP_ALL_IMAGES = 2 }
enum	ob2_images_align_mode_t { OB2_IMAGES_ALIGN_MODE_DISABLE = 0 , OB2_IMAGES_ALIGN_MODE_D2C_HARDWARE = 1 , OB2_IMAGES_ALIGN_MODE_D2C_SOFTWARE = 2 }
	图像对齐模式 更多...
enum	ob2_imu_sensor_type_t { OB2_IMU_SENSOR_UNKNOWN = 0 , OB2_IMU_SENSOR_ACCEL = 1 , OB2_IMU_SENSOR_GYRO = 2 }
	IMU Sensor 类型定义 更多...
enum	ob2_gyro_sample_rate_t {   OB2_SAMPLE_RATE_1_5625_HZ = 1 , OB2_SAMPLE_RATE_3_125_HZ = 2 , OB2_SAMPLE_RATE_6_25_HZ = 3 , OB2_SAMPLE_RATE_12_5_HZ = 4 ,   OB2_SAMPLE_RATE_25_HZ = 5 , OB2_SAMPLE_RATE_50_HZ = 6 , OB2_SAMPLE_RATE_100_HZ = 7 , OB2_SAMPLE_RATE_200_HZ = 8 ,   OB2_SAMPLE_RATE_500_HZ = 9 , OB2_SAMPLE_RATE_1_KHZ = 10 , OB2_SAMPLE_RATE_2_KHZ = 11 , OB2_SAMPLE_RATE_4_KHZ = 12 ,   OB2_SAMPLE_RATE_8_KHZ = 13 , OB2_SAMPLE_RATE_16_KHZ = 14 , OB2_SAMPLE_RATE_32_KHZ = 15 }
	IMU 采样率值的枚举 (陀螺仪或加速度计) 更多...
enum	ob2_gyro_full_scale_range_t {   OB2_GYRO_FS_16_DPS = 1 , OB2_GYRO_FS_31_DPS = 2 , OB2_GYRO_FS_62_DPS = 3 , OB2_GYRO_FS_125_DPS = 4 ,   OB2_GYRO_FS_245_DPS = 5 , OB2_GYRO_FS_250_DPS = 6 , OB2_GYRO_FS_500_DPS = 7 , OB2_GYRO_FS_1000_DPS = 8 ,   OB2_GYRO_FS_2000_DPS = 9 }
	陀螺仪量程的枚举 更多...
enum	ob2_accel_full_scale_range_t { OB2_ACCEL_FS_2_G = 1 , OB2_ACCEL_FS_4_G = 2 , OB2_ACCEL_FS_8_G = 3 , OB2_ACCEL_FS_16_G = 4 }
	加速度计量程枚举 更多...
enum	ob2_command_id_t {   OB2_PROP_LDP_BOOL = 2 , OB2_PROP_LASER_BOOL = 3 , OB2_PROP_LASER_PULSE_WIDTH_INT = 4 , OB2_PROP_LASER_CURRENT_FLOAT = 5 ,   OB2_PROP_FLOOD_BOOL = 6 , OB2_PROP_FLOOD_LEVEL_INT = 7 , OB2_PROP_DEPTH_MIRROR_BOOL = 14 , OB2_PROP_DEPTH_FLIP_BOOL = 15 ,   OB2_PROP_DEPTH_POSTFILTER_BOOL = 16 , OB2_PROP_DEPTH_HOLEFILTER_BOOL = 17 , OB2_PROP_IR_MIRROR_BOOL = 18 , OB2_PROP_IR_FLIP_BOOL = 19 ,   OB2_PROP_MIN_DEPTH_INT = 22 , OB2_PROP_MAX_DEPTH_INT = 23 , OB2_PROP_DEPTH_SOFT_FILTER_BOOL = 24 , OB2_PROP_LDP_STATUS_BOOL = 32 ,   OB2_PROP_DEPTH_MAX_DIFF_INT = 40 , OB2_PROP_DEPTH_MAX_SPECKLE_SIZE_INT = 41 , OB2_PROP_DEPTH_ALIGN_HARDWARE_BOOL = 42 , OB2_PROP_TIMESTAMP_OFFSET_INT = 43 ,   OB2_PROP_HARDWARE_DISTORTION_SWITCH_BOOL = 61 , OB2_PROP_FAN_WORK_MODE_INT = 62 , OB2_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT = 63 , OB2_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL = 64 ,   OB2_PROP_DEPTH_PRECISION_LEVEL_INT = 75 , OB2_PROP_TOF_FILTER_RANGE_INT = 76 , OB2_PROP_LASER_MODE_INT = 79 , OB2_PROP_RECTIFY2_BOOL = 80 ,   OB2_PROP_COLOR_MIRROR_BOOL = 81 , OB2_PROP_COLOR_FLIP_BOOL = 82 , OB2_PROP_INDICATOR_LIGHT_BOOL = 83 , OB2_PROP_DISPARITY_TO_DEPTH_BOOL = 85 ,   OB2_PROP_BRT_BOOL = 86 , OB2_PROP_WATCHDOG_BOOL = 87 , OB2_PROP_EXTERNAL_SIGNAL_RESET_BOOL = 88 , OB2_PROP_HEARTBEAT_BOOL = 89 ,   OB2_PROP_DEPTH_CROPPING_MODE_INT = 90 , OB2_PROP_D2C_PREPROCESS_BOOL = 91 , OB2_PROP_RGB_CUSTOM_CROP_BOOL = 94 , OB2_PROP_DEVICE_WORK_MODE_INT = 95 ,   OB2_PROP_DEVICE_COMMUNICATION_TYPE_INT = 97 , OB2_PROP_SWITCH_IR_MODE_INT = 98 , OB2_STRUCT_BASELINE_CALIBRATION_PARAM = 1002 , OB2_STRUCT_DEVICE_TEMPERATURE = 1003 ,   OB2_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL = 1024 , OB2_STRUCT_DEVICE_SERIAL_NUMBER = 1035 , OB2_STRUCT_DEVICE_TIME = 1037 , OB2_STRUCT_MULTI_DEVICE_SYNC_CONFIG = 1038 ,   OB2_STRUCT_RGB_CROP_ROI = 1040 , OB2_STRUCT_DEVICE_IP_ADDR_CONFIG = 1041 , OB2_PROP_COLOR_AUTO_EXPOSURE_BOOL = 2000 , OB2_PROP_COLOR_EXPOSURE_INT = 2001 ,   OB2_PROP_COLOR_GAIN_INT = 2002 , OB2_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL = 2003 , OB2_PROP_COLOR_WHITE_BALANCE_INT = 2004 , OB2_PROP_COLOR_BRIGHTNESS_INT = 2005 ,   OB2_PROP_COLOR_SHARPNESS_INT = 2006 , OB2_PROP_COLOR_SATURATION_INT = 2008 , OB2_PROP_COLOR_CONTRAST_INT = 2009 , OB2_PROP_COLOR_GAMMA_INT = 2010 ,   OB2_PROP_COLOR_ROLL_INT = 2011 , OB2_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT = 2012 , OB2_PROP_COLOR_BACKLIGHT_COMPENSATION_INT = 2013 , OB2_PROP_COLOR_HUE_INT = 2014 ,   OB2_PROP_COLOR_POWER_LINE_FREQUENCY_INT = 2015 , OB2_PROP_DEPTH_AUTO_EXPOSURE_BOOL = 2016 , OB2_PROP_DEPTH_EXPOSURE_INT = 2017 , OB2_PROP_DEPTH_GAIN_INT = 2018 ,   OB2_PROP_IR_AUTO_EXPOSURE_BOOL = 2025 , OB2_PROP_IR_EXPOSURE_INT = 2026 , OB2_PROP_IR_GAIN_INT = 2027 , OB2_PROP_IR_SWITCH_INT = 2028 ,   OB2_PROP_SDK_DISPARITY_TO_DEPTH_BOOL = 3004 , OB2_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL = 3007 , OB2_PROP_SDK_IR_FRAME_UNPACK_BOOL = 3008 , OB2_RAW_DATA_CAMERA_CALIB_JSON_FILE = 4029 ,   OB2_RAW_DATA_D2C_ROT_LUT_FILE = 4030 , OB2_STRUCT_DEBUG_SENSOR_EXPOSURE_TIME = 5504 }
	控制命令 ID 更多...
enum	ob2_command_type_t {   OB2_UNKNOWN_COMMAND_TYPE = 0 , OB2_BOOL_PROPERTY = 1 , OB2_INT_PROPERTY = 2 , OB2_FLOAT_PROPERTY = 3 ,   OB2_ENUM_PROPERTY = 4 , OB2_STRUCTURED_DATA = 5 , OB2_RAW_DATA = 6 }
	控制命令类型 更多...
enum	ob2_access_permission_t { OB2_PERMISSION_DENY = 0 , OB2_PERMISSION_READ = 1 , OB2_PERMISSION_WRITE = 2 , OB2_PERMISSION_READ_WRITE = 3 }
	访问权限（主要用户命令） 更多...
enum	ob2_update_state_t {   OB2_STAT_FILE_TRANSFER = 4 , OB2_STAT_DONE = 3 , OB2_STAT_IN_PROGRESS = 2 , OB2_STAT_START = 1 ,   OB2_STAT_VERIFY_IMAGE = 0 , OB2_ERR_VERIFY = -1 , OB2_ERR_PROGRAM = -2 , OB2_ERR_ERASE = -3 ,   OB2_ERR_FLASH_TYPE = -4 , OB2_ERR_IMAGE_SIZE = -5 , OB2_ERR_OTHER = -6 , OB2_ERR_DDR = -7 ,   OB2_ERR_TIMEOUT = -8 }
	设备固件升级状态 更多...
enum	ob2_playback_state_t { OB2_PLAYBACK_BEGIN = 0 , OB2_PLAYBACK_PAUSE = 1 , OB2_PLAYBACK_RESUME = 2 , OB2_PLAYBACK_END = 3 }
	回放状态 更多...
enum	ob2_cameras_sync_mode_t { OB2_CAMERA_SYNC_MODE_CLOSE = 0 , OB2_CAMERA_SYNC_MODE_COLOR_EXPOSURE_FIRST = 1 , OB2_CAMERA_SYNC_MODE_DEPTH_EXPOSURE_FIRST = 2 }
	相机同步模式 更多...
enum	ob2_wired_sync_mode_t { OB2_WIRED_SYNC_MODE_STANDALONE = 0 , OB2_WIRED_SYNC_MODE_PRIMARY = 1 , OB2_WIRED_SYNC_MODE_SECONDARY = 2 }
	多机线连接同步模式 更多...

宏定义说明

OB2_DEFAULT_SDK_CONFIG_FILE_PATH

#define OB2_DEFAULT_SDK_CONFIG_FILE_PATH   ("")

默认 SDK 配置文件路径

在文件 ob2types.h 第 174 行定义.

OB2_DEFAULT_DEVICE

#define OB2_DEFAULT_DEVICE   (0)

默认设备索引

在文件 ob2types.h 第 183 行定义.

OB2_DEFAULT_STREAM_PROFILE

#define OB2_DEFAULT_STREAM_PROFILE   (0)

默认流配置索引

在文件 ob2types.h 第 192 行定义.

OB2_DEFAULT_CAMERAS_CONFIG

#define OB2_DEFAULT_CAMERAS_CONFIG   (nullptr)

默认相机配置

在文件 ob2types.h 第 201 行定义.

OB2_DEFAULT_IMU_CONFIG

#define OB2_DEFAULT_IMU_CONFIG   (nullptr)

默认 IMU 配置

在文件 ob2types.h 第 210 行定义.

OB2_ANY_WIDTH

#define OB2_ANY_WIDTH   (0)

用于模糊匹，标识可以任意宽度

在文件 ob2types.h 第 219 行定义.

OB2_ANY_HEIGHT

#define OB2_ANY_HEIGHT   (0)

用于模糊匹，标识可以任意高度

在文件 ob2types.h 第 228 行定义.

OB2_ANY_FRAME_RATE

#define OB2_ANY_FRAME_RATE   (0)

用于模糊匹，标识可以任意帧率

在文件 ob2types.h 第 237 行定义.

OB2_ANY_IAMGE_FORMAT

#define OB2_ANY_IAMGE_FORMAT   (OB2_FORMAT_ANY)

用于模糊匹，标识可以任意图像格式

在文件 ob2types.h 第 246 行定义.

OB2_WAIT_INFINITE

#define OB2_WAIT_INFINITE   (-1)

用于等待，标识可以一直等待，不会超时

在文件 ob2types.h 第 255 行定义.

OB2_FIRST_SAMPLE

#define OB2_FIRST_SAMPLE   (0)

第一个采样数据索引

First sample data index

在文件 ob2types.h 第 264 行定义.

类型定义说明

ob2_context_t

typedef struct OB2ContextImpl* ob2_context_t

context 句柄定义

在文件 ob2types.h 第 19 行定义.

ob2_device_t

typedef struct OB2DeviceImpl* ob2_device_t

设备句柄定义

在文件 ob2types.h 第 31 行定义.

ob2_cameras_config_t

typedef struct OB2CamerasConfigImpl* ob2_cameras_config_t

相机配置句柄定义

在文件 ob2types.h 第 43 行定义.

ob2_capture_t

typedef struct OB2CaptureImpl* ob2_capture_t

capture 句柄定义

在文件 ob2types.h 第 55 行定义.

ob2_image_t

typedef struct OB2ImageImpl* ob2_image_t

图像句柄定义

在文件 ob2types.h 第 67 行定义.

ob2_imu_config_t

typedef struct OB2ImuConfigImpl* ob2_imu_config_t

IMU 配置句柄定义

在文件 ob2types.h 第 79 行定义.

ob2_imu_sample_t

typedef struct OB2ImuSampleImpl* ob2_imu_sample_t

IMU 采样数据句柄定义

在文件 ob2types.h 第 91 行定义.

ob2_transformation_t

typedef struct OB2TransformationImpl* ob2_transformation_t

图像转换器句柄定义

在文件 ob2types.h 第 103 行定义.

ob2_image_format_converter_t

typedef struct OB2ImageFormatConverterImpl* ob2_image_format_converter_t

图像格式转换器句柄定义

在文件 ob2types.h 第 115 行定义.

ob2_record_t

typedef struct OB2RecordImpl* ob2_record_t

录制器句柄定义

在文件 ob2types.h 第 127 行定义.

ob2_playback_t

typedef struct OB2PlaybackImpl* ob2_playback_t

回放器句柄定义

在文件 ob2types.h 第 139 行定义.

ob2_compression_t

typedef struct OB2CompressionImpl* ob2_compression_t

图像数据压缩器句柄定义

在文件 ob2types.h 第 151 行定义.

ob2_decompression_t

typedef struct OB2DecompressionImpl* ob2_decompression_t

图像数据解压器句柄定义

在文件 ob2types.h 第 163 行定义.

ob2_accel_sample_rate_t

typedef enum ob2_gyro_sample_rate_t ob2_accel_sample_rate_t

ob2_gyro_sample_t

typedef struct ob2_accel_sample_t ob2_gyro_sample_t

ob2_device_info_cb_t

typedef void(* ob2_device_info_cb_t) (ob2_device_installation_info_t device_info, void *user_data)

设备信息回调，用于设备安装 / 移除监控

在文件 ob2types.h 第 1512 行定义.

ob2_firmware_update_state_cb_t

typedef void(* ob2_firmware_update_state_cb_t) (ob2_update_state_t state, const char *message, uint8_t percent, void *user_data)

固件升级状态回调

在文件 ob2types.h 第 1521 行定义.

ob2_capture_cb_t

typedef void(* ob2_capture_cb_t) (ob2_capture_t capture_handle, void *user_data)

注意

回调返回的 capture 需要主动调用 ob2_capture_release 释放，否则会导致内存泄漏

在文件 ob2types.h 第 1531 行定义.

ob2_buffer_release_cb_t

typedef void(* ob2_buffer_release_cb_t) (uint8_t *buffer, void *user_data)

buffer 释放回调，用于用户自定义 buffer 创建 image 释放时回收内存

在文件 ob2types.h 第 1540 行定义.

ob2_imu_sample_cb_t

typedef void(* ob2_imu_sample_cb_t) (ob2_imu_sample_t imu_sample_handle, void *user_data)

IMU 采样数据回调

在文件 ob2types.h 第 1552 行定义.

ob2_playback_state_cb_t

typedef void(* ob2_playback_state_cb_t) (ob2_playback_state_t state, void *user_data)

回放状态回调

在文件 ob2types.h 第 1561 行定义.

枚举类型说明

ob2_status_code_t

enum ob2_status_code_t

状态码

枚举值
OB2_STATUS_OK	正常
OB2_STATUS_LOGIC_ERROR	逻辑错误（通常是由于错误的代码调用引起，用户代码需要做修复或规避）：非法的参数、参数超范围、长度错误、域错误等
OB2_STATUS_RUNTIME_ERROR	运行时错误（通常是由于设备异常或当前设备和环境不支持引起，用户代码需做好提示输出）：文件不存在、无访问权限、设备不支持、设备无相应、设备异常相应等
OB2_STATUS_UNKNOWN_ERROR	其他未知情况导致的程序运行异常

在文件 ob2types.h 第 273 行定义.

ob2_log_severity_t

enum ob2_log_severity_t

枚举值
OB2_LOG_SEVERITY_DEBUG	调试
OB2_LOG_SEVERITY_INFO	信息
OB2_LOG_SEVERITY_WARN	警告
OB2_LOG_SEVERITY_ERROR	错误
OB2_LOG_SEVERITY_FATAL	致命错误
OB2_LOG_SEVERITY_NONE	无 (关闭 LOG)

在文件 ob2types.h 第 365 行定义.

ob2_logger_type_t

enum ob2_logger_type_t

枚举值
OB2_LOGGER_CONSOLE	logger for logging to console
OB2_LOGGER_FILE	logger for logging to file
OB2_LOGGER_ALL	bitmap for both logging to console and file

在文件 ob2types.h 第 385 行定义.

ob2_3d_technology_type_t

enum ob2_3d_technology_type_t

3D（Depth）成像技术类型

枚举值
OB2_3D_TECH_MONOCULAR_STRUCTURED_LIGHT	单目结构光
OB2_3D_TECH_BINOCULAR_STRUCTURED_LIGHT	双目结构体
OB2_3D_TECH_INDIRECT_TOF	iTOF
OB2_3D_TECH_DIRECT_TOF	dTOF

在文件 ob2types.h 第 422 行定义.

ob2_camera_type_t

enum ob2_camera_type_t

相机类型

枚举值
OB2_CAMERA_UNKNOWN	未知相机
OB2_CAMERA_COLOR	彩色相机
OB2_CAMERA_DEPTH	深度相机
OB2_CAMERA_IR	红外相机

在文件 ob2types.h 第 472 行定义.

ob2_image_format_t

enum ob2_image_format_t

图像数据格式

枚举值
OB2_FORMAT_YUYV	YUYV 格式
OB2_FORMAT_YUY2	YUY2 格式 (实际格式与 YUYV 相同)
OB2_FORMAT_UYVY	UYVY 格式
OB2_FORMAT_NV12	NV12 格式
OB2_FORMAT_NV21	NV21 格式
OB2_FORMAT_MJPG	MJPG 编码格式
OB2_FORMAT_H264	H.264 编码格式
OB2_FORMAT_H265	H.265 编码格式
OB2_FORMAT_Y16	Y16 格式，单通道 16bit 深度
OB2_FORMAT_Y8	Y8 格式，单通道 8bit 深度
OB2_FORMAT_Y10	Y10 格式，单通道 10bit 深度 (SDK 默认会解包成 Y16)
OB2_FORMAT_Y11	Y11 格式，单通道 11bit 深度 (SDK 默认会解包成 Y16)
OB2_FORMAT_Y12	Y12 格式，单通道 12bit 深度 (SDK 默认会解包成 Y16)
OB2_FORMAT_GRAY	GRAY 灰度 (实际格式与 YUYV 相同)
OB2_FORMAT_HEVC	HEVC 编码格式 (实际格式与 H265 相同)
OB2_FORMAT_I420	I420 格式
OB2_FORMAT_POINT	纯 x-y-z 三维坐标点格式
OB2_FORMAT_COLORED_POINT	带 RGB 信息的 x-y-z 三维坐标点格式
OB2_FORMAT_RLE	RLE 压测格式 (SDK 默认会解包成 Y16)
OB2_FORMAT_RGB	RGB 格式
OB2_FORMAT_BGR	BGR 格式 (实际 BRG888)
OB2_FORMAT_Y14	Y14 格式，单通道 14bit 深度 (SDK 默认会解包成 Y16)
OB2_FORMAT_BGRA	BGRA 格式
OB2_FORMAT_COMPRESSED	压缩格式
OB2_FORMAT_ANY	任意格式，用于模糊匹配
OB2_FORMAT_UNKNOWN	未知格式

在文件 ob2types.h 第 486 行定义.

ob2_point_cloud_type_t

enum ob2_point_cloud_type_t

点云类型

枚举值
OB2_POINT_CLOUD	point cloud image format： OB2_FORMAT_POINT
OB2_COLORED_POINT_CLOUD	colored point cloud image format： OB2_FORMAT_COLORED_POINT

在文件 ob2types.h 第 577 行定义.

ob2_enable_ctrl_t

enum ob2_enable_ctrl_t

使能 / 去使能定义

枚举值
OB2_DISABLE	去使能（关闭、禁用）
OB2_ENABLE	使能

在文件 ob2types.h 第 639 行定义.

ob2_images_sync_mode_t

enum ob2_images_sync_mode_t

图像同步模式，用于控制生成 capture 时如何同步不同相机的图像

枚举值
OB2_IMAGES_SYNC_MODE_WAIT_LATER_COMER	先接收到图像的相机等待后接收到的图像的相机
OB2_IMAGES_SYNC_MODE_DEVICE_TIMESTAMP_MATCH	通过时间戳进行匹配，该模式可消除由于帧率不一致、各相机图像处理和传输延时不一致导致的不同步问题

在文件 ob2types.h 第 653 行定义.

ob2_produce_capture_policy_t

enum ob2_produce_capture_policy_t

枚举值
OB2_PRODUCE_CAPTURE_SYNC_IMAGES_ONLY	仅所有相机图像同步后生成 capture，在已经无法同步所有已启用相机图像帧的情况下会丢弃当前缓存的图像
OB2_PRODUCE_CAPTURE_KEEP_COLOR_IMAGE	保证彩色图像不会被丢弃，在已经无法同步所有已启用相机图像帧的情况下，会保证彩色图像用于生成 capture，而其他相机图像可能会丢弃 适用于彩色图像是 H264 或 H265 格式的情况，因为 H264 和 H265 是帧间编码格式，图像帧不能被丢弃，否则会影响解码结果。
OB2_PRODUCE_CAPTURE_KEEP_ALL_IMAGES	保证所有图像都不会被丢弃，在已经无法同步所有已启用相机图像帧的情况下，会仅用部分相机的图像帧生成 capture

在文件 ob2types.h 第 679 行定义.

ob2_images_align_mode_t

enum ob2_images_align_mode_t

图像对齐模式

枚举值
OB2_IMAGES_ALIGN_MODE_DISABLE	关闭对齐模式
OB2_IMAGES_ALIGN_MODE_D2C_HARDWARE	硬件 D2C 对齐, color 相机可以不启用，但是需要配置数据流格式
OB2_IMAGES_ALIGN_MODE_D2C_SOFTWARE	软件 D2C 对齐, color 相机必须启用，且需要配置数据流格式

在文件 ob2types.h 第 722 行定义.

ob2_imu_sensor_type_t

enum ob2_imu_sensor_type_t

IMU Sensor 类型定义

枚举值
OB2_IMU_SENSOR_UNKNOWN	未知类型传感器
OB2_IMU_SENSOR_ACCEL	加速度计
OB2_IMU_SENSOR_GYRO	陀螺仪

在文件 ob2types.h 第 752 行定义.

ob2_gyro_sample_rate_t

enum ob2_gyro_sample_rate_t

IMU 采样率值的枚举 (陀螺仪或加速度计)

枚举值
OB2_SAMPLE_RATE_1_5625_HZ	1.5625Hz
OB2_SAMPLE_RATE_3_125_HZ	3.125Hz
OB2_SAMPLE_RATE_6_25_HZ	6.25Hz
OB2_SAMPLE_RATE_12_5_HZ	12.5Hz
OB2_SAMPLE_RATE_25_HZ	25Hz
OB2_SAMPLE_RATE_50_HZ	50Hz
OB2_SAMPLE_RATE_100_HZ	100Hz
OB2_SAMPLE_RATE_200_HZ	200Hz
OB2_SAMPLE_RATE_500_HZ	500Hz
OB2_SAMPLE_RATE_1_KHZ	1KHz
OB2_SAMPLE_RATE_2_KHZ	2KHz
OB2_SAMPLE_RATE_4_KHZ	4KHz
OB2_SAMPLE_RATE_8_KHZ	8KHz
OB2_SAMPLE_RATE_16_KHZ	16KHz
OB2_SAMPLE_RATE_32_KHZ	32Hz

在文件 ob2types.h 第 770 行定义.

ob2_gyro_full_scale_range_t

enum ob2_gyro_full_scale_range_t

陀螺仪量程的枚举

枚举值
OB2_GYRO_FS_16_DPS	16 度每秒
OB2_GYRO_FS_31_DPS	31 度每秒
OB2_GYRO_FS_62_DPS	62 度每秒
OB2_GYRO_FS_125_DPS	125 度每秒
OB2_GYRO_FS_245_DPS	245 度每秒
OB2_GYRO_FS_250_DPS	250 度每秒
OB2_GYRO_FS_500_DPS	500 度每秒
OB2_GYRO_FS_1000_DPS	1000 度每秒
OB2_GYRO_FS_2000_DPS	2000 度每秒

在文件 ob2types.h 第 796 行定义.

ob2_accel_full_scale_range_t

enum ob2_accel_full_scale_range_t

加速度计量程枚举

枚举值
OB2_ACCEL_FS_2_G	1 倍重力加速度
OB2_ACCEL_FS_4_G	4 倍重力加速度
OB2_ACCEL_FS_8_G	8 倍重力加速度
OB2_ACCEL_FS_16_G	16 倍重力加速度

在文件 ob2types.h 第 832 行定义.

ob2_command_id_t

enum ob2_command_id_t

控制命令 ID

枚举值
OB2_PROP_LDP_BOOL	LDP 开关
OB2_PROP_LASER_BOOL	激光开关
OB2_PROP_LASER_PULSE_WIDTH_INT	读写激光 Time 值（脉宽）
OB2_PROP_LASER_CURRENT_FLOAT	激光电流
OB2_PROP_FLOOD_BOOL	泛光灯开关
OB2_PROP_FLOOD_LEVEL_INT	泛光灯等级
OB2_PROP_DEPTH_MIRROR_BOOL	深度镜像
OB2_PROP_DEPTH_FLIP_BOOL	深度翻转
OB2_PROP_DEPTH_POSTFILTER_BOOL	深度 Postfilter
OB2_PROP_DEPTH_HOLEFILTER_BOOL	深度 Holefilter
OB2_PROP_IR_MIRROR_BOOL	IR 镜像
OB2_PROP_IR_FLIP_BOOL	IR 翻转
OB2_PROP_MIN_DEPTH_INT	最小深度阈值
OB2_PROP_MAX_DEPTH_INT	最大深度阈值
OB2_PROP_DEPTH_SOFT_FILTER_BOOL	软件滤波开关
OB2_PROP_LDP_STATUS_BOOL	LDP 状态
OB2_PROP_DEPTH_MAX_DIFF_INT	soft filter maxdiff param
OB2_PROP_DEPTH_MAX_SPECKLE_SIZE_INT	soft filter maxSpeckleSize
OB2_PROP_DEPTH_ALIGN_HARDWARE_BOOL	硬件 d2c 开
OB2_PROP_TIMESTAMP_OFFSET_INT	时间戳调校
OB2_PROP_HARDWARE_DISTORTION_SWITCH_BOOL	硬件去畸变开关 Rectify
OB2_PROP_FAN_WORK_MODE_INT	风扇开关模式
OB2_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT	多分辨率 D2C 模式
OB2_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL	防串货状态
OB2_PROP_DEPTH_PRECISION_LEVEL_INT	深度精度等级，可能会改变深度帧数据单位，需要通过 DepthFrame 的 ValueScale 接口确认
OB2_PROP_TOF_FILTER_RANGE_INT	tof 滤波场景范围配置
OB2_PROP_LASER_MODE_INT	激光点亮模式，固件端目前只返回 1: IR Drive, 2: Torch
OB2_PROP_RECTIFY2_BOOL	brt2r-rectify 功能开关 (brt2r 是 mx6600 上的一个特殊模块)，0: 关闭, 1: 打开
OB2_PROP_COLOR_MIRROR_BOOL	彩色镜像
OB2_PROP_COLOR_FLIP_BOOL	彩色翻转
OB2_PROP_INDICATOR_LIGHT_BOOL	指示灯开关，0: 关闭， 1: 打开
OB2_PROP_DISPARITY_TO_DEPTH_BOOL	视差转深度开关， 0：关闭，深度流输出视差图； 1. 打开，深度流输出深度图
OB2_PROP_BRT_BOOL	BRT 功能开关 (抗背景干扰)，0: 关闭， 1: 打开
OB2_PROP_WATCHDOG_BOOL	看门狗功能开关，0: 关闭， 1: 打开
OB2_PROP_EXTERNAL_SIGNAL_RESET_BOOL	外部信号触发重启功能开关，0: 关闭， 1: 打开
OB2_PROP_HEARTBEAT_BOOL	心跳监测功能开关，0: 关闭， 1: 打开
OB2_PROP_DEPTH_CROPPING_MODE_INT	深度裁剪模式
OB2_PROP_D2C_PREPROCESS_BOOL	D2C 前处理开关（如 RGB 裁剪），0: 关闭，1: 打开
OB2_PROP_RGB_CUSTOM_CROP_BOOL	自定义 RGB 裁剪开关，0 为关闭，1 为开启自定义裁剪，下发 ROI 裁剪区域
OB2_PROP_DEVICE_WORK_MODE_INT	设备工作模式（功耗）
OB2_PROP_DEVICE_COMMUNICATION_TYPE_INT	设备通信方式 0: USB; 1: Ethernet(RTSP)
OB2_PROP_SWITCH_IR_MODE_INT	切换 IR 模式，0 为主动 IR 模式, 1 为被动 IR 模式
OB2_STRUCT_BASELINE_CALIBRATION_PARAM	基线标定参数
OB2_STRUCT_DEVICE_TEMPERATURE	设备温度信息
OB2_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL	TOF 曝光阈值范围
OB2_STRUCT_DEVICE_SERIAL_NUMBER	获取 / 设置序列号
OB2_STRUCT_DEVICE_TIME	获取 / 设置设备时间
OB2_STRUCT_MULTI_DEVICE_SYNC_CONFIG	多设备同步模式和参数配置
OB2_STRUCT_RGB_CROP_ROI	RGB 裁剪 ROI
OB2_STRUCT_DEVICE_IP_ADDR_CONFIG	设备 ip 地址配置
OB2_PROP_COLOR_AUTO_EXPOSURE_BOOL	彩色相机自动曝光
OB2_PROP_COLOR_EXPOSURE_INT	彩色相机曝光调节
OB2_PROP_COLOR_GAIN_INT	彩色相机增益调节
OB2_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL	彩色相机自动白平衡
OB2_PROP_COLOR_WHITE_BALANCE_INT	彩色相机白平衡调节
OB2_PROP_COLOR_BRIGHTNESS_INT	彩色相机亮度调节
OB2_PROP_COLOR_SHARPNESS_INT	彩色相机锐度调节
OB2_PROP_COLOR_SATURATION_INT	彩色相机饱和度调节
OB2_PROP_COLOR_CONTRAST_INT	彩色相机对比度调节
OB2_PROP_COLOR_GAMMA_INT	彩色相机伽马值调节
OB2_PROP_COLOR_ROLL_INT	彩色相机图像旋转
OB2_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT	彩色相机自动曝光优先
OB2_PROP_COLOR_BACKLIGHT_COMPENSATION_INT	彩色相机亮度补偿
OB2_PROP_COLOR_HUE_INT	彩色相机彩色色调
OB2_PROP_COLOR_POWER_LINE_FREQUENCY_INT	彩色相机电力线路频率
OB2_PROP_DEPTH_AUTO_EXPOSURE_BOOL	深度相机自动曝光（某些型号设备下会同步设置红外相机）
OB2_PROP_DEPTH_EXPOSURE_INT	深度相机曝光调节（某些型号设备下会同步设置红外相机）
OB2_PROP_DEPTH_GAIN_INT	深度相机增益调节（某些型号设备下会同步设置红外相机）
OB2_PROP_IR_AUTO_EXPOSURE_BOOL	红外相机自动曝光（某些型号设备下会同步设置深度相机）
OB2_PROP_IR_EXPOSURE_INT	红外相机曝光调节（某些型号设备下会同步设置深度相机）
OB2_PROP_IR_GAIN_INT	红外相机增益调节（某些型号设备下会同步设置深度相机）
OB2_PROP_IR_SWITCH_INT	双目红外相机左右 IR 切换
OB2_PROP_SDK_DISPARITY_TO_DEPTH_BOOL	视差转深度
OB2_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL	Depth 数据解包功能开关 (每次开流都会默认打开，支持 RLE/Y10/Y11/Y12/Y14 格式)
OB2_PROP_SDK_IR_FRAME_UNPACK_BOOL	IR 数据解包功能开关 (每次开流都会默认打开，支持 RLE/Y10/Y11/Y12/Y14 格式)
OB2_RAW_DATA_CAMERA_CALIB_JSON_FILE	从设备端读取的标定 Json 文件 (Femto Mega, read only)
OB2_RAW_DATA_D2C_ROT_LUT_FILE	D2C 初始化表文件 (Femto Mega)
OB2_STRUCT_DEBUG_SENSOR_EXPOSURE_TIME	曝光时间读写

在文件 ob2types.h 第 892 行定义.

ob2_command_type_t

enum ob2_command_type_t

控制命令类型

枚举值
OB2_UNKNOWN_COMMAND_TYPE	未知
OB2_BOOL_PROPERTY	布尔型属性命令
OB2_INT_PROPERTY	整型属性命令
OB2_FLOAT_PROPERTY	浮点型属性命令
OB2_ENUM_PROPERTY	枚举型属性命令
OB2_STRUCTURED_DATA	结构体类似数据命令
OB2_RAW_DATA	裸数据命令

在文件 ob2types.h 第 1222 行定义.

ob2_access_permission_t

enum ob2_access_permission_t

访问权限（主要用户命令）

枚举值
OB2_PERMISSION_DENY	无访问权限
OB2_PERMISSION_READ	可读
OB2_PERMISSION_WRITE	可写
OB2_PERMISSION_READ_WRITE	可读写

在文件 ob2types.h 第 1239 行定义.

ob2_update_state_t

enum ob2_update_state_t

设备固件升级状态

枚举值
OB2_STAT_FILE_TRANSFER	文件传输中
OB2_STAT_DONE	升级完成
OB2_STAT_IN_PROGRESS	升级中
OB2_STAT_START	开始升级
OB2_STAT_VERIFY_IMAGE	镜像文件校验中
OB2_ERR_VERIFY	校验失败
OB2_ERR_PROGRAM	程序执行失败
OB2_ERR_ERASE	Flash 参数失败
OB2_ERR_FLASH_TYPE	Flash 类型错误
OB2_ERR_IMAGE_SIZE	镜像文件大小错误
OB2_ERR_OTHER	其他错误
OB2_ERR_DDR	DDR 访问错误
OB2_ERR_TIMEOUT	超时错误

在文件 ob2types.h 第 1329 行定义.

ob2_playback_state_t

enum ob2_playback_state_t

回放状态

枚举值
OB2_PLAYBACK_BEGIN	开始
OB2_PLAYBACK_PAUSE	暂停
OB2_PLAYBACK_RESUME	继续
OB2_PLAYBACK_END	终止

在文件 ob2types.h 第 1438 行定义.

ob2_cameras_sync_mode_t

enum ob2_cameras_sync_mode_t

相机同步模式

枚举值
OB2_CAMERA_SYNC_MODE_CLOSE	关闭, Color 与 Depth 不相关联
OB2_CAMERA_SYNC_MODE_COLOR_EXPOSURE_FIRST	Color 优先曝光，Color 曝光触发 Depth/IR 曝光
OB2_CAMERA_SYNC_MODE_DEPTH_EXPOSURE_FIRST	Depth/IR 优先曝光，Depth 曝光触发 Color 曝光

在文件 ob2types.h 第 1462 行定义.

ob2_wired_sync_mode_t

enum ob2_wired_sync_mode_t

多机线连接同步模式

枚举值
OB2_WIRED_SYNC_MODE_STANDALONE	不接收外部触发信号，也不向外输出触发信号
OB2_WIRED_SYNC_MODE_PRIMARY	主模式，不接收外部触发信号，但是会向外输出触发信号
OB2_WIRED_SYNC_MODE_SECONDARY	从模式，接收外部触发信号，不向外输出触发信号

在文件 ob2types.h 第 1478 行定义.