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

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

Property.h
Go to the documentation of this file.
1 // License: Apache 2.0. See LICENSE file in root directory.
2 // Copyright(c) 2020 Orbbec Corporation. All Rights Reserved.
3
14 #ifdef OB_SENSOR_SDK_DEVELOPER
15 #include "libobsensor/internal/InternalProperty.h"
16 #else // not define OB_SENSOR_SDK_DEVELOPER
17 #ifndef _OB_PROPERTY_H_
18 #define _OB_PROPERTY_H_
19
20 #include "ObTypes.h"
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
33 typedef enum {
34 OB_PROP_LDP_BOOL = 2,
35 OB_PROP_LASER_BOOL = 3,
36 OB_PROP_LASER_PULSE_WIDTH_INT = 4,
37 OB_PROP_LASER_CURRENT_FLOAT = 5,
38 OB_PROP_FLOOD_BOOL = 6,
39 OB_PROP_FLOOD_LEVEL_INT = 7,
40 OB_PROP_DEPTH_MIRROR_BOOL = 14,
41 OB_PROP_DEPTH_FLIP_BOOL = 15,
42 OB_PROP_DEPTH_POSTFILTER_BOOL = 16,
43 OB_PROP_DEPTH_HOLEFILTER_BOOL = 17,
44 OB_PROP_IR_MIRROR_BOOL = 18,
45 OB_PROP_IR_FLIP_BOOL = 19,
46 OB_PROP_MIN_DEPTH_INT = 22,
47 OB_PROP_MAX_DEPTH_INT = 23,
48 OB_PROP_DEPTH_SOFT_FILTER_BOOL = 24,
49 OB_PROP_LDP_STATUS_BOOL = 32,
50 OB_PROP_DEPTH_MAX_DIFF_INT = 40,
51 OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT = 41,
52 OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL = 42,
53 OB_PROP_TIMESTAMP_OFFSET_INT = 43,
54 OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL = 61,
55 OB_PROP_FAN_WORK_MODE_INT = 62,
56 OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT = 63,
57 OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL = 64,
58 OB_PROP_DEPTH_PRECISION_LEVEL_INT =
59 75,
61 OB_PROP_TOF_FILTER_RANGE_INT = 76,
62 OB_PROP_LASER_MODE_INT = 79,
64 OB_PROP_RECTIFY2_BOOL = 80,
66 OB_PROP_COLOR_MIRROR_BOOL = 81,
67 OB_PROP_COLOR_FLIP_BOOL = 82,
68 OB_PROP_INDICATOR_LIGHT_BOOL = 83,
69 OB_PROP_DISPARITY_TO_DEPTH_BOOL =
70 85,
72 OB_PROP_BRT_BOOL =
73 86,
74 OB_PROP_WATCHDOG_BOOL = 87,
75 OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL =
76 88,
77 OB_PROP_HEARTBEAT_BOOL = 89,
78 OB_PROP_DEPTH_CROPPING_MODE_INT =
79 90,
80 OB_PROP_D2C_PREPROCESS_BOOL =
81 91,
82 OB_PROP_RGB_CUSTOM_CROP_BOOL = 94,
85 OB_PROP_DEVICE_WORK_MODE_INT = 95,
86 OB_PROP_DEVICE_COMMUNICATION_TYPE_INT = 97,
87 OB_PROP_SWITCH_IR_MODE_INT = 98,
88 OB_PROP_LASER_ENERGY_LEVEL_INT = 99,
89 OB_PROP_LDP_MEASURE_DISTANCE_INT = 100,
90 OB_PROP_TIMER_RESET_SIGNAL_BOOL = 104,
91 OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL = 105,
92 OB_PROP_TIMER_RESET_DELAY_US_INT = 106,
93 OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL = 107,
94 OB_PROP_IR_RIGHT_MIRROR_BOOL = 112,
95 OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT = 113,
96 OB_PROP_IR_RIGHT_FLIP_BOOL = 114,
97 OB_PROP_COLOR_ROTATE_INT = 115,
98 OB_PROP_IR_ROTATE_INT = 116,
99 OB_PROP_IR_RIGHT_ROTATE_INT = 117,
100 OB_PROP_DEPTH_ROTATE_INT = 118,
101 OB_PROP_LASER_HW_ENERGY_LEVEL_INT =
102 119,
103 OB_PROP_USB_POWER_STATE_INT = 121,
104 OB_PROP_DC_POWER_STATE_INT = 122,
106 OB_STRUCT_BASELINE_CALIBRATION_PARAM = 1002,
107 OB_STRUCT_DEVICE_TEMPERATURE = 1003,
108 OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL = 1024,
109 OB_STRUCT_DEVICE_SERIAL_NUMBER = 1035,
110 OB_STRUCT_DEVICE_TIME = 1037,
111 OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG =
112 1038,
113 OB_STRUCT_RGB_CROP_ROI = 1040,
114 OB_STRUCT_DEVICE_IP_ADDR_CONFIG = 1041,
115 OB_STRUCT_CURRENT_DEPTH_ALG_MODE = 1043,
116 OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST = 1045,
118 OB_PROP_COLOR_AUTO_EXPOSURE_BOOL = 2000,
119 OB_PROP_COLOR_EXPOSURE_INT = 2001,
120 OB_PROP_COLOR_GAIN_INT = 2002,
121 OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL = 2003,
122 OB_PROP_COLOR_WHITE_BALANCE_INT = 2004,
123 OB_PROP_COLOR_BRIGHTNESS_INT = 2005,
124 OB_PROP_COLOR_SHARPNESS_INT = 2006,
125 OB_PROP_COLOR_SATURATION_INT = 2008,
126 OB_PROP_COLOR_CONTRAST_INT = 2009,
127 OB_PROP_COLOR_GAMMA_INT = 2010,
128 OB_PROP_COLOR_ROLL_INT = 2011,
129 OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT = 2012,
130 OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT = 2013,
131 OB_PROP_COLOR_HUE_INT = 2014,
132 OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT = 2015,
133 OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL = 2016,
135 OB_PROP_DEPTH_EXPOSURE_INT = 2017,
137 OB_PROP_DEPTH_GAIN_INT = 2018,
139 OB_PROP_GYRO_ODR_INT = 2021,
140 OB_PROP_ACCEL_ODR_INT = 2022,
141 OB_PROP_GYRO_FULL_SCALE_INT = 2023,
142 OB_PROP_ACCEL_FULL_SCALE_INT = 2024,
143 OB_PROP_IR_AUTO_EXPOSURE_BOOL = 2025,
145 OB_PROP_IR_EXPOSURE_INT = 2026,
147 OB_PROP_IR_GAIN_INT = 2027,
149 OB_PROP_IR_CHANNEL_DATA_SOURCE_INT = 2028,
150 OB_PROP_DEPTH_RM_FILTER_BOOL = 2029,
152 OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL = 3004,
153 OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL =
154 3007,
156 OB_PROP_SDK_IR_FRAME_UNPACK_BOOL =
157 3008,
159 OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL = 3009,
160 OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL = 3010,
161 OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL = 3011,
162 OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL = 3012,
163 OB_RAW_DATA_CAMERA_CALIB_JSON_FILE = 4029,
164 } OBPropertyID,
165 ob_property_id;
166
174 typedef enum OBPropertyType {
175 OB_BOOL_PROPERTY = 0,
176 OB_INT_PROPERTY = 1,
177 OB_FLOAT_PROPERTY = 2,
178 OB_STRUCT_PROPERTY = 3,
179 } OBPropertyType,
180 ob_property_type;
181
189 typedef struct OBPropertyItem {
190 OBPropertyID id;
191 const char * name;
192 OBPropertyType type;
193 OBPermissionType permission;
194 } OBPropertyItem, ob_property_item;
195
196 #ifdef __cplusplus
197 }
198 #endif
199
200 #endif // _OB_PROPERTY_H_
201 #endif // OB_SENSOR_SDK_DEVELOPER
OBPropertyType
OBPropertyType
The data type used to describe all property settings.
Definition: Property.h:174
OB_PROP_LASER_CURRENT_FLOAT
Definition: Property.h:37
OB_PROP_COLOR_EXPOSURE_INT
Definition: Property.h:119
OB_PROP_DEPTH_EXPOSURE_INT
Definition: Property.h:135
OB_PROP_HEARTBEAT_BOOL
Definition: Property.h:77
OB_PROP_DEPTH_PRECISION_LEVEL_INT
Definition: Property.h:58
OB_PROP_WATCHDOG_BOOL
Definition: Property.h:74
OB_PROP_GYRO_ODR_INT
Definition: Property.h:139
OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT
Definition: Property.h:56
OB_PROP_TIMER_RESET_SIGNAL_BOOL
Definition: Property.h:90
OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL
Definition: Property.h:159
OB_PROP_IR_RIGHT_FLIP_BOOL
Definition: Property.h:96
OB_PROP_RGB_CUSTOM_CROP_BOOL
Definition: Property.h:82
OBPropertyItem::permission
OBPermissionType permission
Property read and write permission.
Definition: Property.h:193
OB_PROP_DEVICE_WORK_MODE_INT
Definition: Property.h:85
OB_PROP_DEPTH_MIRROR_BOOL
Definition: Property.h:40
OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG
Definition: Property.h:111
OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL
Definition: Property.h:54
OB_PROP_COLOR_CONTRAST_INT
Definition: Property.h:126
OB_PROP_LASER_BOOL
Definition: Property.h:35
OB_PROP_COLOR_ROLL_INT
Definition: Property.h:128
OB_PROP_DISPARITY_TO_DEPTH_BOOL
Definition: Property.h:69
OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL
Definition: Property.h:108
ob_property_id
enum OBPropertyID ob_property_id
OB_BOOL_PROPERTY
Definition: Property.h:175
OB_PROP_TOF_FILTER_RANGE_INT
Definition: Property.h:61
OB_PROP_SWITCH_IR_MODE_INT
Definition: Property.h:87
OB_PROP_FLOOD_BOOL
Definition: Property.h:38
OB_PROP_ACCEL_FULL_SCALE_INT
Definition: Property.h:142
OB_STRUCT_DEVICE_TIME
Definition: Property.h:110
OB_PROP_DEPTH_POSTFILTER_BOOL
Definition: Property.h:42
OB_PROP_RECTIFY2_BOOL
Definition: Property.h:64
OB_PROP_DEPTH_FLIP_BOOL
Definition: Property.h:41
OB_PROP_DEVICE_COMMUNICATION_TYPE_INT
Definition: Property.h:86
OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL
Definition: Property.h:152
OB_PROP_ACCEL_ODR_INT
Definition: Property.h:140
OB_PROP_DEPTH_SOFT_FILTER_BOOL
Definition: Property.h:48
OBPropertyItem
struct OBPropertyItem OBPropertyItem
Used to describe the characteristics of each property.
OB_PROP_DEPTH_HOLEFILTER_BOOL
Definition: Property.h:43
OB_PROP_COLOR_HUE_INT
Definition: Property.h:131
OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL
Definition: Property.h:91
OB_PROP_LDP_BOOL
Definition: Property.h:34
OB_PROP_FLOOD_LEVEL_INT
Definition: Property.h:39
OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL
Definition: Property.h:160
OB_STRUCT_RGB_CROP_ROI
Definition: Property.h:113
OB_STRUCT_CURRENT_DEPTH_ALG_MODE
Definition: Property.h:115
OB_PROP_FAN_WORK_MODE_INT
Definition: Property.h:55
OB_STRUCT_DEVICE_TEMPERATURE
Definition: Property.h:107
OB_PROP_LASER_HW_ENERGY_LEVEL_INT
Definition: Property.h:101
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
OB_PROP_SDK_IR_FRAME_UNPACK_BOOL
Definition: Property.h:156
OB_PROP_COLOR_WHITE_BALANCE_INT
Definition: Property.h:122
OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL
Definition: Property.h:133
OB_PROP_TIMESTAMP_OFFSET_INT
Definition: Property.h:53
OB_PROP_BRT_BOOL
Definition: Property.h:72
OB_PROP_IR_EXPOSURE_INT
Definition: Property.h:145
OB_PROP_COLOR_AUTO_EXPOSURE_BOOL
Definition: Property.h:118
OB_PROP_MAX_DEPTH_INT
Definition: Property.h:47
OBPropertyID
OBPropertyID
Enumeration value describing all attribute control commands of the device.
Definition: Property.h:33
OBPropertyItem::id
OBPropertyID id
Property id.
Definition: Property.h:190
OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL
Definition: Property.h:161
OB_STRUCT_BASELINE_CALIBRATION_PARAM
Definition: Property.h:106
OB_PROP_GYRO_FULL_SCALE_INT
Definition: Property.h:141
OB_PROP_DEPTH_CROPPING_MODE_INT
Definition: Property.h:78
OB_PROP_TIMER_RESET_DELAY_US_INT
Definition: Property.h:92
OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL
Definition: Property.h:162
OBPermissionType
OBPermissionType
the permission type of api or property
Definition: ObTypes.h:71
OB_PROP_DEPTH_GAIN_INT
Definition: Property.h:137
OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT
Definition: Property.h:51
OB_PROP_MIN_DEPTH_INT
Definition: Property.h:46
OB_PROP_IR_GAIN_INT
Definition: Property.h:147
OB_PROP_COLOR_MIRROR_BOOL
Definition: Property.h:66
OB_STRUCT_PROPERTY
Definition: Property.h:178
OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL
Definition: Property.h:75
OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL
Definition: Property.h:121
OB_PROP_IR_ROTATE_INT
Definition: Property.h:98
OB_PROP_LASER_PULSE_WIDTH_INT
Definition: Property.h:36
OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT
Definition: Property.h:132
OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL
Definition: Property.h:153
OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL
Definition: Property.h:52
OB_PROP_COLOR_GAIN_INT
Definition: Property.h:120
OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL
Definition: Property.h:93
OB_PROP_LDP_MEASURE_DISTANCE_INT
Definition: Property.h:89
OB_PROP_IR_RIGHT_MIRROR_BOOL
Definition: Property.h:94
OB_PROP_IR_CHANNEL_DATA_SOURCE_INT
Definition: Property.h:149
OB_PROP_USB_POWER_STATE_INT
Definition: Property.h:103
OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL
Definition: Property.h:57
OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT
Definition: Property.h:130
OB_PROP_LASER_ENERGY_LEVEL_INT
Definition: Property.h:88
OB_PROP_DEPTH_RM_FILTER_BOOL
Definition: Property.h:150
ob_property_type
enum OBPropertyType ob_property_type
OB_PROP_COLOR_SHARPNESS_INT
Definition: Property.h:124
OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT
Definition: Property.h:129
OB_PROP_DEPTH_ROTATE_INT
Definition: Property.h:100
OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST
Definition: Property.h:116
OBPropertyItem
Used to describe the characteristics of each property.
Definition: Property.h:189
OB_FLOAT_PROPERTY
Definition: Property.h:177
OBPropertyItem::name
const char * name
Property name.
Definition: Property.h:191
OB_PROP_D2C_PREPROCESS_BOOL
Definition: Property.h:80
OB_PROP_IR_FLIP_BOOL
Definition: Property.h:45
OB_STRUCT_DEVICE_SERIAL_NUMBER
Definition: Property.h:109
OB_PROP_COLOR_ROTATE_INT
Definition: Property.h:97
OB_PROP_COLOR_BRIGHTNESS_INT
Definition: Property.h:123
OB_INT_PROPERTY
Definition: Property.h:176
OB_PROP_DEPTH_MAX_DIFF_INT
Definition: Property.h:50
OB_PROP_COLOR_GAMMA_INT
Definition: Property.h:127
OB_PROP_INDICATOR_LIGHT_BOOL
Definition: Property.h:68
OB_RAW_DATA_CAMERA_CALIB_JSON_FILE
Definition: Property.h:163
OB_STRUCT_DEVICE_IP_ADDR_CONFIG
Definition: Property.h:114
OB_PROP_COLOR_SATURATION_INT
Definition: Property.h:125
OB_PROP_DC_POWER_STATE_INT
Definition: Property.h:104
OB_PROP_IR_AUTO_EXPOSURE_BOOL
Definition: Property.h:143
OB_PROP_IR_MIRROR_BOOL
Definition: Property.h:44
OB_PROP_IR_RIGHT_ROTATE_INT
Definition: Property.h:99
OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT
Definition: Property.h:95
OB_PROP_COLOR_FLIP_BOOL
Definition: Property.h:67
ob_property_item
struct OBPropertyItem ob_property_item
OB_PROP_LASER_MODE_INT
Definition: Property.h:62
OB_PROP_LDP_STATUS_BOOL
Definition: Property.h:49
OBPropertyItem::type
OBPropertyType type
Property type.
Definition: Property.h:192