| OrbbecSDK 1.5.7 OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices

- 首页
- 命名空间
- 类
- 文件

- 文件列表
- 文件成员

类 | 宏定义 | 类型定义 | 枚举
Property.h 文件参考

控制命令属性列表维护 更多...

`#include "ObTypes.h"`

浏览源代码.

## 类
struct | OBPropertyItem
| 用于描述每一个属性的特性 更多...

## 宏定义
#define | _OB_PROPERTY_H_

## 类型定义
typedef enum OBPropertyID | ob_property_id
typedef enum OBPropertyType | OBPropertyType
| 用于描述所有属性设置的数据类型 更多...
typedef enum OBPropertyType | ob_property_type
typedef struct OBPropertyItem | OBPropertyItem
| 用于描述每一个属性的特性 更多...
typedef struct OBPropertyItem | ob_property_item

## 枚举
enum | OBPropertyID { OB_PROP_LDP_BOOL = 2, OB_PROP_LASER_BOOL = 3, OB_PROP_LASER_PULSE_WIDTH_INT = 4, OB_PROP_LASER_CURRENT_FLOAT = 5, OB_PROP_FLOOD_BOOL = 6, OB_PROP_FLOOD_LEVEL_INT = 7, OB_PROP_DEPTH_MIRROR_BOOL = 14, OB_PROP_DEPTH_FLIP_BOOL = 15, OB_PROP_DEPTH_POSTFILTER_BOOL = 16, OB_PROP_DEPTH_HOLEFILTER_BOOL = 17, OB_PROP_IR_MIRROR_BOOL = 18, OB_PROP_IR_FLIP_BOOL = 19, OB_PROP_MIN_DEPTH_INT = 22, OB_PROP_MAX_DEPTH_INT = 23, OB_PROP_DEPTH_SOFT_FILTER_BOOL = 24, OB_PROP_LDP_STATUS_BOOL = 32, OB_PROP_DEPTH_MAX_DIFF_INT = 40, OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT = 41, OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL = 42, OB_PROP_TIMESTAMP_OFFSET_INT = 43, OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL = 61, OB_PROP_FAN_WORK_MODE_INT = 62, OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT = 63, OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL = 64, OB_PROP_DEPTH_PRECISION_LEVEL_INT, OB_PROP_TOF_FILTER_RANGE_INT = 76, OB_PROP_LASER_MODE_INT = 79, OB_PROP_RECTIFY2_BOOL = 80, OB_PROP_COLOR_MIRROR_BOOL = 81, OB_PROP_COLOR_FLIP_BOOL = 82, OB_PROP_INDICATOR_LIGHT_BOOL = 83, OB_PROP_DISPARITY_TO_DEPTH_BOOL, OB_PROP_BRT_BOOL, OB_PROP_WATCHDOG_BOOL = 87, OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL, OB_PROP_HEARTBEAT_BOOL = 89, OB_PROP_DEPTH_CROPPING_MODE_INT, OB_PROP_D2C_PREPROCESS_BOOL, OB_PROP_RGB_CUSTOM_CROP_BOOL = 94, OB_PROP_DEVICE_WORK_MODE_INT = 95, OB_PROP_DEVICE_COMMUNICATION_TYPE_INT = 97, OB_PROP_SWITCH_IR_MODE_INT = 98, OB_PROP_LASER_ENERGY_LEVEL_INT = 99, OB_PROP_LDP_MEASURE_DISTANCE_INT = 100, OB_PROP_TIMER_RESET_SIGNAL_BOOL = 104, OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL = 105, OB_PROP_TIMER_RESET_DELAY_US_INT = 106, OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL = 107, OB_PROP_IR_RIGHT_MIRROR_BOOL = 112, OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT = 113, OB_PROP_IR_RIGHT_FLIP_BOOL = 114, OB_PROP_COLOR_ROTATE_INT = 115, OB_PROP_IR_ROTATE_INT = 116, OB_PROP_IR_RIGHT_ROTATE_INT = 117, OB_PROP_DEPTH_ROTATE_INT = 118, OB_PROP_LASER_HW_ENERGY_LEVEL_INT, OB_PROP_USB_POWER_STATE_INT = 121, OB_PROP_DC_POWER_STATE_INT = 122, OB_STRUCT_BASELINE_CALIBRATION_PARAM = 1002, OB_STRUCT_DEVICE_TEMPERATURE = 1003, OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL = 1024, OB_STRUCT_DEVICE_SERIAL_NUMBER = 1035, OB_STRUCT_DEVICE_TIME = 1037, OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG, OB_STRUCT_RGB_CROP_ROI = 1040, OB_STRUCT_DEVICE_IP_ADDR_CONFIG = 1041, OB_STRUCT_CURRENT_DEPTH_ALG_MODE = 1043, OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST = 1045, OB_PROP_COLOR_AUTO_EXPOSURE_BOOL = 2000, OB_PROP_COLOR_EXPOSURE_INT = 2001, OB_PROP_COLOR_GAIN_INT = 2002, OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL = 2003, OB_PROP_COLOR_WHITE_BALANCE_INT = 2004, OB_PROP_COLOR_BRIGHTNESS_INT = 2005, OB_PROP_COLOR_SHARPNESS_INT = 2006, OB_PROP_COLOR_SATURATION_INT = 2008, OB_PROP_COLOR_CONTRAST_INT = 2009, OB_PROP_COLOR_GAMMA_INT = 2010, OB_PROP_COLOR_ROLL_INT = 2011, OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT = 2012, OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT = 2013, OB_PROP_COLOR_HUE_INT = 2014, OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT = 2015, OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL = 2016, OB_PROP_DEPTH_EXPOSURE_INT = 2017, OB_PROP_DEPTH_GAIN_INT = 2018, OB_PROP_GYRO_ODR_INT = 2021, OB_PROP_ACCEL_ODR_INT = 2022, OB_PROP_GYRO_FULL_SCALE_INT = 2023, OB_PROP_ACCEL_FULL_SCALE_INT = 2024, OB_PROP_IR_AUTO_EXPOSURE_BOOL = 2025, OB_PROP_IR_EXPOSURE_INT = 2026, OB_PROP_IR_GAIN_INT = 2027, OB_PROP_IR_CHANNEL_DATA_SOURCE_INT = 2028, OB_PROP_DEPTH_RM_FILTER_BOOL = 2029, OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL = 3004, OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL, OB_PROP_SDK_IR_FRAME_UNPACK_BOOL, OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL = 3009, OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL = 3010, OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL = 3011, OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL = 3012, OB_RAW_DATA_CAMERA_CALIB_JSON_FILE = 4029 }
| 描述设备所有的属性控制命令的枚举值 更多...
enum | OBPropertyType { OB_BOOL_PROPERTY = 0, OB_INT_PROPERTY = 1, OB_FLOAT_PROPERTY = 2, OB_STRUCT_PROPERTY = 3 }
| 用于描述所有属性设置的数据类型 更多...

