Property.h

Go to the documentation of this file.

// License: Apache 2.0. See LICENSE file in root directory.
// Copyright(c) 2020 Orbbec  Corporation. All Rights Reserved.
 
#ifdef OB_SENSOR_SDK_DEVELOPER
#include "libobsensor/internal/InternalProperty.h"
#else  // not define OB_SENSOR_SDK_DEVELOPER
#ifndef _OB_PROPERTY_H_
#define _OB_PROPERTY_H_
 
#include "ObTypes.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    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 = 75,
 
    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 = 85,
 
    OB_PROP_BRT_BOOL = 86,
 
    OB_PROP_WATCHDOG_BOOL = 87,
 
    OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL = 88,
 
    OB_PROP_HEARTBEAT_BOOL = 89,
 
    OB_PROP_DEPTH_CROPPING_MODE_INT = 90,
 
    OB_PROP_D2C_PREPROCESS_BOOL = 91,
 
    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_POWER_LEVEL_CONTROL_INT = 99,
 
    OB_PROP_LDP_MEASURE_DISTANCE_INT = 100,
 
    OB_PROP_TIMER_RESET_SIGNAL_BOOL = 104,
 
    OB_PROP_TIMER_RESET_TRIGGER_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_POWER_ACTUAL_LEVEL_INT = 119,
 
    OB_PROP_USB_POWER_STATE_INT = 121,
 
    OB_PROP_DC_POWER_STATE_INT = 122,
 
    OB_PROP_DEVICE_DEVELOPMENT_MODE_INT = 129,
 
    OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL = 130,
 
    OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL = 131,
 
    OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL = 132,
 
    OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL = 133,
 
    OB_PROP_CAPTURE_INTERVAL_MODE_INT = 134,
 
    OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT = 135,
 
    OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT = 136,
 
    /*
     * @brief Timer reset function enable
     */
    OB_PROP_TIMER_RESET_ENABLE_BOOL = 140,
 
    OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL = 141,
 
    OB_PROP_DEVICE_REBOOT_DELAY_INT = 142,
 
    OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL = 148,
 
    OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL = 149,
 
    OB_PROP_LASER_ALWAYS_ON_BOOL = 174,
 
    OB_PROP_LASER_ON_OFF_PATTERN_INT = 175,
 
    OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT = 176,
 
    OB_PROP_LASER_CONTROL_INT = 182,
 
    OB_PROP_IR_BRIGHTNESS_INT = 184,
 
    OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL = 188,
 
    OB_PROP_COLOR_AE_MAX_EXPOSURE_INT = 189,
 
    OB_PROP_IR_AE_MAX_EXPOSURE_INT = 190,
 
    OB_PROP_DISP_SEARCH_RANGE_MODE_INT = 191,
 
    OB_PROP_CPU_TEMPERATURE_CALIBRATION_BOOL = 199,
 
    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 = 1038,
 
    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_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD = 1053,
 
    OB_STRUCT_DEPTH_HDR_CONFIG = 1059,
 
    OB_STRUCT_COLOR_AE_ROI = 1060,
 
    OB_STRUCT_DEPTH_AE_ROI = 1061,
 
    OB_STRUCT_ASIC_SERIAL_NUMBER = 1063,
 
    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_SHUTTER_INT = 2007,
 
    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_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_COLOR_MAXIMAL_GAIN_INT = 2030,
 
    OB_PROP_COLOR_MAXIMAL_SHUTTER_INT = 2031,
 
    OB_PROP_IR_SHORT_EXPOSURE_BOOL = 2032,
 
    OB_PROP_COLOR_HDR_BOOL = 2034,
 
    OB_PROP_IR_LONG_EXPOSURE_BOOL = 2035,
 
    OB_PROP_SKIP_FRAME_BOOL = 2036,
 
    OB_PROP_HDR_MERGE_BOOL = 2037,
 
    OB_PROP_COLOR_FOCUS_INT = 2038,
 
    OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL = 3004,
 
    OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL = 3007,
 
    OB_PROP_SDK_IR_FRAME_UNPACK_BOOL = 3008,
 
    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_PROP_SDK_DEPTH_RECTIFY_MG_FILTER_BOOL = 3013,
 
    OB_PROP_DEPTH_INDUSTRY_MODE_INT = 3024,
 
    OB_PROP_STREAM_PACK_UNIT_INT = 3025,
 
    OB_RAW_DATA_CAMERA_CALIB_JSON_FILE = 4029,
} OBPropertyID,
    ob_property_id;
 
// For backward compatibility
#define OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL
#define OB_PROP_LASER_ON_OFF_MODE_INT OB_PROP_LASER_ON_OFF_PATTERN_INT
#define OB_PROP_LASER_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_LEVEL_CONTROL_INT
#define OB_PROP_LASER_HW_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT
#define OB_PROP_DEVICE_USB3_REPEAT_IDENTIFY_BOOL OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL
#define OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_BOOL OB_PROP_DEPTH_SOFT_FILTER_BOOL
 
typedef enum OBPropertyType {
    OB_BOOL_PROPERTY   = 0, 
    OB_INT_PROPERTY    = 1, 
    OB_FLOAT_PROPERTY  = 2, 
    OB_STRUCT_PROPERTY = 3, 
} OBPropertyType,
    ob_property_type;
 
typedef struct OBPropertyItem {
    OBPropertyID     id;         
    const char      *name;       
    OBPropertyType   type;       
    OBPermissionType permission; 
} OBPropertyItem, ob_property_item;
 
#ifdef __cplusplus
}
#endif
 
#endif  // _OB_PROPERTY_H_
#endif  // OB_SENSOR_SDK_DEVELOPER