OrbbecSDK  1.5.7
OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices
Classes | Macros | Typedefs | Enumerations
Property.h File Reference

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...
 

Macros

#define _OB_PROPERTY_H_
 

Typedefs

typedef enum OBPropertyID ob_property_id
 
typedef enum OBPropertyType OBPropertyType
 The data type used to describe all property settings. More...
 
typedef enum OBPropertyType ob_property_type
 
typedef struct OBPropertyItem OBPropertyItem
 Used to describe the characteristics of each property. More...
 
typedef struct OBPropertyItem ob_property_item
 

Enumerations

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
}
 Enumeration value describing all attribute control commands of the device. More...
 
enum  OBPropertyType { OB_BOOL_PROPERTY = 0, OB_INT_PROPERTY = 1, OB_FLOAT_PROPERTY = 2, OB_STRUCT_PROPERTY = 3 }
 The data type used to describe all property settings. More...
 

Detailed Description

Control command property list maintenance.

Definition in file Property.h.

Macro Definition Documentation

#define _OB_PROPERTY_H_

Definition at line 18 of file Property.h.

Typedef Documentation

The data type used to describe all property settings.

Used to describe the characteristics of each property.

Enumeration Type Documentation

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 

Read and write laser Time value (pulse width)

OB_PROP_LASER_CURRENT_FLOAT 

Laser current

OB_PROP_FLOOD_BOOL 

IR flood switch

OB_PROP_FLOOD_LEVEL_INT 

IR flood level

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_SOFT_FILTER_BOOL 

Software filter switch

OB_PROP_LDP_STATUS_BOOL 

LDP status

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 

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 returns 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, 0: off, the depth stream outputs the disparity map; 1. On, the depth stream outputs the depth map.

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_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 IR mode, 0: IR active mode, 1: IR passive mode

OB_PROP_LASER_ENERGY_LEVEL_INT 

Laser energy 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_TRIGGLE_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_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 

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 

Config device's IP address

OB_STRUCT_CURRENT_DEPTH_ALG_MODE 

Current depth work mode state

OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST 

List of depth precision level, return: uint16_t array, unit16_t is value of enum OBDepthPrecisionLevel

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_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_GYRO_ODR_INT 

get/set current gyro sample rate

OB_PROP_ACCEL_ODR_INT 

get/set current accel sample rate

OB_PROP_GYRO_FULL_SCALE_INT 

get/set current gyro full scale range

OB_PROP_ACCEL_FULL_SCALE_INT 

get/set current accel full scale range

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 Left sensor;

OB_PROP_DEPTH_RM_FILTER_BOOL 

深度效果去畸变, true:打开,false:关闭, 与D2C功能互斥。软硬件D2C开启时,不能使用mask功能

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数据转换功能开关(默认打开)

OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL 

Gyro数据转换功能开关(默认打开)

OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL 

left IR data unpacking function switch (each open stream will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format)

OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL 

right IR data unpacking function switch (each open stream will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format)

OB_RAW_DATA_CAMERA_CALIB_JSON_FILE 

从设备端读取的标定Json文件(Femto Mega, read only)

Definition at line 33 of file Property.h.

The data type used to describe all property settings.

Enumerator
OB_BOOL_PROPERTY 

Bool property

OB_INT_PROPERTY 

int property

OB_FLOAT_PROPERTY 

float property

OB_STRUCT_PROPERTY 

struct property

Definition at line 174 of file Property.h.