## 详细描述

控制命令属性列表维护

在文件 Property.h 中定义.

## 宏定义说明

#define _OB_PROPERTY_H_

在文件 Property.h 第 18 行定义.

## 类型定义说明

typedef enum OBPropertyID ob_property_id

typedef enum OBPropertyType OBPropertyType

用于描述所有属性设置的数据类型

typedef enum OBPropertyType ob_property_type

typedef struct OBPropertyItem OBPropertyItem

用于描述每一个属性的特性

typedef struct OBPropertyItem ob_property_item

## 枚举类型说明

enum OBPropertyID

描述设备所有的属性控制命令的枚举值

枚举值
OB_PROP_LDP_BOOL | LDP开关
OB_PROP_LASER_BOOL | 激光开关
OB_PROP_LASER_PULSE_WIDTH_INT | 读写激光Time值（脉宽）
OB_PROP_LASER_CURRENT_FLOAT | 激光电流
OB_PROP_FLOOD_BOOL | 泛光灯开关
OB_PROP_FLOOD_LEVEL_INT | 泛光灯等级
OB_PROP_DEPTH_MIRROR_BOOL | 深度镜像
OB_PROP_DEPTH_FLIP_BOOL | 深度翻转
OB_PROP_DEPTH_POSTFILTER_BOOL | 深度Postfilter
OB_PROP_DEPTH_HOLEFILTER_BOOL | 深度Holefilter
OB_PROP_IR_MIRROR_BOOL | IR 镜像
OB_PROP_IR_FLIP_BOOL | IR 翻转
OB_PROP_MIN_DEPTH_INT | 最小深度阈值
OB_PROP_MAX_DEPTH_INT | 最大深度阈值
OB_PROP_DEPTH_SOFT_FILTER_BOOL | 软件滤波开关
OB_PROP_LDP_STATUS_BOOL | LDP状态
OB_PROP_DEPTH_MAX_DIFF_INT | soft filter maxdiff param
OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT | soft filter maxSpeckleSize
OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL | 硬件d2c开
OB_PROP_TIMESTAMP_OFFSET_INT | 时间戳调校
OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL | 硬件去畸变开关 Rectify
OB_PROP_FAN_WORK_MODE_INT | 风扇开关模式
OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT | 多分辨率D2C模式
OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL | 防串货状态
OB_PROP_DEPTH_PRECISION_LEVEL_INT | 深度精度等级，可能会改变深度帧数据单位，需要通过DepthFrame的ValueScale接口确认
OB_PROP_TOF_FILTER_RANGE_INT | tof滤波场景范围配置
OB_PROP_LASER_MODE_INT | 激光点亮模式，固件端目前只返回 1: IR Drive, 2: Torch
OB_PROP_RECTIFY2_BOOL | brt2r-rectify功能开关(brt2r是mx6600上的一个特殊模块)，0:关闭, 1:打开
OB_PROP_COLOR_MIRROR_BOOL | 彩色镜像
OB_PROP_COLOR_FLIP_BOOL | 彩色翻转
OB_PROP_INDICATOR_LIGHT_BOOL | 指示灯开关，0:关闭， 1:打开
OB_PROP_DISPARITY_TO_DEPTH_BOOL | 视差转深度开关， 0：关闭，深度流输出视差图； 1. 打开，深度流输出深度图
OB_PROP_BRT_BOOL | BRT功能开关(抗背景干扰)，0:关闭， 1:打开
OB_PROP_WATCHDOG_BOOL | 看门狗功能开关，0:关闭， 1:打开
OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL | 外部信号触发重启功能开关，0:关闭， 1:打开
OB_PROP_HEARTBEAT_BOOL | 心跳监测功能开关，0:关闭， 1:打开
OB_PROP_DEPTH_CROPPING_MODE_INT | 深度裁剪模式设备: OB_DEPTH_CROPPING_MODE
OB_PROP_D2C_PREPROCESS_BOOL | D2C前处理开关（如RGB裁剪），0:关闭，1:打开
OB_PROP_RGB_CUSTOM_CROP_BOOL | 自定义RGB裁剪开关，0为关闭，1为开启自定义裁剪，下发ROI裁剪区域
OB_PROP_DEVICE_WORK_MODE_INT | 设备工作模式（功耗）
OB_PROP_DEVICE_COMMUNICATION_TYPE_INT | 设备通信方式 0: USB; 1: Ethernet(RTSP)
OB_PROP_SWITCH_IR_MODE_INT | 切换IR模式，0为主动IR模式,1为被动IR模式
OB_PROP_LASER_ENERGY_LEVEL_INT | 激光能量层级
OB_PROP_LDP_MEASURE_DISTANCE_INT | 获取激光近距离保护的测量值，单位：mm
OB_PROP_TIMER_RESET_SIGNAL_BOOL | 触发设备时间归零
OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL | 向外发送时间归零信号开关, true:打开, false: 关闭; 默认为true
OB_PROP_TIMER_RESET_DELAY_US_INT | 设置硬件时间归零延迟时间, 单位: 微妙
OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL | 软触发信号, 触发抓拍图片
OB_PROP_IR_RIGHT_MIRROR_BOOL | 右IR的镜像
OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT | 单次软触发抓拍的帧数, 范围：[1, 255]
OB_PROP_IR_RIGHT_FLIP_BOOL | 右IR的翻转, true：翻转,false：不翻转；默认为false
OB_PROP_COLOR_ROTATE_INT | 彩色旋转, 翻转角度范围{0, 90, 180, 270}, 默认为0
OB_PROP_IR_ROTATE_INT | IR旋转, 翻转角度范围{0, 90, 180, 270}, 默认为0
OB_PROP_IR_RIGHT_ROTATE_INT | 右IR旋转, 翻转角度范围{0, 90, 180, 270}, 默认为0
OB_PROP_DEPTH_ROTATE_INT | 深度旋转, 翻转角度范围{0, 90, 180, 270}, 默认为0
OB_PROP_LASER_HW_ENERGY_LEVEL_INT | 查询激光硬件的实际能量层级, OB_PROP_LASER_ENERGY_LEVEL_INT（99）指令用于设置能级,该指令用于查询设置后硬件实际能级
OB_PROP_USB_POWER_STATE_INT | USB供电状态，状态值枚举: OBUSBPowerState
OB_PROP_DC_POWER_STATE_INT | DC供电状态,状态值枚举: OBDCPowerState
OB_STRUCT_BASELINE_CALIBRATION_PARAM | 基线标定参数
OB_STRUCT_DEVICE_TEMPERATURE | 设备温度信息
OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL | TOF曝光阈值范围
OB_STRUCT_DEVICE_SERIAL_NUMBER | 获取/设置序列号
OB_STRUCT_DEVICE_TIME | 获取/设置设备时间
OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG | 多设备同步模式和参数配置
OB_STRUCT_RGB_CROP_ROI | RGB裁剪ROI
OB_STRUCT_DEVICE_IP_ADDR_CONFIG | 设备ip地址配置
OB_STRUCT_CURRENT_DEPTH_ALG_MODE | 当前的相机深度模式
OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST | 深度精度等级列表，返回uin16_t数组，对应精度等级的枚举定义，枚举：OBDepthPrecisionLevel
OB_PROP_COLOR_AUTO_EXPOSURE_BOOL | 彩色相机自动曝光
OB_PROP_COLOR_EXPOSURE_INT | 彩色相机曝光调节
OB_PROP_COLOR_GAIN_INT | 彩色相机增益调节
OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL | 彩色相机自动白平衡
OB_PROP_COLOR_WHITE_BALANCE_INT | 彩色相机白平衡调节
OB_PROP_COLOR_BRIGHTNESS_INT | 彩色相机亮度调节
OB_PROP_COLOR_SHARPNESS_INT | 彩色相机锐度调节
OB_PROP_COLOR_SATURATION_INT | 彩色相机饱和度调节
OB_PROP_COLOR_CONTRAST_INT | 彩色相机对比度调节
OB_PROP_COLOR_GAMMA_INT | 彩色相机伽马值调节
OB_PROP_COLOR_ROLL_INT | 彩色相机图像旋转
OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT | 彩色相机自动曝光优先
OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT | 彩色相机亮度补偿
OB_PROP_COLOR_HUE_INT | 彩色相机彩色色调
OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT | 彩色相机电力线路频率
OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL | 深度相机自动曝光（某些型号设备下会同步设置红外相机）
OB_PROP_DEPTH_EXPOSURE_INT | 深度相机曝光调节（某些型号设备下会同步设置红外相机）
OB_PROP_DEPTH_GAIN_INT | 深度相机增益调节（某些型号设备下会同步设置红外相机）
OB_PROP_GYRO_ODR_INT | get/set当前陀螺仪的采样率
OB_PROP_ACCEL_ODR_INT | get/set当前加速度计的采样率
OB_PROP_GYRO_FULL_SCALE_INT | get/set当前陀螺仪的量程
OB_PROP_ACCEL_FULL_SCALE_INT | get/set当前加速度计的量程
OB_PROP_IR_AUTO_EXPOSURE_BOOL | 红外相机自动曝光（某些型号设备下会同步设置深度相机）
OB_PROP_IR_EXPOSURE_INT | 红外相机曝光调节（某些型号设备下会同步设置深度相机）
OB_PROP_IR_GAIN_INT | 红外相机增益调节（某些型号设备下会同步设置深度相机）
OB_PROP_IR_CHANNEL_DATA_SOURCE_INT | 读写IR通道的输出目标sensor,不支持时返回错误。0: 左侧IR sensor,1: 右侧IR sensor;
OB_PROP_DEPTH_RM_FILTER_BOOL | 深度效果去畸变, true：打开，false：关闭, 与D2C功能互斥。软硬件D2C开启时，不能使用mask功能
OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL | 视差转深度
OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL | Depth数据解包功能开关(每次开流都会默认打开，支持RLE/Y10/Y11/Y12/Y14格式)
OB_PROP_SDK_IR_FRAME_UNPACK_BOOL | Ir数据解包功能开关(每次开流都会默认打开，支持RLE/Y10/Y11/Y12/Y14格式)
OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL | Accel数据转换功能开关(默认打开)
OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL | Gyro数据转换功能开关(默认打开)
OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL | [左]Ir数据解包功能开关(每次开流都会默认打开，支持RLE/Y10/Y11/Y12/Y14格式)
OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL | [右]Ir数据解包功能开关(每次开流都会默认打开，支持RLE/Y10/Y11/Y12/Y14格式)
OB_RAW_DATA_CAMERA_CALIB_JSON_FILE | 从设备端读取的标定Json文件(Femto Mega, read only)

在文件 Property.h 第 33 行定义.

enum OBPropertyType

用于描述所有属性设置的数据类型

枚举值
OB_BOOL_PROPERTY | bool类型数据的属性
OB_INT_PROPERTY | int类型数据的属性
OB_FLOAT_PROPERTY | float类型数据的属性
OB_STRUCT_PROPERTY | struct类型数据的属性

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