| OrbbecSDK 1.10.18 OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras

Loading...
Searching...
No Matches
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
9#ifdef OB_SENSOR_SDK_DEVELOPER
10#include "libobsensor/internal/InternalProperty.h"
11#else // not define OB_SENSOR_SDK_DEVELOPER
12#ifndef _OB_PROPERTY_H_
13#define _OB_PROPERTY_H_
14
15#include "ObTypes.h"
16
17#ifdef __cplusplus
18 extern "C" {
19#endif
20
24 typedef enum {
28 OB_PROP_LDP_BOOL = 2,
29
33 OB_PROP_LASER_BOOL = 3,
34
38 OB_PROP_LASER_PULSE_WIDTH_INT = 4,
39
43 OB_PROP_LASER_CURRENT_FLOAT = 5,
44
48 OB_PROP_FLOOD_BOOL = 6,
49
53 OB_PROP_FLOOD_LEVEL_INT = 7,
54
58 OB_PROP_DEPTH_MIRROR_BOOL = 14,
59
63 OB_PROP_DEPTH_FLIP_BOOL = 15,
64
68 OB_PROP_DEPTH_POSTFILTER_BOOL = 16,
69
73 OB_PROP_DEPTH_HOLEFILTER_BOOL = 17,
74
78 OB_PROP_IR_MIRROR_BOOL = 18,
79
83 OB_PROP_IR_FLIP_BOOL = 19,
84
88 OB_PROP_MIN_DEPTH_INT = 22,
89
93 OB_PROP_MAX_DEPTH_INT = 23,
94
98 OB_PROP_DEPTH_SOFT_FILTER_BOOL = 24,
99
103 OB_PROP_LDP_STATUS_BOOL = 32,
104
108 OB_PROP_DEPTH_MAX_DIFF_INT = 40,
109
113 OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT = 41,
114
118 OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL = 42,
119
123 OB_PROP_TIMESTAMP_OFFSET_INT = 43,
124
128 OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL = 61,
129
133 OB_PROP_FAN_WORK_MODE_INT = 62,
134
138 OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT = 63,
139
143 OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL = 64,
144
149 OB_PROP_DEPTH_PRECISION_LEVEL_INT = 75,
150
154 OB_PROP_TOF_FILTER_RANGE_INT = 76,
155
159 OB_PROP_LASER_MODE_INT = 79,
160
164 OB_PROP_RECTIFY2_BOOL = 80,
165
169 OB_PROP_COLOR_MIRROR_BOOL = 81,
170
174 OB_PROP_COLOR_FLIP_BOOL = 82,
175
179 OB_PROP_INDICATOR_LIGHT_BOOL = 83,
180
184 OB_PROP_DISPARITY_TO_DEPTH_BOOL = 85,
185
189 OB_PROP_BRT_BOOL = 86,
190
194 OB_PROP_WATCHDOG_BOOL = 87,
195
199 OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL = 88,
200
204 OB_PROP_HEARTBEAT_BOOL = 89,
205
209 OB_PROP_DEPTH_CROPPING_MODE_INT = 90,
210
214 OB_PROP_D2C_PREPROCESS_BOOL = 91,
215
219 OB_PROP_RGB_CUSTOM_CROP_BOOL = 94,
220
224 OB_PROP_DEVICE_WORK_MODE_INT = 95,
225
229 OB_PROP_DEVICE_COMMUNICATION_TYPE_INT = 97,
230
234 OB_PROP_SWITCH_IR_MODE_INT = 98,
235
239 OB_PROP_LASER_POWER_LEVEL_CONTROL_INT = 99,
240
244 OB_PROP_LDP_MEASURE_DISTANCE_INT = 100,
245
249 OB_PROP_TIMER_RESET_SIGNAL_BOOL = 104,
250
254 OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL = 105,
255
259 OB_PROP_TIMER_RESET_DELAY_US_INT = 106,
260
264 OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL = 107,
265
269 OB_PROP_IR_RIGHT_MIRROR_BOOL = 112,
270
274 OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT = 113,
275
279 OB_PROP_IR_RIGHT_FLIP_BOOL = 114,
280
284 OB_PROP_COLOR_ROTATE_INT = 115,
285
289 OB_PROP_IR_ROTATE_INT = 116,
290
294 OB_PROP_IR_RIGHT_ROTATE_INT = 117,
295
299 OB_PROP_DEPTH_ROTATE_INT = 118,
300
305 OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT = 119,
306
310 OB_PROP_USB_POWER_STATE_INT = 121,
311
315 OB_PROP_DC_POWER_STATE_INT = 122,
316
322 OB_PROP_DEVICE_DEVELOPMENT_MODE_INT = 129,
323
327 OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL = 130,
328
333 OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL = 131,
334
340 OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL = 132,
341
345 OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL = 133,
346
350 OB_PROP_CAPTURE_INTERVAL_MODE_INT = 134,
351
355 OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT = 135,
356
360 OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT = 136,
361
362 /*
363 * @brief Timer reset function enable
364 */
365 OB_PROP_TIMER_RESET_ENABLE_BOOL = 140,
366
371 OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL = 141,
372
376 OB_PROP_DEVICE_REBOOT_DELAY_INT = 142,
377
381 OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL = 148,
382
386 OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL = 149,
387
391 OB_PROP_LASER_ALWAYS_ON_BOOL = 174,
392
397 OB_PROP_LASER_ON_OFF_PATTERN_INT = 175,
398
403 OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT = 176,
404
409 OB_PROP_LASER_CONTROL_INT = 182,
410
414 OB_PROP_IR_BRIGHTNESS_INT = 184,
415
419 OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL = 188,
420
424 OB_PROP_COLOR_AE_MAX_EXPOSURE_INT = 189,
425
429 OB_PROP_IR_AE_MAX_EXPOSURE_INT = 190,
430
434 OB_PROP_DISP_SEARCH_RANGE_MODE_INT = 191,
435
439 OB_PROP_CPU_TEMPERATURE_CALIBRATION_BOOL = 199,
440
444 OB_STRUCT_BASELINE_CALIBRATION_PARAM = 1002,
445
449 OB_STRUCT_DEVICE_TEMPERATURE = 1003,
450
454 OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL = 1024,
455
459 OB_STRUCT_DEVICE_SERIAL_NUMBER = 1035,
460
464 OB_STRUCT_DEVICE_TIME = 1037,
465
469 OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG = 1038,
470
474 OB_STRUCT_RGB_CROP_ROI = 1040,
475
479 OB_STRUCT_DEVICE_IP_ADDR_CONFIG = 1041,
480
484 OB_STRUCT_CURRENT_DEPTH_ALG_MODE = 1043,
485
489 OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST = 1045,
490
497 OB_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD = 1053,
498
505 OB_STRUCT_DEPTH_HDR_CONFIG = 1059,
506
511 OB_STRUCT_COLOR_AE_ROI = 1060,
512
518 OB_STRUCT_DEPTH_AE_ROI = 1061,
519
523 OB_STRUCT_ASIC_SERIAL_NUMBER = 1063,
524
528 OB_PROP_COLOR_AUTO_EXPOSURE_BOOL = 2000,
529
533 OB_PROP_COLOR_EXPOSURE_INT = 2001,
534
538 OB_PROP_COLOR_GAIN_INT = 2002,
539
543 OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL = 2003,
544
548 OB_PROP_COLOR_WHITE_BALANCE_INT = 2004,
549
553 OB_PROP_COLOR_BRIGHTNESS_INT = 2005,
554
558 OB_PROP_COLOR_SHARPNESS_INT = 2006,
559
563 OB_PROP_COLOR_SHUTTER_INT = 2007,
564
568 OB_PROP_COLOR_SATURATION_INT = 2008,
569
573 OB_PROP_COLOR_CONTRAST_INT = 2009,
574
578 OB_PROP_COLOR_GAMMA_INT = 2010,
579
583 OB_PROP_COLOR_ROLL_INT = 2011,
584
588 OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT = 2012,
589
593 OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT = 2013,
594
598 OB_PROP_COLOR_HUE_INT = 2014,
599
603 OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT = 2015,
604
608 OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL = 2016,
609
613 OB_PROP_DEPTH_EXPOSURE_INT = 2017,
614
618 OB_PROP_DEPTH_GAIN_INT = 2018,
619
623 OB_PROP_IR_AUTO_EXPOSURE_BOOL = 2025,
624
628 OB_PROP_IR_EXPOSURE_INT = 2026,
629
633 OB_PROP_IR_GAIN_INT = 2027,
634
638 OB_PROP_IR_CHANNEL_DATA_SOURCE_INT = 2028,
639
643 OB_PROP_DEPTH_RM_FILTER_BOOL = 2029,
644
648 OB_PROP_COLOR_MAXIMAL_GAIN_INT = 2030,
649
653 OB_PROP_COLOR_MAXIMAL_SHUTTER_INT = 2031,
654
658 OB_PROP_IR_SHORT_EXPOSURE_BOOL = 2032,
659
663 OB_PROP_COLOR_HDR_BOOL = 2034,
664
668 OB_PROP_IR_LONG_EXPOSURE_BOOL = 2035,
669
673 OB_PROP_SKIP_FRAME_BOOL = 2036,
674
678 OB_PROP_HDR_MERGE_BOOL = 2037,
679
683 OB_PROP_COLOR_FOCUS_INT = 2038,
684
688 OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL = 3004,
689
693 OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL = 3007,
694
698 OB_PROP_SDK_IR_FRAME_UNPACK_BOOL = 3008,
699
703 OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL = 3009,
704
708 OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL = 3010,
709
713 OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL = 3011,
714
718 OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL = 3012,
719
723 OB_PROP_SDK_DEPTH_RECTIFY_MG_FILTER_BOOL = 3013,
724
728 OB_PROP_DEPTH_INDUSTRY_MODE_INT = 3024,
729
733 OB_PROP_STREAM_PACK_UNIT_INT = 3025,
734
738 OB_RAW_DATA_CAMERA_CALIB_JSON_FILE = 4029,
739} OBPropertyID,
740 ob_property_id;
741
742// For backward compatibility
743#define OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL
744#define OB_PROP_LASER_ON_OFF_MODE_INT OB_PROP_LASER_ON_OFF_PATTERN_INT
745#define OB_PROP_LASER_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_LEVEL_CONTROL_INT
746#define OB_PROP_LASER_HW_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT
747#define OB_PROP_DEVICE_USB3_REPEAT_IDENTIFY_BOOL OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL
748#define OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_BOOL OB_PROP_DEPTH_SOFT_FILTER_BOOL
749
753 typedef enum OBPropertyType {
754 OB_BOOL_PROPERTY = 0,
755 OB_INT_PROPERTY = 1,
756 OB_FLOAT_PROPERTY = 2,
757 OB_STRUCT_PROPERTY = 3,
758} OBPropertyType,
759 ob_property_type;
760
764 typedef struct OBPropertyItem {
765 OBPropertyID id;
766 const char *name;
767 OBPropertyType type;
768 OBPermissionType permission;
769} OBPropertyItem, ob_property_item;
770
771#ifdef __cplusplus
772}
773#endif
774
775#endif // _OB_PROPERTY_H_
776#endif // OB_SENSOR_SDK_DEVELOPER
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
OBPermissionType
OBPermissionType
the permission type of api or property
Definition ObTypes.h:99
ob_property_item
struct OBPropertyItem ob_property_item
ob_property_type
enum OBPropertyType ob_property_type
OBPropertyType
OBPropertyType
The data type used to describe all property settings.
Definition Property.h:753
OB_INT_PROPERTY
@ OB_INT_PROPERTY
Definition Property.h:755
OB_STRUCT_PROPERTY
@ OB_STRUCT_PROPERTY
Definition Property.h:757
OB_FLOAT_PROPERTY
@ OB_FLOAT_PROPERTY
Definition Property.h:756
OB_BOOL_PROPERTY
@ OB_BOOL_PROPERTY
Definition Property.h:754
OBPropertyID
OBPropertyID
Enumeration value describing all attribute control commands of the device.
Definition Property.h:24
OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL
@ OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL
TOF exposure threshold range.
Definition Property.h:454
OB_PROP_LASER_BOOL
@ OB_PROP_LASER_BOOL
Laser switch.
Definition Property.h:33
OB_PROP_MIN_DEPTH_INT
@ OB_PROP_MIN_DEPTH_INT
Minimum depth threshold.
Definition Property.h:88
OB_PROP_DEPTH_HOLEFILTER_BOOL
@ OB_PROP_DEPTH_HOLEFILTER_BOOL
Depth Holefilter.
Definition Property.h:73
OB_PROP_DEVICE_DEVELOPMENT_MODE_INT
@ OB_PROP_DEVICE_DEVELOPMENT_MODE_INT
Device development mode switch, optional modes can refer to the definition in OBDeviceDevelopmentMode...
Definition Property.h:322
OB_PROP_IR_MIRROR_BOOL
@ OB_PROP_IR_MIRROR_BOOL
IR mirror.
Definition Property.h:78
OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL
@ OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL
Restore factory settings and factory parameters.
Definition Property.h:333
OB_PROP_COLOR_SHUTTER_INT
@ OB_PROP_COLOR_SHUTTER_INT
Color camera shutter adjustment.
Definition Property.h:563
OB_PROP_IR_BRIGHTNESS_INT
@ OB_PROP_IR_BRIGHTNESS_INT
IR brightness.
Definition Property.h:414
OB_PROP_COLOR_MAXIMAL_GAIN_INT
@ OB_PROP_COLOR_MAXIMAL_GAIN_INT
Color camera maximal gain.
Definition Property.h:648
OB_STRUCT_RGB_CROP_ROI
@ OB_STRUCT_RGB_CROP_ROI
RGB cropping ROI.
Definition Property.h:474
OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL
@ OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL
Enable send reset device time signal to other device. true: enable, false: disable.
Definition Property.h:254
OB_PROP_IR_ROTATE_INT
@ OB_PROP_IR_ROTATE_INT
IR/Left-IR sensor rotation, angle{0, 90, 180, 270}.
Definition Property.h:289
OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL
@ OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL
Enable or disable the device to retry USB2.0 re-identification when the device is connected to a USB2...
Definition Property.h:371
OB_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD
@ OB_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD
Device network static ip config record.
Definition Property.h:497
OB_PROP_CAPTURE_INTERVAL_MODE_INT
@ OB_PROP_CAPTURE_INTERVAL_MODE_INT
Capture interval mode, 0:time interval, 1:number interval.
Definition Property.h:350
OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL
@ OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL
Hardware distortion switch Rectify.
Definition Property.h:128
OB_PROP_COLOR_HUE_INT
@ OB_PROP_COLOR_HUE_INT
Color camera color tint.
Definition Property.h:598
OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL
@ OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL
Query whether the current device is running in recovery mode (read-only)
Definition Property.h:345
OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG
@ OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG
Multi-device synchronization mode and parameter configuration.
Definition Property.h:469
OB_PROP_IR_SHORT_EXPOSURE_BOOL
@ OB_PROP_IR_SHORT_EXPOSURE_BOOL
The enable/disable switch for IR short exposure function, supported only by a few devices.
Definition Property.h:658
OB_PROP_COLOR_HDR_BOOL
@ OB_PROP_COLOR_HDR_BOOL
Color camera HDR.
Definition Property.h:663
OB_PROP_COLOR_MAXIMAL_SHUTTER_INT
@ OB_PROP_COLOR_MAXIMAL_SHUTTER_INT
Color camera shutter gain.
Definition Property.h:653
OB_PROP_DEPTH_CROPPING_MODE_INT
@ OB_PROP_DEPTH_CROPPING_MODE_INT
Depth cropping mode device: OB_DEPTH_CROPPING_MODE.
Definition Property.h:209
OB_PROP_FAN_WORK_MODE_INT
@ OB_PROP_FAN_WORK_MODE_INT
Fan mode switch.
Definition Property.h:133
OB_STRUCT_CURRENT_DEPTH_ALG_MODE
@ OB_STRUCT_CURRENT_DEPTH_ALG_MODE
The current camera depth mode.
Definition Property.h:484
OB_PROP_LASER_ON_OFF_PATTERN_INT
@ OB_PROP_LASER_ON_OFF_PATTERN_INT
Laser on/off alternate mode, 0: off, 1: on-off alternate, 2: off-on alternate.
Definition Property.h:397
OB_PROP_D2C_PREPROCESS_BOOL
@ OB_PROP_D2C_PREPROCESS_BOOL
D2C preprocessing switch (such as RGB cropping), 0: off, 1: on.
Definition Property.h:214
OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT
@ OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT
Color camera brightness compensation.
Definition Property.h:593
OB_STRUCT_DEVICE_SERIAL_NUMBER
@ OB_STRUCT_DEVICE_SERIAL_NUMBER
get/set serial number
Definition Property.h:459
OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL
@ OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL
Depth data unpacking function switch (each open stream will be turned on by default,...
Definition Property.h:693
OB_PROP_COLOR_GAMMA_INT
@ OB_PROP_COLOR_GAMMA_INT
Color camera gamma adjustment.
Definition Property.h:578
OB_STRUCT_DEVICE_IP_ADDR_CONFIG
@ OB_STRUCT_DEVICE_IP_ADDR_CONFIG
Device IP address configuration.
Definition Property.h:479
OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT
@ OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT
soft filter maxSpeckleSize
Definition Property.h:113
OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL
@ OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL
Right IR frame data unpacking function switch (each current will be turned on by default,...
Definition Property.h:718
OB_PROP_SDK_DEPTH_RECTIFY_MG_FILTER_BOOL
@ OB_PROP_SDK_DEPTH_RECTIFY_MG_FILTER_BOOL
depth Margin Filter
Definition Property.h:723
OB_PROP_IR_GAIN_INT
@ OB_PROP_IR_GAIN_INT
Infrared camera gain adjustment (the depth camera will be set synchronously under some models of devi...
Definition Property.h:633
OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL
@ OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL
External signal trigger restart function switch, 0: Disable, 1: Enable.
Definition Property.h:199
OB_STRUCT_DEPTH_HDR_CONFIG
@ OB_STRUCT_DEPTH_HDR_CONFIG
Using to configure the depth sensor's HDR mode.
Definition Property.h:505
OB_PROP_USB_POWER_STATE_INT
@ OB_PROP_USB_POWER_STATE_INT
USB's power state, enum type: OBUSBPowerState.
Definition Property.h:310
OB_PROP_TOF_FILTER_RANGE_INT
@ OB_PROP_TOF_FILTER_RANGE_INT
tof filter range configuration
Definition Property.h:154
OB_PROP_COLOR_ROLL_INT
@ OB_PROP_COLOR_ROLL_INT
Color camera image rotation.
Definition Property.h:583
OB_PROP_COLOR_FOCUS_INT
@ OB_PROP_COLOR_FOCUS_INT
Color camera FOCUS.
Definition Property.h:683
OB_PROP_COLOR_CONTRAST_INT
@ OB_PROP_COLOR_CONTRAST_INT
Color camera contrast adjustment.
Definition Property.h:573
OB_PROP_DEPTH_GAIN_INT
@ OB_PROP_DEPTH_GAIN_INT
Depth camera gain adjustment (infrared cameras will be set synchronously under some models of devices...
Definition Property.h:618
OB_STRUCT_DEVICE_TIME
@ OB_STRUCT_DEVICE_TIME
get/set device time
Definition Property.h:464
OB_PROP_DEVICE_REBOOT_DELAY_INT
@ OB_PROP_DEVICE_REBOOT_DELAY_INT
Reboot device delay mode. Delay time unit: ms, range: [0, 8000).
Definition Property.h:376
OB_PROP_SDK_IR_FRAME_UNPACK_BOOL
@ OB_PROP_SDK_IR_FRAME_UNPACK_BOOL
IR data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12...
Definition Property.h:698
OB_PROP_WATCHDOG_BOOL
@ OB_PROP_WATCHDOG_BOOL
Watchdog function switch, 0: Disable, 1: Enable.
Definition Property.h:194
OB_PROP_BRT_BOOL
@ OB_PROP_BRT_BOOL
BRT function switch (anti-background interference), 0: Disable, 1: Enable.
Definition Property.h:189
OB_STRUCT_DEPTH_AE_ROI
@ OB_STRUCT_DEPTH_AE_ROI
Depth Sensor AE ROI configuration.
Definition Property.h:518
OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL
@ OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL
Query the status of laser overcurrent protection (read-only)
Definition Property.h:381
OB_PROP_COLOR_WHITE_BALANCE_INT
@ OB_PROP_COLOR_WHITE_BALANCE_INT
Color camera white balance adjustment.
Definition Property.h:548
OB_PROP_MAX_DEPTH_INT
@ OB_PROP_MAX_DEPTH_INT
Maximum depth threshold.
Definition Property.h:93
OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL
@ OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL
Left IR frame data unpacking function switch (each current will be turned on by default,...
Definition Property.h:713
OB_PROP_IR_AUTO_EXPOSURE_BOOL
@ OB_PROP_IR_AUTO_EXPOSURE_BOOL
Infrared camera auto exposure (depth camera will be set synchronously under some models of devices)
Definition Property.h:623
OB_PROP_IR_EXPOSURE_INT
@ OB_PROP_IR_EXPOSURE_INT
Infrared camera exposure adjustment (some models of devices will set the depth camera synchronously)
Definition Property.h:628
OB_PROP_HDR_MERGE_BOOL
@ OB_PROP_HDR_MERGE_BOOL
Depth HDR merge, true: on, false: off.
Definition Property.h:678
OB_PROP_FLOOD_BOOL
@ OB_PROP_FLOOD_BOOL
IR flood switch.
Definition Property.h:48
OB_PROP_TIMESTAMP_OFFSET_INT
@ OB_PROP_TIMESTAMP_OFFSET_INT
Timestamp adjustment.
Definition Property.h:123
OB_PROP_DEPTH_MAX_DIFF_INT
@ OB_PROP_DEPTH_MAX_DIFF_INT
soft filter maxdiff param
Definition Property.h:108
OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL
@ OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL
slave device sync status
Definition Property.h:419
OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT
@ OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT
Number frame to capture once a 'OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL' effect. range: [1,...
Definition Property.h:274
OB_PROP_FLOOD_LEVEL_INT
@ OB_PROP_FLOOD_LEVEL_INT
IR flood level.
Definition Property.h:53
OB_PROP_LDP_MEASURE_DISTANCE_INT
@ OB_PROP_LDP_MEASURE_DISTANCE_INT
LDP's measure distance, unit: mm.
Definition Property.h:244
OB_PROP_COLOR_ROTATE_INT
@ OB_PROP_COLOR_ROTATE_INT
Color sensor rotation, angle{0, 90, 180, 270}.
Definition Property.h:284
OB_PROP_DEPTH_EXPOSURE_INT
@ OB_PROP_DEPTH_EXPOSURE_INT
Depth camera exposure adjustment (infrared cameras will be set synchronously under some models of dev...
Definition Property.h:613
OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT
@ OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT
Get hardware laser power actual level which real state of laser element. OB_PROP_LASER_POWER_LEVEL_CO...
Definition Property.h:305
OB_PROP_LASER_POWER_LEVEL_CONTROL_INT
@ OB_PROP_LASER_POWER_LEVEL_CONTROL_INT
Laser power level.
Definition Property.h:239
OB_PROP_DEPTH_ROTATE_INT
@ OB_PROP_DEPTH_ROTATE_INT
Depth sensor rotation, angle{0, 90, 180, 270}.
Definition Property.h:299
OB_PROP_COLOR_AE_MAX_EXPOSURE_INT
@ OB_PROP_COLOR_AE_MAX_EXPOSURE_INT
Color AE max exposure.
Definition Property.h:424
OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL
@ OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL
Accel data conversion function switch (on by default)
Definition Property.h:703
OB_PROP_STREAM_PACK_UNIT_INT
@ OB_PROP_STREAM_PACK_UNIT_INT
"OpenNI device setting data stream packet size, such as DCW2.
Definition Property.h:733
OB_PROP_DC_POWER_STATE_INT
@ OB_PROP_DC_POWER_STATE_INT
DC's power state, enum type: OBDCPowerState.
Definition Property.h:315
OB_PROP_SKIP_FRAME_BOOL
@ OB_PROP_SKIP_FRAME_BOOL
Setting and getting the USB device frame skipping mode status, true: frame skipping mode,...
Definition Property.h:673
OB_PROP_LDP_STATUS_BOOL
@ OB_PROP_LDP_STATUS_BOOL
LDP status.
Definition Property.h:103
OB_PROP_TIMER_RESET_DELAY_US_INT
@ OB_PROP_TIMER_RESET_DELAY_US_INT
Delay to reset device time, unit: us.
Definition Property.h:259
OB_PROP_IR_RIGHT_FLIP_BOOL
@ OB_PROP_IR_RIGHT_FLIP_BOOL
Right IR sensor flip state. true: flip image, false: origin, default: false.
Definition Property.h:279
OB_PROP_COLOR_EXPOSURE_INT
@ OB_PROP_COLOR_EXPOSURE_INT
Color camera exposure adjustment.
Definition Property.h:533
OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT
@ OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT
Capture number interval.
Definition Property.h:360
OB_PROP_TIMER_RESET_ENABLE_BOOL
@ OB_PROP_TIMER_RESET_ENABLE_BOOL
Definition Property.h:365
OB_PROP_INDICATOR_LIGHT_BOOL
@ OB_PROP_INDICATOR_LIGHT_BOOL
Indicator switch, 0: Disable, 1: Enable.
Definition Property.h:179
OB_PROP_DISPARITY_TO_DEPTH_BOOL
@ OB_PROP_DISPARITY_TO_DEPTH_BOOL
Disparity to depth switch, false: switch to software disparity convert to depth, true: switch to hard...
Definition Property.h:184
OB_PROP_LASER_CURRENT_FLOAT
@ OB_PROP_LASER_CURRENT_FLOAT
Laser current (uint: mA)
Definition Property.h:43
OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT
@ OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT
Multi-resolution D2C mode.
Definition Property.h:138
OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT
@ OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT
Color Camera Power Line Frequency.
Definition Property.h:603
OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL
@ OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL
Software disparity to depth.
Definition Property.h:688
OB_PROP_IR_LONG_EXPOSURE_BOOL
@ OB_PROP_IR_LONG_EXPOSURE_BOOL
IR long exposure mode switch read and write.
Definition Property.h:668
OB_PROP_COLOR_GAIN_INT
@ OB_PROP_COLOR_GAIN_INT
Color camera gain adjustment.
Definition Property.h:538
OB_PROP_DEPTH_POSTFILTER_BOOL
@ OB_PROP_DEPTH_POSTFILTER_BOOL
Depth Postfilter.
Definition Property.h:68
OB_PROP_LDP_BOOL
@ OB_PROP_LDP_BOOL
LDP switch.
Definition Property.h:28
OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL
@ OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL
Signal to capture image.
Definition Property.h:264
OB_PROP_DEPTH_MIRROR_BOOL
@ OB_PROP_DEPTH_MIRROR_BOOL
Depth mirror.
Definition Property.h:58
OB_PROP_DEVICE_COMMUNICATION_TYPE_INT
@ OB_PROP_DEVICE_COMMUNICATION_TYPE_INT
Device communication type, 0: USB; 1: Ethernet(RTSP)
Definition Property.h:229
OB_PROP_IR_RIGHT_MIRROR_BOOL
@ OB_PROP_IR_RIGHT_MIRROR_BOOL
Right IR sensor mirror state.
Definition Property.h:269
OB_PROP_COLOR_BRIGHTNESS_INT
@ OB_PROP_COLOR_BRIGHTNESS_INT
Color camera brightness adjustment.
Definition Property.h:553
OB_PROP_IR_CHANNEL_DATA_SOURCE_INT
@ OB_PROP_IR_CHANNEL_DATA_SOURCE_INT
Select Infrared camera data source channel. If not support throw exception. 0 : IR stream from IR Lef...
Definition Property.h:638
OB_PROP_IR_RIGHT_ROTATE_INT
@ OB_PROP_IR_RIGHT_ROTATE_INT
Right IR sensor rotation, angle{0, 90, 180, 270}.
Definition Property.h:294
OB_PROP_LASER_PULSE_WIDTH_INT
@ OB_PROP_LASER_PULSE_WIDTH_INT
laser pulse width
Definition Property.h:38
OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL
@ OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL
Automatic exposure of depth camera (infrared camera will be set synchronously under some models of de...
Definition Property.h:608
OB_PROP_COLOR_SHARPNESS_INT
@ OB_PROP_COLOR_SHARPNESS_INT
Color camera sharpness adjustment.
Definition Property.h:558
OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL
@ OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL
Color camera automatic white balance.
Definition Property.h:543
OB_RAW_DATA_CAMERA_CALIB_JSON_FILE
@ OB_RAW_DATA_CAMERA_CALIB_JSON_FILE
Calibration JSON file read from device (Femto Mega, read only)
Definition Property.h:738
OB_PROP_LASER_ALWAYS_ON_BOOL
@ OB_PROP_LASER_ALWAYS_ON_BOOL
Laser always on, true: always on, false: off, laser will be turned off when out of exposure time.
Definition Property.h:391
OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT
@ OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT
Color camera auto exposure priority.
Definition Property.h:588
OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL
@ OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL
Anti_collusion activation status.
Definition Property.h:143
OB_PROP_DEPTH_PRECISION_LEVEL_INT
@ OB_PROP_DEPTH_PRECISION_LEVEL_INT
the depth precision level, which may change the depth frame data unit, needs to be confirmed through ...
Definition Property.h:149
OB_PROP_LASER_MODE_INT
@ OB_PROP_LASER_MODE_INT
laser mode, the firmware terminal currently only return 1: IR Drive, 2: Torch
Definition Property.h:159
OB_STRUCT_DEVICE_TEMPERATURE
@ OB_STRUCT_DEVICE_TEMPERATURE
Device temperature information.
Definition Property.h:449
OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL
@ OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL
Multi-DeviceSync synchronized signal trigger out is enable state. true: enable, false: disable.
Definition Property.h:327
OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT
@ OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT
Capture time interval.
Definition Property.h:355
OB_STRUCT_ASIC_SERIAL_NUMBER
@ OB_STRUCT_ASIC_SERIAL_NUMBER
ASIC serial number.
Definition Property.h:523
OB_PROP_DEPTH_INDUSTRY_MODE_INT
@ OB_PROP_DEPTH_INDUSTRY_MODE_INT
Depth Stream Industry Working Mode Settings, currently only supported by DCW2.
Definition Property.h:728
OB_PROP_TIMER_RESET_SIGNAL_BOOL
@ OB_PROP_TIMER_RESET_SIGNAL_BOOL
Reset device time to zero.
Definition Property.h:249
OB_PROP_LASER_CONTROL_INT
@ OB_PROP_LASER_CONTROL_INT
Laser control, 0: off, 1: on, 2: auto.
Definition Property.h:409
OB_PROP_COLOR_AUTO_EXPOSURE_BOOL
@ OB_PROP_COLOR_AUTO_EXPOSURE_BOOL
Color camera auto exposure.
Definition Property.h:528
OB_PROP_DEVICE_WORK_MODE_INT
@ OB_PROP_DEVICE_WORK_MODE_INT
Device operating mode (power consumption)
Definition Property.h:224
OB_PROP_RGB_CUSTOM_CROP_BOOL
@ OB_PROP_RGB_CUSTOM_CROP_BOOL
Custom RGB cropping switch, 0 is off, 1 is on custom cropping, and the ROI cropping area is issued.
Definition Property.h:219
OB_STRUCT_COLOR_AE_ROI
@ OB_STRUCT_COLOR_AE_ROI
Color Sensor AE ROI configuration.
Definition Property.h:511
OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL
@ OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL
Hardware d2c is on.
Definition Property.h:118
OB_STRUCT_BASELINE_CALIBRATION_PARAM
@ OB_STRUCT_BASELINE_CALIBRATION_PARAM
Baseline calibration parameters.
Definition Property.h:444
OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL
@ OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL
Enter recovery mode (flashing mode) when boot the device.
Definition Property.h:340
OB_PROP_HEARTBEAT_BOOL
@ OB_PROP_HEARTBEAT_BOOL
Heartbeat monitoring function switch, 0: Disable, 1: Enable.
Definition Property.h:204
OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL
@ OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL
Gyro data conversion function switch (on by default)
Definition Property.h:708
OB_PROP_IR_FLIP_BOOL
@ OB_PROP_IR_FLIP_BOOL
IR flip.
Definition Property.h:83
OB_PROP_DEPTH_SOFT_FILTER_BOOL
@ OB_PROP_DEPTH_SOFT_FILTER_BOOL
Software filter switch.
Definition Property.h:98
OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT
@ OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT
Depth unit flexible adjustment.
Definition Property.h:403
OB_PROP_RECTIFY2_BOOL
@ OB_PROP_RECTIFY2_BOOL
brt2r-rectify function switch (brt2r is a special module on mx6600), 0: Disable, 1: Rectify Enable
Definition Property.h:164
OB_PROP_CPU_TEMPERATURE_CALIBRATION_BOOL
@ OB_PROP_CPU_TEMPERATURE_CALIBRATION_BOOL
cpu temperature correction . true: calibrate temperature
Definition Property.h:439
OB_PROP_SWITCH_IR_MODE_INT
@ OB_PROP_SWITCH_IR_MODE_INT
Switch infrared imaging mode, 0: active IR mode, 1: passive IR mode.
Definition Property.h:234
OB_PROP_DISP_SEARCH_RANGE_MODE_INT
@ OB_PROP_DISP_SEARCH_RANGE_MODE_INT
disparity search range mode
Definition Property.h:434
OB_PROP_COLOR_FLIP_BOOL
@ OB_PROP_COLOR_FLIP_BOOL
Color flip.
Definition Property.h:174
OB_PROP_COLOR_MIRROR_BOOL
@ OB_PROP_COLOR_MIRROR_BOOL
Color mirror.
Definition Property.h:169
OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST
@ OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST
A list of depth accuracy levels, returning an array of uin16_t, corresponding to the enumeration.
Definition Property.h:489
OB_PROP_COLOR_SATURATION_INT
@ OB_PROP_COLOR_SATURATION_INT
Color camera saturation adjustment.
Definition Property.h:568
OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL
@ OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL
Query the status of laser pulse width protection (read-only)
Definition Property.h:386
OB_PROP_DEPTH_RM_FILTER_BOOL
@ OB_PROP_DEPTH_RM_FILTER_BOOL
Depth effect dedistortion, true: on, false: off. mutually exclusive with D2C function,...
Definition Property.h:643
OB_PROP_IR_AE_MAX_EXPOSURE_INT
@ OB_PROP_IR_AE_MAX_EXPOSURE_INT
IR AE max exposure.
Definition Property.h:429
OB_PROP_DEPTH_FLIP_BOOL
@ OB_PROP_DEPTH_FLIP_BOOL
Depth flip.
Definition Property.h:63
ob_property_id
enum OBPropertyID ob_property_id
OBPropertyItem
Used to describe the characteristics of each property.
Definition Property.h:764
OBPropertyItem::permission
OBPermissionType permission
Definition Property.h:768
OBPropertyItem::type
OBPropertyType type
Definition Property.h:767
OBPropertyItem::id
OBPropertyID id
Definition Property.h:765
OBPropertyItem::name
const char * name
Definition Property.h:766