 |
OrbbecSDK 2.5.5
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
|
Loading...
Searching...
No Matches
|
OrbbecSDK 2.5.5
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
|
Control command property list maintenance. More...
#include "ObTypes.h"Go to the source code of this file.
Classes | |
| struct | OBPropertyItem |
| Used to describe the characteristics of each property. More... | |
Typedefs | |
| typedef enum OBPropertyID | ob_property_id |
| typedef enum OBPropertyType | OBPropertyType |
| The data type used to describe all property settings. | |
| typedef enum OBPropertyType | ob_property_type |
| typedef struct OBPropertyItem | OBPropertyItem |
| Used to describe the characteristics of each property. | |
| typedef struct OBPropertyItem | ob_property_item |
Control command property list maintenance.
Definition in file Property.h.
| #define OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL |
Definition at line 887 of file Property.h.
| #define OB_PROP_LASER_ON_OFF_MODE_INT OB_PROP_LASER_ON_OFF_PATTERN_INT |
Definition at line 888 of file Property.h.
| #define OB_PROP_LASER_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_LEVEL_CONTROL_INT |
Definition at line 889 of file Property.h.
| #define OB_PROP_LASER_HW_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT |
Definition at line 890 of file Property.h.
| #define OB_PROP_DEVICE_USB3_REPEAT_IDENTIFY_BOOL OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL |
Definition at line 891 of file Property.h.
| #define OB_PROP_DEPTH_SOFT_FILTER_BOOL OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_BOOL |
Definition at line 892 of file Property.h.
| #define OB_PROP_DEPTH_MAX_DIFF_INT OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_MAX_DIFF_INT |
Definition at line 893 of file Property.h.
| #define OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_MAX_SPECKLE_SIZE_INT |
Definition at line 894 of file Property.h.
| typedef enum OBPropertyID ob_property_id |
| typedef enum OBPropertyType OBPropertyType |
The data type used to describe all property settings.
| typedef enum OBPropertyType ob_property_type |
| typedef struct OBPropertyItem OBPropertyItem |
Used to describe the characteristics of each property.
| typedef struct OBPropertyItem ob_property_item |
| enum OBPropertyID |
Enumeration value describing all attribute control commands of the device.
| Enumerator | |
|---|---|
| OB_PROP_LDP_BOOL | LDP switch. |
| OB_PROP_LASER_BOOL | Laser switch. |
| OB_PROP_LASER_PULSE_WIDTH_INT | laser pulse width |
| OB_PROP_LASER_CURRENT_FLOAT | Laser current (uint: mA) |
| OB_PROP_FLOOD_BOOL | IR flood switch. |
| OB_PROP_FLOOD_LEVEL_INT | IR flood level. |
| OB_PROP_TEMPERATURE_COMPENSATION_BOOL | Enable/disable temperature compensation. |
| OB_PROP_DEPTH_MIRROR_BOOL | Depth mirror. |
| OB_PROP_DEPTH_FLIP_BOOL | Depth flip. |
| OB_PROP_DEPTH_POSTFILTER_BOOL | Depth Postfilter. |
| OB_PROP_DEPTH_HOLEFILTER_BOOL | Depth Holefilter. |
| OB_PROP_IR_MIRROR_BOOL | IR mirror. |
| OB_PROP_IR_FLIP_BOOL | IR flip. |
| OB_PROP_MIN_DEPTH_INT | Minimum depth threshold. |
| OB_PROP_MAX_DEPTH_INT | Maximum depth threshold. |
| OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_BOOL | Software filter switch. |
| OB_PROP_LDP_STATUS_BOOL | LDP status. |
| OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_MAX_DIFF_INT | maxdiff for depth noise removal filter |
| OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_MAX_SPECKLE_SIZE_INT | maxSpeckleSize for depth noise removal filter |
| OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL | Hardware d2c is on. |
| OB_PROP_TIMESTAMP_OFFSET_INT | Timestamp adjustment. |
| OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL | Hardware distortion switch Rectify. |
| OB_PROP_FAN_WORK_MODE_INT | Fan mode switch. |
| OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT | Multi-resolution D2C mode. |
| OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL | Anti_collusion activation status. |
| OB_PROP_DEPTH_PRECISION_LEVEL_INT | the depth precision level, which may change the depth frame data unit, needs to be confirmed through the ValueScale interface of DepthFrame |
| OB_PROP_TOF_FILTER_RANGE_INT | tof filter range configuration |
| OB_PROP_LASER_MODE_INT | laser mode, the firmware terminal currently only return 1: IR Drive, 2: Torch |
| OB_PROP_RECTIFY2_BOOL | brt2r-rectify function switch (brt2r is a special module on mx6600), 0: Disable, 1: Rectify Enable |
| OB_PROP_COLOR_MIRROR_BOOL | Color mirror. |
| OB_PROP_COLOR_FLIP_BOOL | Color flip. |
| OB_PROP_INDICATOR_LIGHT_BOOL | Indicator switch, 0: Disable, 1: Enable. |
| OB_PROP_DISPARITY_TO_DEPTH_BOOL | Disparity to depth switch, false: switch to software disparity convert to depth, true: switch to hardware disparity convert to depth. |
| OB_PROP_BRT_BOOL | BRT function switch (anti-background interference), 0: Disable, 1: Enable. |
| OB_PROP_WATCHDOG_BOOL | Watchdog function switch, 0: Disable, 1: Enable. |
| OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL | External signal trigger restart function switch, 0: Disable, 1: Enable. |
| OB_PROP_HEARTBEAT_BOOL | Heartbeat monitoring function switch, 0: Disable, 1: Enable. |
| OB_PROP_DEPTH_CROPPING_MODE_INT | Depth cropping mode device: OB_DEPTH_CROPPING_MODE. |
| OB_PROP_D2C_PREPROCESS_BOOL | D2C preprocessing switch (such as RGB cropping), 0: off, 1: on. |
| OB_PROP_GPM_BOOL | Enable/disable GPM function. |
| 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. |
| OB_PROP_DEVICE_WORK_MODE_INT | Device operating mode (power consumption) |
| OB_PROP_DEVICE_COMMUNICATION_TYPE_INT | Device communication type, 0: USB; 1: Ethernet(RTSP) |
| OB_PROP_SWITCH_IR_MODE_INT | Switch infrared imaging mode, 0: active IR mode, 1: passive IR mode. |
| OB_PROP_LASER_POWER_LEVEL_CONTROL_INT | Laser power level. |
| OB_PROP_LDP_MEASURE_DISTANCE_INT | LDP's measure distance, unit: mm. |
| OB_PROP_TIMER_RESET_SIGNAL_BOOL | Reset device time to zero. |
| OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL | Enable send reset device time signal to other device. true: enable, false: disable. |
| OB_PROP_TIMER_RESET_DELAY_US_INT | Delay to reset device time, unit: us. |
| OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL | Signal to capture image. |
| OB_PROP_IR_RIGHT_MIRROR_BOOL | Right IR sensor mirror state. |
| OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT | Number frame to capture once a 'OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL' effect. range: [1, 255]. |
| OB_PROP_IR_RIGHT_FLIP_BOOL | Right IR sensor flip state. true: flip image, false: origin, default: false. |
| OB_PROP_COLOR_ROTATE_INT | Color sensor rotation, angle{0, 90, 180, 270}. |
| OB_PROP_IR_ROTATE_INT | IR/Left-IR sensor rotation, angle{0, 90, 180, 270}. |
| OB_PROP_IR_RIGHT_ROTATE_INT | Right IR sensor rotation, angle{0, 90, 180, 270}. |
| OB_PROP_DEPTH_ROTATE_INT | Depth sensor rotation, angle{0, 90, 180, 270}. |
| OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT | Get hardware laser power actual level which real state of laser element. OB_PROP_LASER_POWER_LEVEL_CONTROL_INT99 will effect this command which it setting and changed the hardware laser energy level. |
| OB_PROP_USB_POWER_STATE_INT | USB's power state, enum type: OBUSBPowerState. |
| OB_PROP_DC_POWER_STATE_INT | DC's power state, enum type: OBDCPowerState. |
| OB_PROP_DEVICE_DEVELOPMENT_MODE_INT | Device development mode switch, optional modes can refer to the definition in OBDeviceDevelopmentMode,the default mode is OB_USER_MODE.
|
| OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL | Multi-DeviceSync synchronized signal trigger out is enable state. true: enable, false: disable. |
| OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL | Restore factory settings and factory parameters.
|
| OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL | Enter recovery mode (flashing mode) when boot the device.
|
| OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL | Query whether the current device is running in recovery mode (read-only) |
| OB_PROP_CAPTURE_INTERVAL_MODE_INT | Capture interval mode, 0:time interval, 1:number interval. |
| OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT | Capture time interval. |
| OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT | Capture number interval. |
| OB_PROP_TIMER_RESET_ENABLE_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.0 port. This feature ensures that the device is not mistakenly identified as a USB 2.0 device when connected to a USB 3.0 port. |
| OB_PROP_DEVICE_REBOOT_DELAY_INT | Reboot device delay mode. Delay time unit: ms, range: [0, 8000). |
| OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL | Query the status of laser overcurrent protection (read-only) |
| OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL | Query the status of laser pulse width protection (read-only) |
| OB_PROP_LASER_ALWAYS_ON_BOOL | Laser always on, true: always on, false: off, laser will be turned off when out of exposure time. |
| OB_PROP_LASER_ON_OFF_PATTERN_INT | Laser on/off alternate mode, 0: off, 1: on-off alternate, 2: off-on alternate.
|
| OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT | Depth unit flexible adjustment. This property allows continuous adjustment of the depth unit, unlike OB_PROP_DEPTH_PRECISION_LEVEL_INT must be set to some fixed value. |
| OB_PROP_LASER_CONTROL_INT | Laser control, 0: off, 1: on, 2: auto. |
| OB_PROP_IR_BRIGHTNESS_INT | IR brightness. |
| OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL | Slave/secondary device synchronization status (read-only) |
| OB_PROP_COLOR_AE_MAX_EXPOSURE_INT | Color AE max exposure. |
| OB_PROP_IR_AE_MAX_EXPOSURE_INT | Max exposure time of IR auto exposure. |
| OB_PROP_DISP_SEARCH_RANGE_MODE_INT | Disparity search range mode, 1: 128, 2: 256. |
| OB_PROP_LASER_HIGH_TEMPERATURE_PROTECT_BOOL | Laser high temperature protection. |
| OB_PROP_LOW_EXPOSURE_LASER_CONTROL_BOOL | low exposure laser control Currently using for DabaiA device,if the exposure value is lower than a certain threshold, the laser is turned off; if it exceeds another threshold, the laser is turned on again. |
| OB_PROP_CHECK_PPS_SYNC_IN_SIGNAL_BOOL | check pps sync in signal |
| OB_PROP_DISP_SEARCH_OFFSET_INT | Disparity search range offset, range: [0, 127]. |
| OB_PROP_DEVICE_REPOWER_BOOL | Repower device (cut off power and power on again) Currently using for GMSL device, cut off power and power on again by GMSL host driver. |
| OB_PROP_FRAME_INTERLEAVE_CONFIG_INDEX_INT | frame interleave config index |
| OB_PROP_FRAME_INTERLEAVE_ENABLE_BOOL | frame interleave enable (true:enable,false:disable) |
| OB_PROP_FRAME_INTERLEAVE_LASER_PATTERN_SYNC_DELAY_INT | laser pattern sync with delay(us) |
| OB_PROP_ON_CHIP_CALIBRATION_HEALTH_CHECK_FLOAT | Get the health check result from device,range is [0.0f,1.5f]. |
| OB_PROP_ON_CHIP_CALIBRATION_ENABLE_BOOL | Enable or disable on-chip calibration. |
| OB_PROP_HW_NOISE_REMOVE_FILTER_ENABLE_BOOL | hardware noise remove filter switch |
| OB_PROP_HW_NOISE_REMOVE_FILTER_THRESHOLD_FLOAT | hardware noise remove filter threshold ,range [0.0 - 1.0] |
| OB_DEVICE_AUTO_CAPTURE_ENABLE_BOOL | soft trigger auto capture enable, use in OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING mode |
| OB_DEVICE_AUTO_CAPTURE_INTERVAL_TIME_INT | soft trigger auto capture interval time, use in OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING mode |
| OB_DEVICE_PTP_CLOCK_SYNC_ENABLE_BOOL | PTP time synchronization enable. |
| OB_PROP_DEPTH_WITH_CONFIDENCE_STREAM_ENABLE_BOOL | Depth with confidence stream enable. |
| OB_PROP_CONFIDENCE_STREAM_FILTER_BOOL | Enable or disable confidence stream filter. |
| OB_PROP_CONFIDENCE_STREAM_FILTER_THRESHOLD_INT | Confidence stream filter threshold, range [0, 255]. |
| OB_PROP_CONFIDENCE_MIRROR_BOOL | Confidence stream mirror enable. |
| OB_PROP_CONFIDENCE_FLIP_BOOL | Confidence stream flip enable. |
| OB_PROP_CONFIDENCE_ROTATE_INT | Confidence stream rotate angle{0, 90, 180, 270}. |
| OB_PROP_INTRA_CAMERA_SYNC_REFERENCE_INT | Intra-camera Sync Reference based on the exposure start time, the exposure middle time, or the exposure end time. the definition in OBIntraCameraSyncReference. |
| OB_STRUCT_BASELINE_CALIBRATION_PARAM | Baseline calibration parameters. |
| OB_STRUCT_DEVICE_TEMPERATURE | Device temperature information. |
| OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL | TOF exposure threshold range. |
| OB_STRUCT_DEVICE_SERIAL_NUMBER | get/set serial number |
| OB_STRUCT_DEVICE_TIME | get/set device time |
| OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG | Multi-device synchronization mode and parameter configuration. |
| OB_STRUCT_RGB_CROP_ROI | RGB cropping ROI. |
| OB_STRUCT_DEVICE_IP_ADDR_CONFIG | Device IP address configuration. |
| OB_STRUCT_CURRENT_DEPTH_ALG_MODE | The current camera depth mode. |
| OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST | A list of depth accuracy levels, returning an array of uin16_t, corresponding to the enumeration. |
| OB_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD | Device network static ip config record. Using for get last static ip config, witch is record in device flash when user set static ip config
|
| OB_STRUCT_DEPTH_HDR_CONFIG | Using to configure the depth sensor's HDR mode. The Value type is OBHdrConfig
|
| OB_STRUCT_COLOR_AE_ROI | Color Sensor AE ROI configuration. The Value type is OBRegionOfInterest |
| OB_STRUCT_DEPTH_AE_ROI | Depth Sensor AE ROI configuration. The Value type is OBRegionOfInterest Since the ir sensor is the same physical sensor as the depth sensor, this property will also effect the ir sensor. |
| OB_STRUCT_ASIC_SERIAL_NUMBER | ASIC serial number. |
| OB_STRUCT_DISP_OFFSET_CONFIG | Disparity offset interleaving. |
| OB_STRUCT_PRESET_RESOLUTION_CONFIG | Preset resolution ratio configuration. |
| OB_PROP_COLOR_AUTO_EXPOSURE_BOOL | Color camera auto exposure. |
| OB_PROP_COLOR_EXPOSURE_INT | Color camera exposure adjustment. |
| OB_PROP_COLOR_GAIN_INT | Color camera gain adjustment. |
| OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL | Color camera automatic white balance. |
| OB_PROP_COLOR_WHITE_BALANCE_INT | Color camera white balance adjustment. |
| OB_PROP_COLOR_BRIGHTNESS_INT | Color camera brightness adjustment. |
| OB_PROP_COLOR_SHARPNESS_INT | Color camera sharpness adjustment. |
| OB_PROP_COLOR_SHUTTER_INT | Color camera shutter adjustment. |
| OB_PROP_COLOR_SATURATION_INT | Color camera saturation adjustment. |
| OB_PROP_COLOR_CONTRAST_INT | Color camera contrast adjustment. |
| OB_PROP_COLOR_GAMMA_INT | Color camera gamma adjustment. |
| OB_PROP_COLOR_ROLL_INT | Color camera image rotation. |
| OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT | Color camera auto exposure priority. |
| OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT | Color camera brightness compensation. |
| OB_PROP_COLOR_HUE_INT | Color camera color tint. |
| OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT | Color Camera Power Line Frequency. |
| OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL | Automatic exposure of depth camera (infrared camera will be set synchronously under some models of devices) |
| OB_PROP_DEPTH_EXPOSURE_INT | Depth camera exposure adjustment (infrared cameras will be set synchronously under some models of devices) |
| OB_PROP_DEPTH_GAIN_INT | Depth camera gain adjustment (infrared cameras will be set synchronously under some models of devices) |
| OB_PROP_IR_AUTO_EXPOSURE_BOOL | Infrared camera auto exposure (depth camera will be set synchronously under some models of devices) |
| OB_PROP_IR_EXPOSURE_INT | Infrared camera exposure adjustment (some models of devices will set the depth camera synchronously) |
| OB_PROP_IR_GAIN_INT | Infrared camera gain adjustment (the depth camera will be set synchronously under some models of devices) |
| OB_PROP_IR_CHANNEL_DATA_SOURCE_INT | Select Infrared camera data source channel. If not support throw exception. 0 : IR stream from IR Left sensor; 1 : IR stream from IR Right sensor;. |
| OB_PROP_DEPTH_RM_FILTER_BOOL | Depth effect dedistortion, true: on, false: off. mutually exclusive with D2C function, RM_Filter disable When hardware or software D2C is enabled. |
| OB_PROP_COLOR_MAXIMAL_GAIN_INT | Color camera maximal gain. |
| OB_PROP_COLOR_MAXIMAL_SHUTTER_INT | Color camera shutter gain. |
| OB_PROP_IR_SHORT_EXPOSURE_BOOL | The enable/disable switch for IR short exposure function, supported only by a few devices. |
| OB_PROP_COLOR_HDR_BOOL | Color camera HDR. |
| OB_PROP_IR_LONG_EXPOSURE_BOOL | IR long exposure mode switch read and write. |
| OB_PROP_SKIP_FRAME_BOOL | Setting and getting the USB device frame skipping mode status, true: frame skipping mode, false: non-frame skipping mode. |
| OB_PROP_HDR_MERGE_BOOL | Depth HDR merge, true: on, false: off. |
| OB_PROP_COLOR_FOCUS_INT | Color camera FOCUS. |
| OB_PROP_IR_RECTIFY_BOOL | ir rectify status,true: ir rectify, false: no rectify |
| OB_PROP_DEPTH_AUTO_EXPOSURE_PRIORITY_INT | Depth camera priority. |
| OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL | Software disparity to depth. |
| OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL | Depth data unpacking function switch (each open stream will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) |
| 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/Y14 format) |
| OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL | Accel data conversion function switch (on by default) |
| OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL | Gyro data conversion function switch (on by default) |
| OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL | Left IR frame data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) |
| OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL | Right IR frame data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) |
| OB_PROP_DEPTH_INDUSTRY_MODE_INT | Depth Stream Industry Working Mode Settings, currently only supported by DCW2. |
| OB_PROP_NETWORK_BANDWIDTH_TYPE_INT | Read the current network bandwidth type of the network device, whether it is Gigabit Ethernet or Fast Ethernet, such as G335LE. |
| OB_PROP_DEVICE_PERFORMANCE_MODE_INT | Switch device performance mode, currently available in Adaptive Mode and High Performance Mode, such as G335LE. |
| OB_RAW_DATA_CAMERA_CALIB_JSON_FILE | Calibration JSON file read from device (Femto Mega, read only) |
| OB_PROP_DEBUG_ESGM_CONFIDENCE_FLOAT | Confidence degree. |
| OB_PROP_COLOR_DENOISING_LEVEL_INT | Color camera CCI denoising level. 0: Auto; 1-8: higher values indicate stronger denoising.
|
Definition at line 20 of file Property.h.
| enum OBPropertyType |
The data type used to describe all property settings.
| Enumerator | |
|---|---|
| OB_BOOL_PROPERTY | Boolean property |
| OB_INT_PROPERTY | Integer property |
| OB_FLOAT_PROPERTY | Floating-point property |
| OB_STRUCT_PROPERTY | Struct property |
Definition at line 899 of file Property.h.
1.14.0