OrbbecSDK 2.5.5
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Loading...
Searching...
No Matches
ObTypes.h File Reference

Provide structs commonly used in the SDK, enumerating constant definitions. More...

#include "Export.h"
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Classes

struct  ob_error
 The error class exposed by the SDK, users can get detailed error information according to the error. More...
struct  OBDataChunk
 Structure for transmitting data blocks. More...
struct  OBIntPropertyRange
 Structure for integer range. More...
struct  OBFloatPropertyRange
 Structure for float range. More...
struct  OBUint16PropertyRange
 Structure for float range. More...
struct  OBUint8PropertyRange
 Structure for float range. More...
struct  OBBoolPropertyRange
 Structure for boolean range. More...
struct  OBCameraIntrinsic
 Structure for camera intrinsic parameters. More...
struct  OBAccelIntrinsic
 Structure for accelerometer intrinsic parameters. More...
struct  OBGyroIntrinsic
 Structure for gyroscope intrinsic parameters. More...
struct  OBCameraDistortion
 Structure for distortion parameters. More...
struct  OBD2CTransform
 Structure for rotation/transformation. More...
struct  OBCameraParam
 Structure for camera parameters. More...
struct  OBPresetResolutionConfig
struct  OBCalibrationParam
 calibration parameters More...
struct  ob_margin_filter_config
 Configuration for depth margin filter. More...
struct  OBMGCFilterConfig
 Configuration for mgc filter. More...
struct  OBRect
 Rectangle. More...
struct  OBAccelValue
 Data structures for accelerometers and gyroscopes. More...
struct  OBDeviceTemperature
 Temperature parameters of the device (unit: Celsius) More...
struct  OBDisparityParam
 disparity parameters for disparity based camera More...
struct  OBPoint
 3D point structure in the SDK More...
struct  OBPoint2f
 2D point structure in the SDK More...
struct  OBXYTables
struct  OBColorPoint
 3D point structure with color information More...
struct  OBCompressionParams
struct  OBTofExposureThresholdControl
 TOF Exposure Threshold. More...
struct  OBDeviceSyncConfig
 Device synchronization configuration. More...
struct  OBDepthWorkMode
 Depth work mode. More...
struct  OBSequenceIdItem
 SequenceId fliter list item. More...
struct  OBSpatialFastFilterParams
struct  OBSpatialModerateFilterParams
struct  OBSpatialAdvancedFilterParams
struct  OBEdgeNoiseRemovalFilterParams
struct  OBNoiseRemovalFilterParams
struct  OBProtocolVersion
 Control command protocol version number. More...
struct  OBNetIpConfig
 IP address configuration for network devices (IPv4) More...
struct  ob_multi_device_sync_config
 The synchronization configuration of the device. More...
struct  ob_device_timestamp_reset_config
 The timestamp reset configuration of the device. More...
struct  BASELINE_CALIBRATION_PARAM
 Baseline calibration parameters. More...
struct  HDR_CONFIG
 HDR Configuration. More...
struct  AE_ROI
 The rect of the region of interest. More...
struct  OBFilterConfigSchemaItem
 Configuration Item for the filter. More...
struct  OBDeviceSerialNumber
 struct of serial number More...
struct  OBDispOffsetConfig
 Disparity offset interleaving configuration. More...

Macros

#define OB_WIDTH_ANY   0
#define OB_HEIGHT_ANY   0
#define OB_FPS_ANY   0
#define OB_FORMAT_ANY   OB_FORMAT_UNKNOWN
#define OB_PROFILE_DEFAULT   0
#define OB_DEFAULT_STRIDE_BYTES   0
#define OB_ACCEL_FULL_SCALE_RANGE_ANY   OB_ACCEL_FS_UNKNOWN
#define OB_ACCEL_SAMPLE_RATE_ANY   OB_SAMPLE_RATE_UNKNOWN
#define OB_GYRO_FULL_SCALE_RANGE_ANY   OB_GYRO_FS_UNKNOWN
#define OB_GYRO_SAMPLE_RATE_ANY   OB_SAMPLE_RATE_UNKNOWN
#define OB_PATH_MAX   (1024)
 maximum path length
#define OB_LOG_SEVERITY_NONE   OB_LOG_SEVERITY_OFF
#define OB_FORMAT_RGB888   OB_FORMAT_RGB
#define OB_FORMAT_MJPEG   OB_FORMAT_MJPG
#define IS_FIXED_SIZE_FORMAT(format)
#define IS_PACKED_FORMAT(format)
#define FORMAT_MJPEG_TO_I420   FORMAT_MJPG_TO_I420
#define FORMAT_MJPEG_TO_NV21   FORMAT_MJPG_TO_NV21
#define FORMAT_MJPEG_TO_BGRA   FORMAT_MJPG_TO_BGRA
#define FORMAT_YUYV_TO_RGB888   FORMAT_YUYV_TO_RGB
#define FORMAT_I420_TO_RGB888   FORMAT_I420_TO_RGB
#define FORMAT_NV21_TO_RGB888   FORMAT_NV21_TO_RGB
#define FORMAT_NV12_TO_RGB888   FORMAT_NV12_TO_RGB
#define FORMAT_UYVY_TO_RGB888   FORMAT_UYVY_TO_RGB
#define FORMAT_MJPG_TO_RGB888   FORMAT_MJPG_TO_RGB
#define FORMAT_MJPG_TO_BGR888   FORMAT_MJPG_TO_BGR
#define FORMAT_MJPEG_TO_RGB888   FORMAT_MJPG_TO_RGB
#define FORMAT_MJPEG_TO_BGR888   FORMAT_MJPG_TO_BGR
#define FORMAT_RGB888_TO_BGR   FORMAT_RGB_TO_BGR
#define OBDeviceIpAddrConfig   OBNetIpConfig
#define ob_device_ip_addr_config   OBNetIpConfig
#define OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE   OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE
#define OB_FRAME_METADATA_TYPE_LASER_POWER_MODE   OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL
#define OB_FRAME_METADATA_TYPE_EMITTER_MODE   OB_FRAME_METADATA_TYPE_LASER_STATUS
#define ob_filter_callback   ob_frame_callback
#define ob_playback_callback   ob_frame_callback
#define ob_is_video_sensor_type(sensor_type)
 Check if the sensor_type is a video sensor.
#define ob_is_video_stream_type(stream_type)
 check if the stream_type is a video stream
#define is_ir_sensor(sensor_type)
 Check if sensor_type is an IR sensor.
#define isIRSensor   is_ir_sensor
#define is_ir_stream(stream_type)
 Check if stream_type is an IR stream.
#define isIRStream   is_ir_stream
#define is_ir_frame(frame_type)
 Check if frame_type is an IR frame.
#define isIRFrame   is_ir_frame
#define OB_DEFAULT_DECRYPT_KEY   (nullptr)
 The default Decrypt Key.

Typedefs

typedef struct ob_context_t ob_context
typedef struct ob_device_t ob_device
typedef struct ob_device_info_t ob_device_info
typedef struct ob_device_list_t ob_device_list
typedef struct ob_record_device_t ob_record_device
typedef struct ob_playback_device_t ob_playback_device
typedef struct ob_camera_param_list_t ob_camera_param_list
typedef struct ob_sensor_t ob_sensor
typedef struct ob_sensor_list_t ob_sensor_list
typedef struct ob_stream_profile_t ob_stream_profile
typedef struct ob_stream_profile_list_t ob_stream_profile_list
typedef struct ob_frame_t ob_frame
typedef struct ob_filter_t ob_filter
typedef struct ob_filter_list_t ob_filter_list
typedef struct ob_pipeline_t ob_pipeline
typedef struct ob_config_t ob_config
typedef struct ob_depth_work_mode_list_t ob_depth_work_mode_list
typedef struct ob_device_preset_list_t ob_device_preset_list
typedef struct ob_filter_config_schema_list_t ob_filter_config_schema_list
typedef struct ob_device_frame_interleave_list_t ob_device_frame_interleave_list
typedef struct ob_preset_resolution_config_list_t ob_preset_resolution_config_list
typedef enum OBPermissionType ob_permission_type
typedef enum OBStatus ob_status
typedef enum OBLogSeverity ob_log_severity
typedef enum OBLogSeverity DEVICE_LOG_SEVERITY_LEVEL
typedef enum OBLogSeverity OBDeviceLogSeverityLevel
typedef enum OBLogSeverity ob_device_log_severity_level
typedef enum OBExceptionType ob_exception_type
typedef struct ob_error ob_error
 The error class exposed by the SDK, users can get detailed error information according to the error.
typedef enum OBSensorType ob_sensor_type
typedef enum OBStreamType ob_stream_type
typedef enum OBFrameType ob_frame_type
typedef enum OBPixelType ob_pixel_type
typedef enum OBFormat ob_format
typedef enum OBUpgradeState OBFwUpdateState
typedef enum OBUpgradeState ob_upgrade_state
typedef enum OBUpgradeState ob_fw_update_state
typedef enum OBFileTranState ob_file_tran_state
typedef enum OBDataTranState ob_data_tran_state
typedef struct OBDataChunk ob_data_chunk
typedef struct OBIntPropertyRange ob_int_property_range
typedef struct OBFloatPropertyRange ob_float_property_range
typedef struct OBUint16PropertyRange ob_uint16_property_range
typedef struct OBUint8PropertyRange ob_uint8_property_range
typedef struct OBBoolPropertyRange ob_bool_property_range
typedef enum OBCameraDistortionModel ob_camera_distortion_model
typedef struct OBCameraIntrinsic ob_camera_intrinsic
typedef struct OBAccelIntrinsic ob_accel_intrinsic
typedef struct OBGyroIntrinsic ob_gyro_intrinsic
typedef struct OBCameraDistortion ob_camera_distortion
typedef struct OBD2CTransform ob_d2c_transform
typedef struct OBD2CTransform OBTransform
typedef struct OBD2CTransform ob_transform
typedef struct OBD2CTransform OBExtrinsic
typedef struct OBD2CTransform ob_extrinsic
typedef struct OBCameraParam ob_camera_param
typedef struct OBPresetResolutionConfig ob_preset_resolution_ratio_config
typedef struct OBCalibrationParam ob_calibration_param
typedef struct ob_margin_filter_config OBMarginFilterConfig
typedef struct OBMGCFilterConfig ob_mgc_filter_config
typedef enum OBAlignMode ob_align_mode
typedef enum OBCameraPerformanceMode ob_camera_performance_mode
typedef struct OBRect ob_rect
typedef enum OBConvertFormat ob_convert_format
typedef enum OBIMUSampleRate OBGyroSampleRate
typedef enum OBIMUSampleRate ob_gyro_sample_rate
typedef enum OBIMUSampleRate OBAccelSampleRate
typedef enum OBIMUSampleRate ob_accel_sample_rate
typedef enum OBIMUSampleRate OB_SAMPLE_RATE
typedef enum OBGyroFullScaleRange ob_gyro_full_scale_range
typedef enum OBGyroFullScaleRange OB_GYRO_FULL_SCALE_RANGE
typedef enum OBAccelFullScaleRange ob_accel_full_scale_range
typedef enum OBAccelFullScaleRange OB_ACCEL_FULL_SCALE_RANGE
typedef struct OBAccelValue OBGyroValue
typedef struct OBAccelValue OBFloat3D
typedef struct OBAccelValue ob_accel_value
typedef struct OBAccelValue ob_gyro_value
typedef struct OBAccelValue ob_float_3d
typedef uint64_t OBDeviceState
 Device state.
typedef uint64_t ob_device_state
typedef struct OBDeviceTemperature ob_device_temperature
typedef struct OBDeviceTemperature DEVICE_TEMPERATURE
typedef enum OBDepthCroppingMode ob_depth_cropping_mode
typedef enum OBDepthCroppingMode OB_DEPTH_CROPPING_MODE
typedef enum OBDeviceType ob_device_type
typedef enum OBDeviceType OB_DEVICE_TYPE
typedef enum OBMediaType ob_media_type
typedef enum OBMediaType OB_MEDIA_TYPE
typedef enum OBMediaState ob_media_state
typedef enum OBMediaState OB_MEDIA_STATE_EM
typedef enum OBDepthPrecisionLevel ob_depth_precision_level
typedef enum OBDepthPrecisionLevel OB_DEPTH_PRECISION_LEVEL
typedef enum OBDepthPrecisionLevel OBDepthUnit
typedef enum OBDepthPrecisionLevel ob_depth_unit
typedef struct OBDisparityParam ob_disparity_param
typedef enum OBTofFilterRange ob_tof_filter_range
typedef enum OBTofFilterRange TOF_FILTER_RANGE
typedef struct OBPoint ob_point
typedef struct OBPoint OBPoint3f
typedef struct OBPoint ob_point3f
typedef struct OBPoint2f ob_point2f
typedef struct OBXYTables ob_xy_tables
typedef struct OBColorPoint ob_color_point
typedef enum OBCompressionMode ob_compression_mode
typedef enum OBCompressionMode OB_COMPRESSION_MODE
typedef struct OBCompressionParams ob_compression_params
typedef struct OBCompressionParams OB_COMPRESSION_PARAMS
typedef struct OBTofExposureThresholdControl ob_tof_exposure_threshold_control
typedef struct OBTofExposureThresholdControl TOF_EXPOSURE_THRESHOLD_CONTROL
typedef enum OBSyncMode ob_sync_mode
typedef enum OBSyncMode OB_SYNC_MODE
typedef struct OBDeviceSyncConfig ob_device_sync_config
typedef struct OBDeviceSyncConfig OB_DEVICE_SYNC_CONFIG
typedef enum OBDepthWorkModeTag ob_depth_work_mode_tag
typedef struct OBDepthWorkMode ob_depth_work_mode
typedef struct OBSequenceIdItem ob_sequence_id_item
typedef enum OBHoleFillingMode ob_hole_filling_mode
typedef struct OBSpatialFastFilterParams ob_spatial_fast_filter_params
typedef struct OBSpatialModerateFilterParams ob_spatial_moderate_filter_params
typedef struct OBSpatialAdvancedFilterParams ob_spatial_advanced_filter_params
typedef enum OB_EDGE_NOISE_REMOVAL_TYPE OBEdgeNoiseRemovalType
typedef enum OB_EDGE_NOISE_REMOVAL_TYPE ob_edge_noise_removal_type
typedef struct OBEdgeNoiseRemovalFilterParams ob_edge_noise_removal_filter_params
typedef enum OB_DDO_NOISE_REMOVAL_TYPE OBDDONoiseRemovalType
 Denoising method.
typedef enum OB_DDO_NOISE_REMOVAL_TYPE ob_ddo_noise_removal_type
typedef struct OBNoiseRemovalFilterParams ob_noise_removal_filter_params
typedef struct OBProtocolVersion ob_protocol_version
typedef enum OB_CMD_VERSION OBCmdVersion
typedef enum OB_CMD_VERSION ob_cmd_version
typedef struct OBNetIpConfig ob_net_ip_config
typedef struct OBNetIpConfig DEVICE_IP_ADDR_CONFIG
typedef enum OBCommunicationType ob_communication_type
typedef enum OBCommunicationType OB_COMMUNICATION_TYPE
typedef enum OBUSBPowerState ob_usb_power_state
typedef enum OBDCPowerState ob_dc_power_state
typedef enum ob_rotate_degree_type OBRotateDegreeType
typedef enum ob_power_line_freq_mode OBPowerLineFreqMode
typedef enum OB_FRAME_AGGREGATE_OUTPUT_MODE OBFrameAggregateOutputMode
typedef enum OB_FRAME_AGGREGATE_OUTPUT_MODE ob_frame_aggregate_output_mode
typedef enum OB_COORDINATE_SYSTEM_TYPE OBCoordinateSystemType
typedef enum OB_COORDINATE_SYSTEM_TYPE ob_coordinate_system_type
typedef enum OB_DEVICE_DEVELOPMENT_MODE OBDeviceDevelopmentMode
typedef enum OB_DEVICE_DEVELOPMENT_MODE ob_device_development_mode
typedef enum ob_multi_device_sync_mode OBMultiDeviceSyncMode
typedef struct ob_multi_device_sync_config OBMultiDeviceSyncConfig
typedef struct ob_device_timestamp_reset_config OBDeviceTimestampResetConfig
typedef struct BASELINE_CALIBRATION_PARAM ob_baseline_calibration_param
typedef struct BASELINE_CALIBRATION_PARAM OBBaselineCalibrationParam
typedef struct HDR_CONFIG ob_hdr_config
typedef struct HDR_CONFIG OBHdrConfig
typedef struct AE_ROI ob_region_of_interest
typedef struct AE_ROI OBRegionOfInterest
typedef enum OBFilterConfigValueType ob_filter_config_value_type
typedef struct OBFilterConfigSchemaItem ob_filter_config_schema_item
typedef struct OBDeviceSerialNumber ob_device_serial_number
typedef struct OBDeviceSerialNumber OBSerialNumber
typedef struct OBDeviceSerialNumber ob_serial_number
typedef struct OBDispOffsetConfig ob_disp_offset_config
typedef enum ob_frame_metadata_type OBFrameMetadataType
typedef enum ob_uvc_backend_type OBUvcBackendType
typedef enum ob_playback_status OBPlaybackStatus
typedef enum ob_intra_camera_sync_reference OBIntraCameraSyncReference
typedef void(* ob_file_send_callback) (ob_file_tran_state state, const char *message, uint8_t percent, void *user_data)
 Callback for file transfer.
typedef void(* ob_device_fw_update_callback) (ob_fw_update_state state, const char *message, uint8_t percent, void *user_data)
 Callback for firmware upgrade.
typedef void(* ob_device_state_callback) (ob_device_state state, const char *message, void *user_data)
 Callback for device status.
typedef void(* ob_set_data_callback) (ob_data_tran_state state, uint8_t percent, void *user_data)
 Callback for writing data.
typedef void(* ob_get_data_callback) (ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data)
 Callback for reading data.
typedef void(* ob_media_state_callback) (ob_media_state state, void *user_data)
 Callback for media status (recording and playback)
typedef void(* ob_device_changed_callback) (ob_device_list *removed, ob_device_list *added, void *user_data)
 Callback for device change.
typedef void(* ob_frame_callback) (ob_frame *frame, void *user_data)
 Callback for frame.
typedef void(* ob_frameset_callback) (ob_frame *frameset, void *user_data)
 Callback for frameset.
typedef void ob_frame_destroy_callback(uint8_t *buffer, void *user_data)
 Customize the delete callback.
typedef void ob_log_callback(ob_log_severity severity, const char *message, void *user_data)
 Callback for receiving log.
typedef void(* ob_playback_status_changed_callback) (ob_playback_status status, void *user_data)

Enumerations

enum  OBPermissionType {
  OB_PERMISSION_DENY = 0 , OB_PERMISSION_READ = 1 , OB_PERMISSION_WRITE = 2 , OB_PERMISSION_READ_WRITE = 3 ,
  OB_PERMISSION_ANY = 255
}
 the permission type of api or property More...
enum  OBStatus { OB_STATUS_OK = 0 , OB_STATUS_ERROR = 1 }
 error code More...
enum  OBLogSeverity {
  OB_LOG_SEVERITY_DEBUG , OB_LOG_SEVERITY_INFO , OB_LOG_SEVERITY_WARN , OB_LOG_SEVERITY_ERROR ,
  OB_LOG_SEVERITY_FATAL , OB_LOG_SEVERITY_OFF
}
 log level, the higher the level, the stronger the log filter More...
enum  OBExceptionType {
  OB_EXCEPTION_TYPE_UNKNOWN , OB_EXCEPTION_STD_EXCEPTION , OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED , OB_EXCEPTION_TYPE_PLATFORM ,
  OB_EXCEPTION_TYPE_INVALID_VALUE , OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE , OB_EXCEPTION_TYPE_NOT_IMPLEMENTED , OB_EXCEPTION_TYPE_IO ,
  OB_EXCEPTION_TYPE_MEMORY , OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION
}
 The exception types in the SDK, through the exception type, you can easily determine the specific type of error. For detailed error API interface functions and error logs, please refer to the information of ob_error. More...
enum  OBSensorType {
  OB_SENSOR_UNKNOWN = 0 , OB_SENSOR_IR = 1 , OB_SENSOR_COLOR = 2 , OB_SENSOR_DEPTH = 3 ,
  OB_SENSOR_ACCEL = 4 , OB_SENSOR_GYRO = 5 , OB_SENSOR_IR_LEFT = 6 , OB_SENSOR_IR_RIGHT = 7 ,
  OB_SENSOR_RAW_PHASE = 8 , OB_SENSOR_CONFIDENCE = 9 , OB_SENSOR_TYPE_COUNT
}
 Enumeration value describing the sensor type. More...
enum  OBStreamType {
  OB_STREAM_UNKNOWN = -1 , OB_STREAM_VIDEO = 0 , OB_STREAM_IR = 1 , OB_STREAM_COLOR = 2 ,
  OB_STREAM_DEPTH = 3 , OB_STREAM_ACCEL = 4 , OB_STREAM_GYRO = 5 , OB_STREAM_IR_LEFT = 6 ,
  OB_STREAM_IR_RIGHT = 7 , OB_STREAM_RAW_PHASE = 8 , OB_STREAM_CONFIDENCE = 9 , OB_STREAM_TYPE_COUNT
}
 Enumeration value describing the type of data stream. More...
enum  OBFrameType {
  OB_FRAME_UNKNOWN = -1 , OB_FRAME_VIDEO = 0 , OB_FRAME_IR = 1 , OB_FRAME_COLOR = 2 ,
  OB_FRAME_DEPTH = 3 , OB_FRAME_ACCEL = 4 , OB_FRAME_SET = 5 , OB_FRAME_POINTS = 6 ,
  OB_FRAME_GYRO = 7 , OB_FRAME_IR_LEFT = 8 , OB_FRAME_IR_RIGHT = 9 , OB_FRAME_RAW_PHASE = 10 ,
  OB_FRAME_CONFIDENCE = 11 , OB_FRAME_TYPE_COUNT
}
 Enumeration value describing the type of frame. More...
enum  OBPixelType {
  OB_PIXEL_UNKNOWN = -1 , OB_PIXEL_DEPTH = 0 , OB_PIXEL_DISPARITY = 2 , OB_PIXEL_RAW_PHASE = 3 ,
  OB_PIXEL_TOF_DEPTH = 4
}
 Enumeration value describing the pixel type of frame (usually used for depth frame) More...
enum  OBFormat {
  OB_FORMAT_UNKNOWN = -1 , OB_FORMAT_YUYV = 0 , OB_FORMAT_YUY2 = 1 , OB_FORMAT_UYVY = 2 ,
  OB_FORMAT_NV12 = 3 , OB_FORMAT_NV21 = 4 , OB_FORMAT_MJPG = 5 , OB_FORMAT_H264 = 6 ,
  OB_FORMAT_H265 = 7 , OB_FORMAT_Y16 = 8 , OB_FORMAT_Y8 = 9 , OB_FORMAT_Y10 = 10 ,
  OB_FORMAT_Y11 = 11 , OB_FORMAT_Y12 = 12 , OB_FORMAT_GRAY = 13 , OB_FORMAT_HEVC = 14 ,
  OB_FORMAT_I420 = 15 , OB_FORMAT_ACCEL = 16 , OB_FORMAT_GYRO = 17 , OB_FORMAT_POINT = 19 ,
  OB_FORMAT_RGB_POINT = 20 , OB_FORMAT_RLE = 21 , OB_FORMAT_RGB = 22 , OB_FORMAT_BGR = 23 ,
  OB_FORMAT_Y14 = 24 , OB_FORMAT_BGRA = 25 , OB_FORMAT_COMPRESSED = 26 , OB_FORMAT_RVL = 27 ,
  OB_FORMAT_Z16 = 28 , OB_FORMAT_YV12 = 29 , OB_FORMAT_BA81 = 30 , OB_FORMAT_RGBA = 31 ,
  OB_FORMAT_BYR2 = 32 , OB_FORMAT_RW16 = 33 , OB_FORMAT_Y12C4 = 34
}
 Enumeration value describing the pixel format. More...
enum  OBUpgradeState {
  STAT_DONE_WITH_DUPLICATES = 6 , STAT_VERIFY_SUCCESS = 5 , STAT_FILE_TRANSFER = 4 , STAT_DONE = 3 ,
  STAT_IN_PROGRESS = 2 , STAT_START = 1 , STAT_VERIFY_IMAGE = 0 , ERR_VERIFY = -1 ,
  ERR_PROGRAM = -2 , ERR_ERASE = -3 , ERR_FLASH_TYPE = -4 , ERR_IMAGE_SIZE = -5 ,
  ERR_OTHER = -6 , ERR_DDR = -7 , ERR_TIMEOUT = -8 , ERR_MISMATCH = -9 ,
  ERR_UNSUPPORT_DEV = -10 , ERR_INVALID_COUNT = -11
}
 Enumeration value describing the firmware upgrade status. More...
enum  OBFileTranState {
  FILE_TRAN_STAT_TRANSFER = 2 , FILE_TRAN_STAT_DONE = 1 , FILE_TRAN_STAT_PREPAR = 0 , FILE_TRAN_ERR_DDR = -1 ,
  FILE_TRAN_ERR_NOT_ENOUGH_SPACE = -2 , FILE_TRAN_ERR_PATH_NOT_WRITABLE = -3 , FILE_TRAN_ERR_MD5_ERROR = -4 , FILE_TRAN_ERR_WRITE_FLASH_ERROR = -5 ,
  FILE_TRAN_ERR_TIMEOUT = -6
}
 Enumeration value describing the file transfer status. More...
enum  OBDataTranState {
  DATA_TRAN_STAT_VERIFY_DONE = 4 , DATA_TRAN_STAT_STOPPED = 3 , DATA_TRAN_STAT_DONE = 2 , DATA_TRAN_STAT_VERIFYING = 1 ,
  DATA_TRAN_STAT_TRANSFERRING = 0 , DATA_TRAN_ERR_BUSY = -1 , DATA_TRAN_ERR_UNSUPPORTED = -2 , DATA_TRAN_ERR_TRAN_FAILED = -3 ,
  DATA_TRAN_ERR_VERIFY_FAILED = -4 , DATA_TRAN_ERR_OTHER = -5
}
 Enumeration value describing the data transfer status. More...
enum  OBCameraDistortionModel {
  OB_DISTORTION_NONE , OB_DISTORTION_MODIFIED_BROWN_CONRADY , OB_DISTORTION_INVERSE_BROWN_CONRADY , OB_DISTORTION_BROWN_CONRADY ,
  OB_DISTORTION_BROWN_CONRADY_K6 , OB_DISTORTION_KANNALA_BRANDT4
}
 Distortion model: defines how pixel coordinates should be mapped to sensor coordinates. More...
enum  OBAlignMode { ALIGN_DISABLE , ALIGN_D2C_HW_MODE , ALIGN_D2C_SW_MODE }
 Alignment mode. More...
enum  OBCameraPerformanceMode { ADAPTIVE_PERFORMANCE_MODE , HIGH_PERFORMANCE_MODE }
 Camera performance mode. More...
enum  OBConvertFormat {
  FORMAT_YUYV_TO_RGB = 0 , FORMAT_I420_TO_RGB , FORMAT_NV21_TO_RGB , FORMAT_NV12_TO_RGB ,
  FORMAT_MJPG_TO_I420 , FORMAT_RGB_TO_BGR , FORMAT_MJPG_TO_NV21 , FORMAT_MJPG_TO_RGB ,
  FORMAT_MJPG_TO_BGR , FORMAT_MJPG_TO_BGRA , FORMAT_UYVY_TO_RGB , FORMAT_BGR_TO_RGB ,
  FORMAT_MJPG_TO_NV12 , FORMAT_YUYV_TO_BGR , FORMAT_YUYV_TO_RGBA , FORMAT_YUYV_TO_BGRA ,
  FORMAT_YUYV_TO_Y16 , FORMAT_YUYV_TO_Y8 , FORMAT_RGBA_TO_RGB , FORMAT_BGRA_TO_BGR ,
  FORMAT_Y16_TO_RGB , FORMAT_Y8_TO_RGB
}
 Enumeration of format conversion types. More...
enum  OBIMUSampleRate {
  OB_SAMPLE_RATE_UNKNOWN = 0 , OB_SAMPLE_RATE_1_5625_HZ = 1 , OB_SAMPLE_RATE_3_125_HZ = 2 , OB_SAMPLE_RATE_6_25_HZ = 3 ,
  OB_SAMPLE_RATE_12_5_HZ = 4 , OB_SAMPLE_RATE_25_HZ = 5 , OB_SAMPLE_RATE_50_HZ = 6 , OB_SAMPLE_RATE_100_HZ = 7 ,
  OB_SAMPLE_RATE_200_HZ = 8 , OB_SAMPLE_RATE_500_HZ = 9 , OB_SAMPLE_RATE_1_KHZ = 10 , OB_SAMPLE_RATE_2_KHZ = 11 ,
  OB_SAMPLE_RATE_4_KHZ = 12 , OB_SAMPLE_RATE_8_KHZ = 13 , OB_SAMPLE_RATE_16_KHZ = 14 , OB_SAMPLE_RATE_32_KHZ = 15 ,
  OB_SAMPLE_RATE_400_HZ = 16 , OB_SAMPLE_RATE_800_HZ = 17
}
 Enumeration of IMU sample rate values (gyroscope or accelerometer) More...
enum  OBGyroFullScaleRange {
  OB_GYRO_FS_UNKNOWN = -1 , OB_GYRO_FS_16dps = 1 , OB_GYRO_FS_31dps = 2 , OB_GYRO_FS_62dps = 3 ,
  OB_GYRO_FS_125dps = 4 , OB_GYRO_FS_250dps = 5 , OB_GYRO_FS_500dps = 6 , OB_GYRO_FS_1000dps = 7 ,
  OB_GYRO_FS_2000dps = 8 , OB_GYRO_FS_400dps = 9 , OB_GYRO_FS_800dps = 10
}
 Enumeration of gyroscope ranges. More...
enum  OBAccelFullScaleRange {
  OB_ACCEL_FS_UNKNOWN = -1 , OB_ACCEL_FS_2g = 1 , OB_ACCEL_FS_4g = 2 , OB_ACCEL_FS_8g = 3 ,
  OB_ACCEL_FS_16g = 4 , OB_ACCEL_FS_3g = 5 , OB_ACCEL_FS_6g = 6 , OB_ACCEL_FS_12g = 7 ,
  OB_ACCEL_FS_24g = 8
}
 Enumeration of accelerometer ranges. More...
enum  OBDepthCroppingMode { DEPTH_CROPPING_MODE_AUTO = 0 , DEPTH_CROPPING_MODE_CLOSE = 1 , DEPTH_CROPPING_MODE_OPEN = 2 }
 Enumeration for depth crop modes. More...
enum  OBDeviceType { OB_DEVICE_TYPE_UNKNOWN = -1 , OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA = 0 , OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA = 1 , OB_TOF_CAMERA = 2 }
 Enumeration for device types. More...
enum  OBMediaType {
  OB_MEDIA_COLOR_STREAM = 1 , OB_MEDIA_DEPTH_STREAM = 2 , OB_MEDIA_IR_STREAM = 4 , OB_MEDIA_GYRO_STREAM = 8 ,
  OB_MEDIA_ACCEL_STREAM = 16 , OB_MEDIA_CAMERA_PARAM = 32 , OB_MEDIA_DEVICE_INFO = 64 , OB_MEDIA_STREAM_INFO = 128 ,
  OB_MEDIA_IR_LEFT_STREAM = 256 , OB_MEDIA_IR_RIGHT_STREAM = 512 , OB_MEDIA_ALL
}
 Enumeration for types of media to record or playback. More...
enum  OBMediaState { OB_MEDIA_BEGIN = 0 , OB_MEDIA_PAUSE , OB_MEDIA_RESUME , OB_MEDIA_END }
 Enumeration for record playback status. More...
enum  OBDepthPrecisionLevel {
  OB_PRECISION_1MM , OB_PRECISION_0MM8 , OB_PRECISION_0MM4 , OB_PRECISION_0MM1 ,
  OB_PRECISION_0MM2 , OB_PRECISION_0MM5 , OB_PRECISION_0MM05 , OB_PRECISION_UNKNOWN ,
  OB_PRECISION_COUNT
}
 Enumeration for depth precision levels. More...
enum  OBTofFilterRange { OB_TOF_FILTER_RANGE_CLOSE = 0 , OB_TOF_FILTER_RANGE_MIDDLE = 1 , OB_TOF_FILTER_RANGE_LONG = 2 , OB_TOF_FILTER_RANGE_DEBUG = 100 }
 Enumeration for TOF filter scene ranges. More...
enum  OBCompressionMode { OB_COMPRESSION_LOSSLESS = 0 , OB_COMPRESSION_LOSSY = 1 }
 Compression mode. More...
enum  OBSyncMode {
  OB_SYNC_MODE_CLOSE = 0x00 , OB_SYNC_MODE_STANDALONE = 0x01 , OB_SYNC_MODE_PRIMARY = 0x02 , OB_SYNC_MODE_SECONDARY = 0x03 ,
  OB_SYNC_MODE_PRIMARY_MCU_TRIGGER = 0x04 , OB_SYNC_MODE_PRIMARY_IR_TRIGGER = 0x05 , OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER = 0x06 , OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER = 0x07 ,
  OB_SYNC_MODE_IR_IMU_SYNC = 0x08 , OB_SYNC_MODE_UNKNOWN = 0xff
}
 Sync mode. More...
enum  OBDepthWorkModeTag { OB_DEVICE_DEPTH_WORK_MODE = 0 , OB_CUSTOM_DEPTH_WORK_MODE = 1 }
 Preset tag. More...
enum  OBHoleFillingMode { OB_HOLE_FILL_TOP = 0 , OB_HOLE_FILL_NEAREST = 1 , OB_HOLE_FILL_FAREST = 2 }
 Hole fillig mode. More...
enum  OB_EDGE_NOISE_REMOVAL_TYPE { OB_MG_FILTER = 0 , OB_MGH_FILTER = 1 , OB_MGA_FILTER = 2 , OB_MGC_FILTER = 3 }
enum  OB_DDO_NOISE_REMOVAL_TYPE { OB_NR_LUT = 0 , OB_NR_OVERALL = 1 }
 Denoising method. More...
enum  OB_CMD_VERSION {
  OB_CMD_VERSION_V0 = (uint16_t)0 , OB_CMD_VERSION_V1 = (uint16_t)1 , OB_CMD_VERSION_V2 = (uint16_t)2 , OB_CMD_VERSION_V3 = (uint16_t)3 ,
  OB_CMD_VERSION_NOVERSION = (uint16_t)0xfffe , OB_CMD_VERSION_INVALID = (uint16_t)0xffff
}
 Command version associated with property id. More...
enum  OBCommunicationType { OB_COMM_USB = 0x00 , OB_COMM_NET = 0x01 }
 Device communication mode. More...
enum  OBUSBPowerState { OB_USB_POWER_NO_PLUGIN = 0 , OB_USB_POWER_5V_0A9 = 1 , OB_USB_POWER_5V_1A5 = 2 , OB_USB_POWER_5V_3A0 = 3 }
 USB power status. More...
enum  OBDCPowerState { OB_DC_POWER_NO_PLUGIN = 0 , OB_DC_POWER_PLUGIN = 1 }
 DC power status. More...
enum  ob_rotate_degree_type { OB_ROTATE_DEGREE_0 = 0 , OB_ROTATE_DEGREE_90 = 90 , OB_ROTATE_DEGREE_180 = 180 , OB_ROTATE_DEGREE_270 = 270 }
 Rotate degree. More...
enum  ob_power_line_freq_mode { OB_POWER_LINE_FREQ_MODE_CLOSE = 0 , OB_POWER_LINE_FREQ_MODE_50HZ = 1 , OB_POWER_LINE_FREQ_MODE_60HZ = 2 }
 Power line frequency mode, for color camera anti-flicker configuration. More...
enum  OB_FRAME_AGGREGATE_OUTPUT_MODE { OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE = 0 , OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE , OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION , OB_FRAME_AGGREGATE_OUTPUT_DISABLE }
 Frame aggregate output mode. More...
enum  OB_COORDINATE_SYSTEM_TYPE { OB_LEFT_HAND_COORDINATE_SYSTEM = 0 , OB_RIGHT_HAND_COORDINATE_SYSTEM = 1 }
 Enumeration of point cloud coordinate system types. More...
enum  OB_DEVICE_DEVELOPMENT_MODE { OB_USER_MODE = 0 , OB_DEVELOPER_MODE = 1 }
 Enumeration of device development modes. More...
enum  ob_multi_device_sync_mode {
  OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN = 1 << 0 , OB_MULTI_DEVICE_SYNC_MODE_STANDALONE = 1 << 1 , OB_MULTI_DEVICE_SYNC_MODE_PRIMARY = 1 << 2 , OB_MULTI_DEVICE_SYNC_MODE_SECONDARY = 1 << 3 ,
  OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED = 1 << 4 , OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING = 1 << 5 , OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING = 1 << 6 , OB_MULTI_DEVICE_SYNC_MODE_IR_IMU_SYNC = 1 << 7
}
 The synchronization mode of the device. More...
enum  OBFilterConfigValueType { OB_FILTER_CONFIG_VALUE_TYPE_INVALID = -1 , OB_FILTER_CONFIG_VALUE_TYPE_INT = 0 , OB_FILTER_CONFIG_VALUE_TYPE_FLOAT = 1 , OB_FILTER_CONFIG_VALUE_TYPE_BOOLEAN = 2 }
enum  ob_frame_metadata_type {
  OB_FRAME_METADATA_TYPE_TIMESTAMP = 0 , OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP = 1 , OB_FRAME_METADATA_TYPE_FRAME_NUMBER = 2 , OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE = 3 ,
  OB_FRAME_METADATA_TYPE_EXPOSURE = 4 , OB_FRAME_METADATA_TYPE_GAIN = 5 , OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE = 6 , OB_FRAME_METADATA_TYPE_WHITE_BALANCE = 7 ,
  OB_FRAME_METADATA_TYPE_BRIGHTNESS = 8 , OB_FRAME_METADATA_TYPE_CONTRAST = 9 , OB_FRAME_METADATA_TYPE_SATURATION = 10 , OB_FRAME_METADATA_TYPE_SHARPNESS = 11 ,
  OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION = 12 , OB_FRAME_METADATA_TYPE_HUE = 13 , OB_FRAME_METADATA_TYPE_GAMMA = 14 , OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY = 15 ,
  OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION = 16 , OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE = 17 , OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE = 18 , OB_FRAME_METADATA_TYPE_FRAME_RATE = 19 ,
  OB_FRAME_METADATA_TYPE_AE_ROI_LEFT = 20 , OB_FRAME_METADATA_TYPE_AE_ROI_TOP = 21 , OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT = 22 , OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM = 23 ,
  OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY = 24 , OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME = 25 , OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE = 26 , OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX = 27 ,
  OB_FRAME_METADATA_TYPE_LASER_POWER = 28 , OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL = 29 , OB_FRAME_METADATA_TYPE_LASER_STATUS = 30 , OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA = 31 ,
  OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_OFFSET = 32 , OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_RANGE = 33 , OB_FRAME_METADATA_TYPE_COUNT
}
 Frame metadata types. More...
enum  ob_uvc_backend_type { OB_UVC_BACKEND_TYPE_AUTO , OB_UVC_BACKEND_TYPE_LIBUVC , OB_UVC_BACKEND_TYPE_V4L2 , OB_UVC_BACKEND_TYPE_MSMF }
 For Linux, there are two ways to access the UVC device, libuvc and v4l2. The backend type is used to select the backend to access the device. More...
enum  ob_playback_status {
  OB_PLAYBACK_UNKNOWN , OB_PLAYBACK_PLAYING , OB_PLAYBACK_PAUSED , OB_PLAYBACK_STOPPED ,
  OB_PLAYBACK_COUNT
}
 The playback status of the media. More...
enum  ob_intra_camera_sync_reference { START_OF_EXPOSURE = 0 , MIDDLE_OF_EXPOSURE , END_OF_EXPOSURE }
 Intra-camera Sync Reference based on the exposure start time, the exposure middle time, or the exposure end time. More...

Detailed Description

Provide structs commonly used in the SDK, enumerating constant definitions.

Definition in file ObTypes.h.

Macro Definition Documentation

◆ OB_WIDTH_ANY

#define OB_WIDTH_ANY   0

◆ OB_HEIGHT_ANY

#define OB_HEIGHT_ANY   0

◆ OB_FPS_ANY

#define OB_FPS_ANY   0

◆ OB_FORMAT_ANY

◆ OB_PROFILE_DEFAULT

#define OB_PROFILE_DEFAULT   0

Definition at line 48 of file ObTypes.h.

◆ OB_DEFAULT_STRIDE_BYTES

#define OB_DEFAULT_STRIDE_BYTES   0

Definition at line 49 of file ObTypes.h.

◆ OB_ACCEL_FULL_SCALE_RANGE_ANY

#define OB_ACCEL_FULL_SCALE_RANGE_ANY   OB_ACCEL_FS_UNKNOWN

Definition at line 50 of file ObTypes.h.

Referenced by ob::Config::enableAccelStream().

◆ OB_ACCEL_SAMPLE_RATE_ANY

#define OB_ACCEL_SAMPLE_RATE_ANY   OB_SAMPLE_RATE_UNKNOWN

Definition at line 51 of file ObTypes.h.

Referenced by ob::Config::enableAccelStream().

◆ OB_GYRO_FULL_SCALE_RANGE_ANY

#define OB_GYRO_FULL_SCALE_RANGE_ANY   OB_GYRO_FS_UNKNOWN

Definition at line 52 of file ObTypes.h.

Referenced by ob::Config::enableGyroStream().

◆ OB_GYRO_SAMPLE_RATE_ANY

#define OB_GYRO_SAMPLE_RATE_ANY   OB_SAMPLE_RATE_UNKNOWN

Definition at line 53 of file ObTypes.h.

Referenced by ob::Config::enableGyroStream().

◆ OB_PATH_MAX

#define OB_PATH_MAX   (1024)

maximum path length

Definition at line 58 of file ObTypes.h.

Referenced by ob_device_update_optional_depth_presets(), and ob::Device::updateOptionalDepthPresets().

◆ OB_LOG_SEVERITY_NONE

#define OB_LOG_SEVERITY_NONE   OB_LOG_SEVERITY_OFF

Definition at line 93 of file ObTypes.h.

◆ OB_FORMAT_RGB888

#define OB_FORMAT_RGB888   OB_FORMAT_RGB

Definition at line 238 of file ObTypes.h.

◆ OB_FORMAT_MJPEG

#define OB_FORMAT_MJPEG   OB_FORMAT_MJPG

Definition at line 239 of file ObTypes.h.

◆ IS_FIXED_SIZE_FORMAT

#define IS_FIXED_SIZE_FORMAT ( format)
Value:
(format != OB_FORMAT_MJPG && format != OB_FORMAT_H264 && format != OB_FORMAT_H265 && format != OB_FORMAT_HEVC && format != OB_FORMAT_RLE \
&& format != OB_FORMAT_RVL)
@ OB_FORMAT_H265
Definition ObTypes.h:208
@ OB_FORMAT_RLE
Definition ObTypes.h:221
@ OB_FORMAT_MJPG
Definition ObTypes.h:206
@ OB_FORMAT_H264
Definition ObTypes.h:207
@ OB_FORMAT_RVL
Definition ObTypes.h:227
@ OB_FORMAT_HEVC
Definition ObTypes.h:215

Definition at line 242 of file ObTypes.h.

◆ IS_PACKED_FORMAT

#define IS_PACKED_FORMAT ( format)
Value:
(format == OB_FORMAT_Y10 || format == OB_FORMAT_Y11 || format == OB_FORMAT_Y12 || format == OB_FORMAT_Y14 || format == OB_FORMAT_RLE)
@ OB_FORMAT_Y11
Definition ObTypes.h:212
@ OB_FORMAT_Y12
Definition ObTypes.h:213
@ OB_FORMAT_Y10
Definition ObTypes.h:211
@ OB_FORMAT_Y14
Definition ObTypes.h:224

Definition at line 247 of file ObTypes.h.

◆ FORMAT_MJPEG_TO_I420

#define FORMAT_MJPEG_TO_I420   FORMAT_MJPG_TO_I420

Definition at line 562 of file ObTypes.h.

◆ FORMAT_MJPEG_TO_NV21

#define FORMAT_MJPEG_TO_NV21   FORMAT_MJPG_TO_NV21

Definition at line 563 of file ObTypes.h.

◆ FORMAT_MJPEG_TO_BGRA

#define FORMAT_MJPEG_TO_BGRA   FORMAT_MJPG_TO_BGRA

Definition at line 564 of file ObTypes.h.

◆ FORMAT_YUYV_TO_RGB888

#define FORMAT_YUYV_TO_RGB888   FORMAT_YUYV_TO_RGB

Definition at line 565 of file ObTypes.h.

◆ FORMAT_I420_TO_RGB888

#define FORMAT_I420_TO_RGB888   FORMAT_I420_TO_RGB

Definition at line 566 of file ObTypes.h.

◆ FORMAT_NV21_TO_RGB888

#define FORMAT_NV21_TO_RGB888   FORMAT_NV21_TO_RGB

Definition at line 567 of file ObTypes.h.

◆ FORMAT_NV12_TO_RGB888

#define FORMAT_NV12_TO_RGB888   FORMAT_NV12_TO_RGB

Definition at line 568 of file ObTypes.h.

◆ FORMAT_UYVY_TO_RGB888

#define FORMAT_UYVY_TO_RGB888   FORMAT_UYVY_TO_RGB

Definition at line 569 of file ObTypes.h.

◆ FORMAT_MJPG_TO_RGB888

#define FORMAT_MJPG_TO_RGB888   FORMAT_MJPG_TO_RGB

Definition at line 570 of file ObTypes.h.

◆ FORMAT_MJPG_TO_BGR888

#define FORMAT_MJPG_TO_BGR888   FORMAT_MJPG_TO_BGR

Definition at line 571 of file ObTypes.h.

◆ FORMAT_MJPEG_TO_RGB888

#define FORMAT_MJPEG_TO_RGB888   FORMAT_MJPG_TO_RGB

Definition at line 572 of file ObTypes.h.

◆ FORMAT_MJPEG_TO_BGR888

#define FORMAT_MJPEG_TO_BGR888   FORMAT_MJPG_TO_BGR

Definition at line 573 of file ObTypes.h.

◆ FORMAT_RGB888_TO_BGR

#define FORMAT_RGB888_TO_BGR   FORMAT_RGB_TO_BGR

Definition at line 574 of file ObTypes.h.

◆ OBDeviceIpAddrConfig

#define OBDeviceIpAddrConfig   OBNetIpConfig

Definition at line 1122 of file ObTypes.h.

◆ ob_device_ip_addr_config

#define ob_device_ip_addr_config   OBNetIpConfig

Definition at line 1123 of file ObTypes.h.

◆ OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE

#define OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE   OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE

Definition at line 1206 of file ObTypes.h.

◆ OB_FRAME_METADATA_TYPE_LASER_POWER_MODE

#define OB_FRAME_METADATA_TYPE_LASER_POWER_MODE   OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL

Definition at line 1750 of file ObTypes.h.

◆ OB_FRAME_METADATA_TYPE_EMITTER_MODE

#define OB_FRAME_METADATA_TYPE_EMITTER_MODE   OB_FRAME_METADATA_TYPE_LASER_STATUS

Definition at line 1751 of file ObTypes.h.

◆ ob_filter_callback

#define ob_filter_callback   ob_frame_callback

Definition at line 1827 of file ObTypes.h.

Referenced by ob_filter_set_callback().

◆ ob_playback_callback

#define ob_playback_callback   ob_frame_callback

Definition at line 1828 of file ObTypes.h.

◆ ob_is_video_sensor_type

#define ob_is_video_sensor_type ( sensor_type)
Value:
(sensor_type == OB_SENSOR_COLOR || sensor_type == OB_SENSOR_DEPTH || sensor_type == OB_SENSOR_IR || sensor_type == OB_SENSOR_IR_LEFT \
|| sensor_type == OB_SENSOR_IR_RIGHT || sensor_type == OB_SENSOR_CONFIDENCE)
@ OB_SENSOR_CONFIDENCE
Definition ObTypes.h:138
@ OB_SENSOR_IR_RIGHT
Definition ObTypes.h:136
@ OB_SENSOR_COLOR
Definition ObTypes.h:131
@ OB_SENSOR_IR
Definition ObTypes.h:130
@ OB_SENSOR_DEPTH
Definition ObTypes.h:132
@ OB_SENSOR_IR_LEFT
Definition ObTypes.h:135

Check if the sensor_type is a video sensor.

Parameters
sensor_typeSensor type to check
Returns
True if sensor_type is a video sensor, false otherwise

Definition at line 1862 of file ObTypes.h.

Referenced by ob::TypeHelper::isVideoSensorType().

◆ ob_is_video_stream_type

#define ob_is_video_stream_type ( stream_type)
Value:
(stream_type == OB_STREAM_COLOR || stream_type == OB_STREAM_DEPTH || stream_type == OB_STREAM_IR || stream_type == OB_STREAM_IR_LEFT \
|| stream_type == OB_STREAM_IR_RIGHT || stream_type == OB_STREAM_VIDEO || stream_type == OB_STREAM_CONFIDENCE)
@ OB_STREAM_CONFIDENCE
Definition ObTypes.h:157
@ OB_STREAM_IR
Definition ObTypes.h:149
@ OB_STREAM_DEPTH
Definition ObTypes.h:151
@ OB_STREAM_IR_RIGHT
Definition ObTypes.h:155
@ OB_STREAM_IR_LEFT
Definition ObTypes.h:154
@ OB_STREAM_VIDEO
Definition ObTypes.h:148
@ OB_STREAM_COLOR
Definition ObTypes.h:150

check if the stream_type is a video stream

Parameters
stream_typeStream type to check
Returns
True if stream_type is a video stream, false otherwise

Definition at line 1872 of file ObTypes.h.

Referenced by ob::TypeHelper::isVideoStreamType().

◆ is_ir_sensor

#define is_ir_sensor ( sensor_type)
Value:
(sensor_type == OB_SENSOR_IR || sensor_type == OB_SENSOR_IR_LEFT || sensor_type == OB_SENSOR_IR_RIGHT)

Check if sensor_type is an IR sensor.

Parameters
sensor_typeSensor type to check
Returns
True if sensor_type is an IR sensor, false otherwise

Definition at line 1882 of file ObTypes.h.

◆ isIRSensor

#define isIRSensor   is_ir_sensor

Definition at line 1883 of file ObTypes.h.

◆ is_ir_stream

#define is_ir_stream ( stream_type)
Value:
(stream_type == OB_STREAM_IR || stream_type == OB_STREAM_IR_LEFT || stream_type == OB_STREAM_IR_RIGHT)

Check if stream_type is an IR stream.

Parameters
stream_typeStream type to check
Returns
True if stream_type is an IR stream, false otherwise

Definition at line 1891 of file ObTypes.h.

◆ isIRStream

#define isIRStream   is_ir_stream

Definition at line 1892 of file ObTypes.h.

◆ is_ir_frame

#define is_ir_frame ( frame_type)
Value:
(frame_type == OB_FRAME_IR || frame_type == OB_FRAME_IR_LEFT || frame_type == OB_FRAME_IR_RIGHT)
@ OB_FRAME_IR_RIGHT
Definition ObTypes.h:176
@ OB_FRAME_IR_LEFT
Definition ObTypes.h:175
@ OB_FRAME_IR
Definition ObTypes.h:168

Check if frame_type is an IR frame.

Parameters
frame_typeFrame type to check
Returns
True if frame_type is an IR frame, false otherwise

Definition at line 1900 of file ObTypes.h.

◆ isIRFrame

#define isIRFrame   is_ir_frame

Definition at line 1901 of file ObTypes.h.

◆ OB_DEFAULT_DECRYPT_KEY

#define OB_DEFAULT_DECRYPT_KEY   (nullptr)

The default Decrypt Key.

Definition at line 1906 of file ObTypes.h.

Typedef Documentation

◆ ob_context

typedef struct ob_context_t ob_context

Definition at line 22 of file ObTypes.h.

◆ ob_device

typedef struct ob_device_t ob_device

Definition at line 23 of file ObTypes.h.

◆ ob_device_info

typedef struct ob_device_info_t ob_device_info

Definition at line 24 of file ObTypes.h.

◆ ob_device_list

typedef struct ob_device_list_t ob_device_list

Definition at line 25 of file ObTypes.h.

◆ ob_record_device

typedef struct ob_record_device_t ob_record_device

Definition at line 26 of file ObTypes.h.

◆ ob_playback_device

typedef struct ob_playback_device_t ob_playback_device

Definition at line 27 of file ObTypes.h.

◆ ob_camera_param_list

typedef struct ob_camera_param_list_t ob_camera_param_list

Definition at line 28 of file ObTypes.h.

◆ ob_sensor

typedef struct ob_sensor_t ob_sensor

Definition at line 29 of file ObTypes.h.

◆ ob_sensor_list

typedef struct ob_sensor_list_t ob_sensor_list

Definition at line 30 of file ObTypes.h.

◆ ob_stream_profile

typedef struct ob_stream_profile_t ob_stream_profile

Definition at line 31 of file ObTypes.h.

◆ ob_stream_profile_list

typedef struct ob_stream_profile_list_t ob_stream_profile_list

Definition at line 32 of file ObTypes.h.

◆ ob_frame

typedef struct ob_frame_t ob_frame

Definition at line 33 of file ObTypes.h.

◆ ob_filter

typedef struct ob_filter_t ob_filter

Definition at line 34 of file ObTypes.h.

◆ ob_filter_list

typedef struct ob_filter_list_t ob_filter_list

Definition at line 35 of file ObTypes.h.

◆ ob_pipeline

typedef struct ob_pipeline_t ob_pipeline

Definition at line 36 of file ObTypes.h.

◆ ob_config

typedef struct ob_config_t ob_config

Definition at line 37 of file ObTypes.h.

◆ ob_depth_work_mode_list

typedef struct ob_depth_work_mode_list_t ob_depth_work_mode_list

Definition at line 38 of file ObTypes.h.

◆ ob_device_preset_list

typedef struct ob_device_preset_list_t ob_device_preset_list

Definition at line 39 of file ObTypes.h.

◆ ob_filter_config_schema_list

typedef struct ob_filter_config_schema_list_t ob_filter_config_schema_list

Definition at line 40 of file ObTypes.h.

◆ ob_device_frame_interleave_list

typedef struct ob_device_frame_interleave_list_t ob_device_frame_interleave_list

Definition at line 41 of file ObTypes.h.

◆ ob_preset_resolution_config_list

typedef struct ob_preset_resolution_config_list_t ob_preset_resolution_config_list

Definition at line 42 of file ObTypes.h.

◆ ob_permission_type

◆ ob_status

typedef enum OBStatus ob_status

◆ ob_log_severity

◆ DEVICE_LOG_SEVERITY_LEVEL

◆ OBDeviceLogSeverityLevel

◆ ob_device_log_severity_level

◆ ob_exception_type

◆ ob_error

typedef struct ob_error ob_error

The error class exposed by the SDK, users can get detailed error information according to the error.

◆ ob_sensor_type

◆ ob_stream_type

◆ ob_frame_type

typedef enum OBFrameType ob_frame_type

◆ ob_pixel_type

typedef enum OBPixelType ob_pixel_type

◆ ob_format

typedef enum OBFormat ob_format

◆ OBFwUpdateState

◆ ob_upgrade_state

◆ ob_fw_update_state

◆ ob_file_tran_state

◆ ob_data_tran_state

◆ ob_data_chunk

typedef struct OBDataChunk ob_data_chunk

◆ ob_int_property_range

◆ ob_float_property_range

◆ ob_uint16_property_range

◆ ob_uint8_property_range

◆ ob_bool_property_range

◆ ob_camera_distortion_model

◆ ob_camera_intrinsic

◆ ob_accel_intrinsic

◆ ob_gyro_intrinsic

◆ ob_camera_distortion

◆ ob_d2c_transform

◆ OBTransform

typedef struct OBD2CTransform OBTransform

◆ ob_transform

typedef struct OBD2CTransform ob_transform

◆ OBExtrinsic

typedef struct OBD2CTransform OBExtrinsic

◆ ob_extrinsic

typedef struct OBD2CTransform ob_extrinsic

◆ ob_camera_param

◆ ob_preset_resolution_ratio_config

◆ ob_calibration_param

◆ OBMarginFilterConfig

◆ ob_mgc_filter_config

◆ ob_align_mode

typedef enum OBAlignMode ob_align_mode

◆ ob_camera_performance_mode

◆ ob_rect

typedef struct OBRect ob_rect

◆ ob_convert_format

◆ OBGyroSampleRate

◆ ob_gyro_sample_rate

◆ OBAccelSampleRate

◆ ob_accel_sample_rate

◆ OB_SAMPLE_RATE

◆ ob_gyro_full_scale_range

◆ OB_GYRO_FULL_SCALE_RANGE

◆ ob_accel_full_scale_range

◆ OB_ACCEL_FULL_SCALE_RANGE

◆ OBGyroValue

typedef struct OBAccelValue OBGyroValue

◆ OBFloat3D

typedef struct OBAccelValue OBFloat3D

◆ ob_accel_value

typedef struct OBAccelValue ob_accel_value

◆ ob_gyro_value

typedef struct OBAccelValue ob_gyro_value

◆ ob_float_3d

typedef struct OBAccelValue ob_float_3d

◆ OBDeviceState

typedef uint64_t OBDeviceState

Device state.

Definition at line 647 of file ObTypes.h.

◆ ob_device_state

typedef uint64_t ob_device_state

Definition at line 647 of file ObTypes.h.

◆ ob_device_temperature

◆ DEVICE_TEMPERATURE

◆ ob_depth_cropping_mode

◆ OB_DEPTH_CROPPING_MODE

◆ ob_device_type

◆ OB_DEVICE_TYPE

◆ ob_media_type

typedef enum OBMediaType ob_media_type

◆ OB_MEDIA_TYPE

typedef enum OBMediaType OB_MEDIA_TYPE

◆ ob_media_state

◆ OB_MEDIA_STATE_EM

◆ ob_depth_precision_level

◆ OB_DEPTH_PRECISION_LEVEL

◆ OBDepthUnit

◆ ob_depth_unit

◆ ob_disparity_param

◆ ob_tof_filter_range

◆ TOF_FILTER_RANGE

◆ ob_point

typedef struct OBPoint ob_point

◆ OBPoint3f

typedef struct OBPoint OBPoint3f

◆ ob_point3f

typedef struct OBPoint ob_point3f

◆ ob_point2f

typedef struct OBPoint2f ob_point2f

◆ ob_xy_tables

typedef struct OBXYTables ob_xy_tables

◆ ob_color_point

typedef struct OBColorPoint ob_color_point

◆ ob_compression_mode

◆ OB_COMPRESSION_MODE

◆ ob_compression_params

◆ OB_COMPRESSION_PARAMS

◆ ob_tof_exposure_threshold_control

◆ TOF_EXPOSURE_THRESHOLD_CONTROL

◆ ob_sync_mode

typedef enum OBSyncMode ob_sync_mode

◆ OB_SYNC_MODE

typedef enum OBSyncMode OB_SYNC_MODE

◆ ob_device_sync_config

◆ OB_DEVICE_SYNC_CONFIG

◆ ob_depth_work_mode_tag

◆ ob_depth_work_mode

◆ ob_sequence_id_item

◆ ob_hole_filling_mode

◆ ob_spatial_fast_filter_params

◆ ob_spatial_moderate_filter_params

◆ ob_spatial_advanced_filter_params

◆ OBEdgeNoiseRemovalType

◆ ob_edge_noise_removal_type

◆ ob_edge_noise_removal_filter_params

◆ OBDDONoiseRemovalType

Denoising method.

◆ ob_ddo_noise_removal_type

◆ ob_noise_removal_filter_params

◆ ob_protocol_version

◆ OBCmdVersion

◆ ob_cmd_version

◆ ob_net_ip_config

◆ DEVICE_IP_ADDR_CONFIG

◆ ob_communication_type

◆ OB_COMMUNICATION_TYPE

◆ ob_usb_power_state

◆ ob_dc_power_state

◆ OBRotateDegreeType

◆ OBPowerLineFreqMode

◆ OBFrameAggregateOutputMode

◆ ob_frame_aggregate_output_mode

◆ OBCoordinateSystemType

◆ ob_coordinate_system_type

◆ OBDeviceDevelopmentMode

◆ ob_device_development_mode

◆ OBMultiDeviceSyncMode

◆ OBMultiDeviceSyncConfig

◆ OBDeviceTimestampResetConfig

◆ ob_baseline_calibration_param

◆ OBBaselineCalibrationParam

◆ ob_hdr_config

typedef struct HDR_CONFIG ob_hdr_config

◆ OBHdrConfig

typedef struct HDR_CONFIG OBHdrConfig

◆ ob_region_of_interest

typedef struct AE_ROI ob_region_of_interest

◆ OBRegionOfInterest

typedef struct AE_ROI OBRegionOfInterest

◆ ob_filter_config_value_type

◆ ob_filter_config_schema_item

◆ ob_device_serial_number

◆ OBSerialNumber

◆ ob_serial_number

◆ ob_disp_offset_config

◆ OBFrameMetadataType

◆ OBUvcBackendType

◆ OBPlaybackStatus

◆ OBIntraCameraSyncReference

◆ ob_file_send_callback

typedef void(* ob_file_send_callback) (ob_file_tran_state state, const char *message, uint8_t percent, void *user_data)

Callback for file transfer.

Parameters
stateTransmission status
messageTransfer status information
percentTransfer progress percentage
user_dataUser-defined data

Definition at line 1761 of file ObTypes.h.

◆ ob_device_fw_update_callback

typedef void(* ob_device_fw_update_callback) (ob_fw_update_state state, const char *message, uint8_t percent, void *user_data)

Callback for firmware upgrade.

Parameters
stateUpgrade status
messageUpgrade status information
percentUpgrade progress percentage
user_dataUser-defined data

Definition at line 1771 of file ObTypes.h.

◆ ob_device_state_callback

typedef void(* ob_device_state_callback) (ob_device_state state, const char *message, void *user_data)

Callback for device status.

Parameters
stateDevice status
messageDevice status information
user_dataUser-defined data

Definition at line 1780 of file ObTypes.h.

◆ ob_set_data_callback

typedef void(* ob_set_data_callback) (ob_data_tran_state state, uint8_t percent, void *user_data)

Callback for writing data.

Parameters
stateWrite data status
percentWrite data percentage
user_dataUser-defined data

Definition at line 1789 of file ObTypes.h.

◆ ob_get_data_callback

typedef void(* ob_get_data_callback) (ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data)

Callback for reading data.

Parameters
stateRead data status
dataChunkRead the returned data block
user_dataUser-defined data

Definition at line 1798 of file ObTypes.h.

◆ ob_media_state_callback

typedef void(* ob_media_state_callback) (ob_media_state state, void *user_data)

Callback for media status (recording and playback)

Parameters
stateCondition
user_dataUser-defined data

Definition at line 1806 of file ObTypes.h.

◆ ob_device_changed_callback

typedef void(* ob_device_changed_callback) (ob_device_list *removed, ob_device_list *added, void *user_data)

Callback for device change.

Parameters
removedList of deleted (dropped) devices
addedList of added (online) devices
user_dataUser-defined data

Definition at line 1815 of file ObTypes.h.

◆ ob_frame_callback

typedef void(* ob_frame_callback) (ob_frame *frame, void *user_data)

Callback for frame.

Parameters
frameFrame object
user_dataUser-defined data

Definition at line 1826 of file ObTypes.h.

◆ ob_frameset_callback

typedef void(* ob_frameset_callback) (ob_frame *frameset, void *user_data)

Callback for frameset.

Parameters
framesetFrameset object
user_dataUser-defined data

Definition at line 1836 of file ObTypes.h.

◆ ob_frame_destroy_callback

typedef void ob_frame_destroy_callback(uint8_t *buffer, void *user_data)

Customize the delete callback.

Parameters
bufferData that needs to be deleted
user_dataUser-defined data

Definition at line 1844 of file ObTypes.h.

◆ ob_log_callback

typedef void ob_log_callback(ob_log_severity severity, const char *message, void *user_data)

Callback for receiving log.

Parameters
severityCurrent log level
messageLog message
user_dataUser-defined data

Definition at line 1853 of file ObTypes.h.

◆ ob_playback_status_changed_callback

typedef void(* ob_playback_status_changed_callback) (ob_playback_status status, void *user_data)

Definition at line 1855 of file ObTypes.h.

Enumeration Type Documentation

◆ OBPermissionType

the permission type of api or property

Enumerator
OB_PERMISSION_DENY 

no permission

OB_PERMISSION_READ 

can read

OB_PERMISSION_WRITE 

can write

OB_PERMISSION_READ_WRITE 

can read and write

OB_PERMISSION_ANY 

any situation above

Definition at line 63 of file ObTypes.h.

◆ OBStatus

enum OBStatus

error code

Enumerator
OB_STATUS_OK 

status ok

OB_STATUS_ERROR 

status error

Definition at line 75 of file ObTypes.h.

◆ OBLogSeverity

log level, the higher the level, the stronger the log filter

Enumerator
OB_LOG_SEVERITY_DEBUG 

debug

OB_LOG_SEVERITY_INFO 

information

OB_LOG_SEVERITY_WARN 

warning

OB_LOG_SEVERITY_ERROR 

error

OB_LOG_SEVERITY_FATAL 

fatal error

OB_LOG_SEVERITY_OFF 

off (close LOG)

Definition at line 84 of file ObTypes.h.

◆ OBExceptionType

The exception types in the SDK, through the exception type, you can easily determine the specific type of error. For detailed error API interface functions and error logs, please refer to the information of ob_error.

Enumerator
OB_EXCEPTION_TYPE_UNKNOWN 

Unknown error, an error not clearly defined by the SDK

OB_EXCEPTION_STD_EXCEPTION 
OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED 

< Standard exception, an error caused by the standard library Camera/Device has been disconnected, the camera/device is not available

OB_EXCEPTION_TYPE_PLATFORM 

An error in the SDK adaptation platform layer, which means an error in the implementation of a specific system platform

OB_EXCEPTION_TYPE_INVALID_VALUE 

Invalid parameter type exception, need to check input parameter

OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE 

Wrong API call sequence, the API is called in the wrong order or the wrong parameter is passed

OB_EXCEPTION_TYPE_NOT_IMPLEMENTED 

SDK and firmware have not yet implemented this function or feature

OB_EXCEPTION_TYPE_IO 

SDK access IO exception error

OB_EXCEPTION_TYPE_MEMORY 

SDK access and use memory errors. For example, the frame fails to allocate memory

OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION 

Unsupported operation type error by SDK or device

Definition at line 99 of file ObTypes.h.

◆ OBSensorType

Enumeration value describing the sensor type.

Enumerator
OB_SENSOR_UNKNOWN 

Unknown type sensor

OB_SENSOR_IR 

IR

OB_SENSOR_COLOR 

Color

OB_SENSOR_DEPTH 

Depth

OB_SENSOR_ACCEL 

Accel

OB_SENSOR_GYRO 

Gyro

OB_SENSOR_IR_LEFT 

left IR for stereo camera

OB_SENSOR_IR_RIGHT 

Right IR for stereo camera

OB_SENSOR_RAW_PHASE 

Raw Phase

OB_SENSOR_CONFIDENCE 

Confidence

OB_SENSOR_TYPE_COUNT 

Definition at line 128 of file ObTypes.h.

◆ OBStreamType

Enumeration value describing the type of data stream.

Enumerator
OB_STREAM_UNKNOWN 

Unknown type stream

OB_STREAM_VIDEO 

Video stream (infrared, color, depth streams are all video streams)

OB_STREAM_IR 

IR stream

OB_STREAM_COLOR 

color stream

OB_STREAM_DEPTH 

depth stream

OB_STREAM_ACCEL 

Accelerometer data stream

OB_STREAM_GYRO 

Gyroscope data stream

OB_STREAM_IR_LEFT 

Left IR stream for stereo camera

OB_STREAM_IR_RIGHT 

Right IR stream for stereo camera

OB_STREAM_RAW_PHASE 

RawPhase Stream

OB_STREAM_CONFIDENCE 

Confidence Stream

OB_STREAM_TYPE_COUNT 

The total number of stream type,is not a valid stream type

Definition at line 146 of file ObTypes.h.

◆ OBFrameType

Enumeration value describing the type of frame.

Enumerator
OB_FRAME_UNKNOWN 

Unknown frame type

OB_FRAME_VIDEO 

Video frame

OB_FRAME_IR 

IR frame

OB_FRAME_COLOR 

Color frame

OB_FRAME_DEPTH 

Depth frame

OB_FRAME_ACCEL 

Accelerometer data frame

OB_FRAME_SET 

Frame collection (internally contains a variety of data frames)

OB_FRAME_POINTS 

Point cloud frame

OB_FRAME_GYRO 

Gyroscope data frame

OB_FRAME_IR_LEFT 

Left IR frame for stereo camera

OB_FRAME_IR_RIGHT 

Right IR frame for stereo camera

OB_FRAME_RAW_PHASE 

Raw Phase frame

OB_FRAME_CONFIDENCE 

Confidence frame

OB_FRAME_TYPE_COUNT 

The total number of frame types, is not a valid frame type

Definition at line 165 of file ObTypes.h.

◆ OBPixelType

Enumeration value describing the pixel type of frame (usually used for depth frame)

Enumerator
OB_PIXEL_UNKNOWN 
OB_PIXEL_DEPTH 
OB_PIXEL_DISPARITY 
OB_PIXEL_RAW_PHASE 
OB_PIXEL_TOF_DEPTH 

Definition at line 187 of file ObTypes.h.

◆ OBFormat

enum OBFormat

Enumeration value describing the pixel format.

Enumerator
OB_FORMAT_UNKNOWN 

unknown format

OB_FORMAT_YUYV 

YUYV format

OB_FORMAT_YUY2 

YUY2 format (the actual format is the same as YUYV)

OB_FORMAT_UYVY 

UYVY format

OB_FORMAT_NV12 

NV12 format

OB_FORMAT_NV21 

NV21 format

OB_FORMAT_MJPG 

MJPEG encoding format

OB_FORMAT_H264 

H.264 encoding format

OB_FORMAT_H265 

H.265 encoding format

OB_FORMAT_Y16 

Y16 format, 16-bit per pixel, single-channel

OB_FORMAT_Y8 

Y8 format, 8-bit per pixel, single-channel

OB_FORMAT_Y10 

Y10 format, 10-bit per pixel, single-channel(SDK will unpack into Y16 by default)

OB_FORMAT_Y11 

Y11 format, 11-bit per pixel, single-channel (SDK will unpack into Y16 by default)

OB_FORMAT_Y12 

Y12 format, 12-bit per pixel, single-channel(SDK will unpack into Y16 by default)

OB_FORMAT_GRAY 

GRAY (the actual format is the same as YUYV)

OB_FORMAT_HEVC 

HEVC encoding format (the actual format is the same as H265)

OB_FORMAT_I420 

I420 format

OB_FORMAT_ACCEL 

Acceleration data format

OB_FORMAT_GYRO 

Gyroscope data format

OB_FORMAT_POINT 

XYZ 3D coordinate point format, OBPoint

OB_FORMAT_RGB_POINT 

XYZ 3D coordinate point format with RGB information, OBColorPoint

OB_FORMAT_RLE 

RLE pressure test format (SDK will be unpacked into Y16 by default)

OB_FORMAT_RGB 

RGB format (actual RGB888)

OB_FORMAT_BGR 

BGR format (actual BGR888)

OB_FORMAT_Y14 

Y14 format, 14-bit per pixel, single-channel (SDK will unpack into Y16 by default)

OB_FORMAT_BGRA 

BGRA format

OB_FORMAT_COMPRESSED 

Compression format

OB_FORMAT_RVL 

RVL pressure test format (SDK will be unpacked into Y16 by default)

OB_FORMAT_Z16 

Is same as Y16

OB_FORMAT_YV12 

Is same as Y12, using for right ir stream

OB_FORMAT_BA81 

Is same as Y8, using for right ir stream

OB_FORMAT_RGBA 

RGBA format

OB_FORMAT_BYR2 

byr2 format

OB_FORMAT_RW16 

RAW16 format

OB_FORMAT_Y12C4 

Y12C4 format

Definition at line 199 of file ObTypes.h.

◆ OBUpgradeState

Enumeration value describing the firmware upgrade status.

Enumerator
STAT_DONE_WITH_DUPLICATES 

update completed, but some files were duplicated and ignored

STAT_VERIFY_SUCCESS 

Image file verifify success

STAT_FILE_TRANSFER 

file transfer

STAT_DONE 

update completed

STAT_IN_PROGRESS 

upgrade in process

STAT_START 

start the upgrade

STAT_VERIFY_IMAGE 

Image file verification

ERR_VERIFY 

Verification failed

ERR_PROGRAM 

Program execution failed

ERR_ERASE 

Flash parameter failed

ERR_FLASH_TYPE 

Flash type error

ERR_IMAGE_SIZE 

Image file size error

ERR_OTHER 

other errors

ERR_DDR 

DDR access error

ERR_TIMEOUT 

timeout error

ERR_MISMATCH 

Mismatch firmware error

ERR_UNSUPPORT_DEV 

Unsupported device error

ERR_INVALID_COUNT 

invalid firmware/preset count

Definition at line 253 of file ObTypes.h.

◆ OBFileTranState

Enumeration value describing the file transfer status.

Enumerator
FILE_TRAN_STAT_TRANSFER 

File transfer

FILE_TRAN_STAT_DONE 

File transfer succeeded

FILE_TRAN_STAT_PREPAR 

Preparing

FILE_TRAN_ERR_DDR 

DDR access failed

FILE_TRAN_ERR_NOT_ENOUGH_SPACE 

Insufficient target space error

FILE_TRAN_ERR_PATH_NOT_WRITABLE 

Destination path is not writable

FILE_TRAN_ERR_MD5_ERROR 

MD5 checksum error

FILE_TRAN_ERR_WRITE_FLASH_ERROR 

Write flash error

FILE_TRAN_ERR_TIMEOUT 

Timeout error

Definition at line 278 of file ObTypes.h.

◆ OBDataTranState

Enumeration value describing the data transfer status.

Enumerator
DATA_TRAN_STAT_VERIFY_DONE 

data verify done

DATA_TRAN_STAT_STOPPED 

data transfer stoped

DATA_TRAN_STAT_DONE 

data transfer completed

DATA_TRAN_STAT_VERIFYING 

data verifying

DATA_TRAN_STAT_TRANSFERRING 

data transferring

DATA_TRAN_ERR_BUSY 

Transmission is busy

DATA_TRAN_ERR_UNSUPPORTED 

Not supported

DATA_TRAN_ERR_TRAN_FAILED 

Transfer failed

DATA_TRAN_ERR_VERIFY_FAILED 

Test failed

DATA_TRAN_ERR_OTHER 

Other errors

Definition at line 294 of file ObTypes.h.

◆ OBCameraDistortionModel

Distortion model: defines how pixel coordinates should be mapped to sensor coordinates.

Enumerator
OB_DISTORTION_NONE 

Rectilinear images. No distortion compensation required.

OB_DISTORTION_MODIFIED_BROWN_CONRADY 

Equivalent to Brown-Conrady distortion, except that tangential distortion is applied to radially distorted points

OB_DISTORTION_INVERSE_BROWN_CONRADY 

Equivalent to Brown-Conrady distortion, except undistorts image instead of distorting it

OB_DISTORTION_BROWN_CONRADY 

Unmodified Brown-Conrady distortion model

OB_DISTORTION_BROWN_CONRADY_K6 

Unmodified Brown-Conrady distortion model with k6 supported

OB_DISTORTION_KANNALA_BRANDT4 

Kannala-Brandt distortion model

Definition at line 374 of file ObTypes.h.

◆ OBAlignMode

Alignment mode.

Enumerator
ALIGN_DISABLE 

Turn off alignment

ALIGN_D2C_HW_MODE 

Hardware D2C alignment mode

ALIGN_D2C_SW_MODE 

Software D2C alignment mode

Definition at line 506 of file ObTypes.h.

◆ OBCameraPerformanceMode

Camera performance mode.

Enumerator
ADAPTIVE_PERFORMANCE_MODE 

Camera adaptive mode

HIGH_PERFORMANCE_MODE 

High Performance Mode

Definition at line 516 of file ObTypes.h.

◆ OBConvertFormat

Enumeration of format conversion types.

Enumerator
FORMAT_YUYV_TO_RGB 

YUYV to RGB

FORMAT_I420_TO_RGB 

I420 to RGB

FORMAT_NV21_TO_RGB 

NV21 to RGB

FORMAT_NV12_TO_RGB 

NV12 to RGB

FORMAT_MJPG_TO_I420 

MJPG to I420

FORMAT_RGB_TO_BGR 

RGB888 to BGR

FORMAT_MJPG_TO_NV21 

MJPG to NV21

FORMAT_MJPG_TO_RGB 

MJPG to RGB

FORMAT_MJPG_TO_BGR 

MJPG to BGR

FORMAT_MJPG_TO_BGRA 

MJPG to BGRA

FORMAT_UYVY_TO_RGB 

UYVY to RGB

FORMAT_BGR_TO_RGB 

BGR to RGB

FORMAT_MJPG_TO_NV12 

MJPG to NV12

FORMAT_YUYV_TO_BGR 

YUYV to BGR

FORMAT_YUYV_TO_RGBA 

YUYV to RGBA

FORMAT_YUYV_TO_BGRA 

YUYV to BGRA

FORMAT_YUYV_TO_Y16 

YUYV to Y16

FORMAT_YUYV_TO_Y8 

YUYV to Y8

FORMAT_RGBA_TO_RGB 

RGBA to RGB

FORMAT_BGRA_TO_BGR 

BGRA to BGR

FORMAT_Y16_TO_RGB 

Y16 to RGB

FORMAT_Y8_TO_RGB 

Y8 to RGB

Definition at line 535 of file ObTypes.h.

◆ OBIMUSampleRate

Enumeration of IMU sample rate values (gyroscope or accelerometer)

Enumerator
OB_SAMPLE_RATE_UNKNOWN 
OB_SAMPLE_RATE_1_5625_HZ 

1.5625Hz

OB_SAMPLE_RATE_3_125_HZ 

3.125Hz

OB_SAMPLE_RATE_6_25_HZ 

6.25Hz

OB_SAMPLE_RATE_12_5_HZ 

12.5Hz

OB_SAMPLE_RATE_25_HZ 

25Hz

OB_SAMPLE_RATE_50_HZ 

50Hz

OB_SAMPLE_RATE_100_HZ 

100Hz

OB_SAMPLE_RATE_200_HZ 

200Hz

OB_SAMPLE_RATE_500_HZ 

500Hz

OB_SAMPLE_RATE_1_KHZ 

1KHz

OB_SAMPLE_RATE_2_KHZ 

2KHz

OB_SAMPLE_RATE_4_KHZ 

4KHz

OB_SAMPLE_RATE_8_KHZ 

8KHz

OB_SAMPLE_RATE_16_KHZ 

16KHz

OB_SAMPLE_RATE_32_KHZ 

32Hz

OB_SAMPLE_RATE_400_HZ 

400Hz

OB_SAMPLE_RATE_800_HZ 

800Hz

Definition at line 579 of file ObTypes.h.

◆ OBGyroFullScaleRange

Enumeration of gyroscope ranges.

Enumerator
OB_GYRO_FS_UNKNOWN 
OB_GYRO_FS_16dps 

16 degrees per second

OB_GYRO_FS_31dps 

31 degrees per second

OB_GYRO_FS_62dps 

62 degrees per second

OB_GYRO_FS_125dps 

125 degrees per second

OB_GYRO_FS_250dps 

250 degrees per second

OB_GYRO_FS_500dps 

500 degrees per second

OB_GYRO_FS_1000dps 

1000 degrees per second

OB_GYRO_FS_2000dps 

2000 degrees per second

OB_GYRO_FS_400dps 

400 degrees per second

OB_GYRO_FS_800dps 

800 degrees per second

Definition at line 604 of file ObTypes.h.

◆ OBAccelFullScaleRange

Enumeration of accelerometer ranges.

Enumerator
OB_ACCEL_FS_UNKNOWN 
OB_ACCEL_FS_2g 

1x the acceleration of gravity

OB_ACCEL_FS_4g 

4x the acceleration of gravity

OB_ACCEL_FS_8g 

8x the acceleration of gravity

OB_ACCEL_FS_16g 

16x the acceleration of gravity

OB_ACCEL_FS_3g 

3x the acceleration of gravity

OB_ACCEL_FS_6g 

6x the acceleration of gravity

OB_ACCEL_FS_12g 

12x the acceleration of gravity

OB_ACCEL_FS_24g 

24x the acceleration of gravity

Definition at line 622 of file ObTypes.h.

◆ OBDepthCroppingMode

Enumeration for depth crop modes.

Enumerator
DEPTH_CROPPING_MODE_AUTO 

Automatic mode

DEPTH_CROPPING_MODE_CLOSE 

Close crop

DEPTH_CROPPING_MODE_OPEN 

Open crop

Definition at line 669 of file ObTypes.h.

◆ OBDeviceType

Enumeration for device types.

Enumerator
OB_DEVICE_TYPE_UNKNOWN 

Unknown device type

OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA 

Monocular structured light camera

OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA 

Binocular structured light camera

OB_TOF_CAMERA 

Time-of-flight camera

Definition at line 679 of file ObTypes.h.

◆ OBMediaType

Enumeration for types of media to record or playback.

Enumerator
OB_MEDIA_COLOR_STREAM 

Color stream

OB_MEDIA_DEPTH_STREAM 

Depth stream

OB_MEDIA_IR_STREAM 

Infrared stream

OB_MEDIA_GYRO_STREAM 

Gyroscope stream

OB_MEDIA_ACCEL_STREAM 

Accelerometer stream

OB_MEDIA_CAMERA_PARAM 

Camera parameter

OB_MEDIA_DEVICE_INFO 

Device information

OB_MEDIA_STREAM_INFO 

Stream information

OB_MEDIA_IR_LEFT_STREAM 

Left infrared stream

OB_MEDIA_IR_RIGHT_STREAM 

Right infrared stream

OB_MEDIA_ALL 

All media data types

Definition at line 690 of file ObTypes.h.

◆ OBMediaState

Enumeration for record playback status.

Enumerator
OB_MEDIA_BEGIN 

Begin

OB_MEDIA_PAUSE 

Pause

OB_MEDIA_RESUME 

Resume

OB_MEDIA_END 

End

Definition at line 710 of file ObTypes.h.

◆ OBDepthPrecisionLevel

Enumeration for depth precision levels.

Attention
The depth precision level does not completely determine the depth unit and real precision, and the influence of the data packaging format needs to be considered. The specific unit can be obtained through getValueScale() of DepthFrame
Enumerator
OB_PRECISION_1MM 

1mm

OB_PRECISION_0MM8 

0.8mm

OB_PRECISION_0MM4 

0.4mm

OB_PRECISION_0MM1 

0.1mm

OB_PRECISION_0MM2 

0.2mm

OB_PRECISION_0MM5 

0.5mm

OB_PRECISION_0MM05 

0.05mm

OB_PRECISION_UNKNOWN 
OB_PRECISION_COUNT 

Definition at line 723 of file ObTypes.h.

◆ OBTofFilterRange

Enumeration for TOF filter scene ranges.

Enumerator
OB_TOF_FILTER_RANGE_CLOSE 

Close range

OB_TOF_FILTER_RANGE_MIDDLE 

Middle range

OB_TOF_FILTER_RANGE_LONG 

Long range

OB_TOF_FILTER_RANGE_DEBUG 

Debug range

Definition at line 758 of file ObTypes.h.

◆ OBCompressionMode

Compression mode.

Enumerator
OB_COMPRESSION_LOSSLESS 

Lossless compression mode

OB_COMPRESSION_LOSSY 

Lossy compression mode

Definition at line 804 of file ObTypes.h.

◆ OBSyncMode

enum OBSyncMode

Sync mode.

Deprecated
This define is deprecated, please use ob_multi_device_sync_mode instead
Enumerator
OB_SYNC_MODE_CLOSE 

Close synchronize mode.

Single device, neither process input trigger signal nor output trigger signal

Each Sensor in a single device automatically triggers

OB_SYNC_MODE_STANDALONE 

Standalone synchronize mode.

Single device, neither process input trigger signal nor output trigger signal

Inside single device, RGB as Major sensor: RGB -> IR/Depth/TOF

OB_SYNC_MODE_PRIMARY 

Primary synchronize mode.

Primary device. Ignore process input trigger signal, only output trigger signal to secondary devices.

Inside single device, RGB as Major sensor: RGB -> IR/Depth/TOF

OB_SYNC_MODE_SECONDARY 

Secondary synchronize mode.

Secondary device. Both process input trigger signal and output trigger signal to other devices.

Different sensors in a single devices receive trigger signals respectively: ext trigger -> RGB && ext trigger -> IR/Depth/TOF

Attention
With the current Gemini 2 device set to this mode, each Sensor receives the first external trigger signal after the stream is turned on and starts timing self-triggering at the set frame rate until the stream is turned off
OB_SYNC_MODE_PRIMARY_MCU_TRIGGER 

MCU Primary synchronize mode.

Primary device. Ignore process input trigger signal, only output trigger signal to secondary devices.

Inside device, MCU is the primary signal source: MCU -> RGB && MCU -> IR/Depth/TOF

OB_SYNC_MODE_PRIMARY_IR_TRIGGER 

IR Primary synchronize mode.

Primary device. Ignore process input trigger signal, only output trigger signal to secondary devices.

Inside device, IR is the primary signal source: IR/Depth/TOF -> RGB

OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER 

Software trigger synchronize mode.

Host, triggered by software control (receive the upper computer command trigger), at the same time to the trunk output trigger signal

Different sensors in a single machine receive trigger signals respectively: soft trigger -> RGB && soft trigger -> IR/Depth/TOF

Attention
Support product: Gemini2
OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER 

Software trigger synchronize mode as secondary device.

The slave receives the external trigger signal (the external trigger signal comes from the soft trigger host) and outputs the trigger signal to the external relay.

Different sensors in a single machine receive trigger signals respectively: ext trigger -> RGB && ext trigger -> IR/Depth/TOF

OB_SYNC_MODE_IR_IMU_SYNC 

IR and IMU sync signal.

OB_SYNC_MODE_UNKNOWN 

Unknown type.

Definition at line 832 of file ObTypes.h.

◆ OBDepthWorkModeTag

Preset tag.

Enumerator
OB_DEVICE_DEPTH_WORK_MODE 
OB_CUSTOM_DEPTH_WORK_MODE 

Definition at line 969 of file ObTypes.h.

◆ OBHoleFillingMode

Hole fillig mode.

Enumerator
OB_HOLE_FILL_TOP 
OB_HOLE_FILL_NEAREST 
OB_HOLE_FILL_FAREST 

Definition at line 1006 of file ObTypes.h.

◆ OB_EDGE_NOISE_REMOVAL_TYPE

Enumerator
OB_MG_FILTER 
OB_MGH_FILTER 
OB_MGA_FILTER 
OB_MGC_FILTER 

Definition at line 1030 of file ObTypes.h.

◆ OB_DDO_NOISE_REMOVAL_TYPE

Denoising method.

Enumerator
OB_NR_LUT 
OB_NR_OVERALL 

Definition at line 1049 of file ObTypes.h.

◆ OB_CMD_VERSION

Command version associated with property id.

Enumerator
OB_CMD_VERSION_V0 

Version 1.0.

OB_CMD_VERSION_V1 

Version 2.0.

OB_CMD_VERSION_V2 

Version 3.0.

OB_CMD_VERSION_V3 

Version 4.0.

OB_CMD_VERSION_NOVERSION 
OB_CMD_VERSION_INVALID 

Invalid version.

Definition at line 1084 of file ObTypes.h.

◆ OBCommunicationType

Device communication mode.

Enumerator
OB_COMM_USB 

USB.

OB_COMM_NET 

Ethernet.

Definition at line 1128 of file ObTypes.h.

◆ OBUSBPowerState

USB power status.

Enumerator
OB_USB_POWER_NO_PLUGIN 

No plugin.

OB_USB_POWER_5V_0A9 

5V/0.9A

OB_USB_POWER_5V_1A5 

5V/1.5A

OB_USB_POWER_5V_3A0 

5V/3.0A

Definition at line 1137 of file ObTypes.h.

◆ OBDCPowerState

DC power status.

Enumerator
OB_DC_POWER_NO_PLUGIN 

No plugin.

OB_DC_POWER_PLUGIN 

Plugin.

Definition at line 1148 of file ObTypes.h.

◆ ob_rotate_degree_type

Rotate degree.

Enumerator
OB_ROTATE_DEGREE_0 

Rotate 0.

OB_ROTATE_DEGREE_90 

Rotate 90.

OB_ROTATE_DEGREE_180 

Rotate 180.

OB_ROTATE_DEGREE_270 

Rotate 270.

Definition at line 1157 of file ObTypes.h.

◆ ob_power_line_freq_mode

Power line frequency mode, for color camera anti-flicker configuration.

Enumerator
OB_POWER_LINE_FREQ_MODE_CLOSE 

Close.

OB_POWER_LINE_FREQ_MODE_50HZ 

50Hz

OB_POWER_LINE_FREQ_MODE_60HZ 

60Hz

Definition at line 1168 of file ObTypes.h.

◆ OB_FRAME_AGGREGATE_OUTPUT_MODE

Frame aggregate output mode.

Enumerator
OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE 

Only FrameSet that contains all types of data frames will be output.

OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE 

Color Frame Require output mode.

Suitable for Color using H264, H265 and other inter-frame encoding format open stream

Attention
In this mode, the user may return null when getting a non-Color type data frame from the acquired FrameSet
OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION 

FrameSet for any case will be output.

Attention
In this mode, the user may return null when getting the specified type of data frame from the acquired FrameSet
OB_FRAME_AGGREGATE_OUTPUT_DISABLE 

Disable Frame Aggreate.

Attention
In this mode, All types of data frames will output independently.

Definition at line 1178 of file ObTypes.h.

◆ OB_COORDINATE_SYSTEM_TYPE

Enumeration of point cloud coordinate system types.

Enumerator
OB_LEFT_HAND_COORDINATE_SYSTEM 
OB_RIGHT_HAND_COORDINATE_SYSTEM 

Definition at line 1211 of file ObTypes.h.

◆ OB_DEVICE_DEVELOPMENT_MODE

Enumeration of device development modes.

Enumerator
OB_USER_MODE 

User mode (default mode), which provides full camera device functionality.

OB_DEVELOPER_MODE 

Developer mode, which allows developers to access the operating system and software/hardware resources on the device directly.

Definition at line 1220 of file ObTypes.h.

◆ ob_multi_device_sync_mode

The synchronization mode of the device.

Enumerator
OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN 

free run mode

The device does not synchronize with other devices,

The Color and Depth can be set to different frame rates.

OB_MULTI_DEVICE_SYNC_MODE_STANDALONE 

standalone mode

The device does not synchronize with other devices.

The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized.

OB_MULTI_DEVICE_SYNC_MODE_PRIMARY 

primary mode

The device is the primary device in the multi-device system, it will output the trigger signal via VSYNC_OUT pin on synchronization port by default.

The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs.

OB_MULTI_DEVICE_SYNC_MODE_SECONDARY 

secondary mode

The device is the secondary device in the multi-device system, it will receive the trigger signal via VSYNC_IN pin on synchronization port. It will out the trigger signal via VSYNC_OUT pin on synchronization port by default.

The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs.

After starting the stream, the device will wait for the trigger signal to start capturing images, and will stop capturing images when the trigger signal is stopped.

Attention
The frequency of the trigger signal should be same as the frame rate of the stream profile which is set when starting the stream.
OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED 

secondary synced mode

The device is the secondary device in the multi-device system, it will receive the trigger signal via VSYNC_IN pin on synchronization port. It will out the trigger signal via VSYNC_OUT pin on synchronization port by default.

The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs.

After starting the stream, the device will be immediately start capturing images, and will adjust the capture time when the trigger signal is received to synchronize with the primary device. If the trigger signal is stopped, the device will still capture images.

Attention
The frequency of the trigger signal should be same as the frame rate of the stream profile which is set when starting the stream.
OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING 

software triggering mode

The device will start one time image capture after receiving the capture command and will output the trigger signal via VSYNC_OUT pin by default. The capture command can be sent form host by call ob_device_trigger_capture. The number of images captured each time can be set by framesPerTrigger.

The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs.

The frequency of the user call ob_device_trigger_capture to send the capture command multiplied by the number of frames per trigger should be less than the frame rate of the stream profile which is set when starting the stream.

OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING 

hardware triggering mode

The device will start one time image capture after receiving the trigger signal via VSYNC_IN pin on synchronization port and will output the trigger signal via VSYNC_OUT pin by default. The number of images captured each time can be set by framesPerTrigger.

The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs.

Attention
The frequency of the trigger signal multiplied by the number of frames per trigger should be less than the frame rate of the stream profile which is set when starting the stream.
The trigger signal input via VSYNC_IN pin on synchronization port should be ouput by other device via VSYNC_OUT pin in hardware triggering mode or software triggering mode.
Due to different models may have different signal input requirements, please do not use different models to output trigger signal as input-trigger signal.
OB_MULTI_DEVICE_SYNC_MODE_IR_IMU_SYNC 

IR and IMU sync mode.

Definition at line 1236 of file ObTypes.h.

◆ OBFilterConfigValueType

Enumerator
OB_FILTER_CONFIG_VALUE_TYPE_INVALID 
OB_FILTER_CONFIG_VALUE_TYPE_INT 
OB_FILTER_CONFIG_VALUE_TYPE_FLOAT 
OB_FILTER_CONFIG_VALUE_TYPE_BOOLEAN 

Definition at line 1459 of file ObTypes.h.

◆ ob_frame_metadata_type

Frame metadata types.

The frame metadata is a set of meta info generated by the device for current individual frame.

Enumerator
OB_FRAME_METADATA_TYPE_TIMESTAMP 

Timestamp when the frame is captured.

Attention
Different device models may have different units. It is recommended to use the timestamp related functions to get the timestamp in the correct units.
OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP 

Timestamp in the middle of the capture.

Usually is the middle of the exposure time.

Attention
Different device models may have different units.
OB_FRAME_METADATA_TYPE_FRAME_NUMBER 

The number of current frame.

OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE 

Auto exposure status.

If the value is 0, it means the auto exposure is disabled. Otherwise, it means the auto exposure is enabled.

OB_FRAME_METADATA_TYPE_EXPOSURE 

Exposure time.

Attention
Different sensor may have different units. Usually, it is 100us for color sensor and 1us for depth/infrared sensor.
OB_FRAME_METADATA_TYPE_GAIN 

Gain.

Attention
For some device models, the gain value represents the gain level, not the multiplier.
OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE 

Auto white balance status.

If the value is 0, it means the auto white balance is disabled. Otherwise, it means the auto white balance is enabled.

OB_FRAME_METADATA_TYPE_WHITE_BALANCE 

White balance.

OB_FRAME_METADATA_TYPE_BRIGHTNESS 

Brightness.

OB_FRAME_METADATA_TYPE_CONTRAST 

Contrast.

OB_FRAME_METADATA_TYPE_SATURATION 

Saturation.

OB_FRAME_METADATA_TYPE_SHARPNESS 

Sharpness.

OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION 

Backlight compensation.

OB_FRAME_METADATA_TYPE_HUE 

Hue.

OB_FRAME_METADATA_TYPE_GAMMA 

Gamma.

OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY 

Power line frequency.

For anti-flickering, 0: Close, 1: 50Hz, 2: 60Hz, 3: Auto

OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION 

Low light compensation.

Attention
The low light compensation is a feature inside the device, and can not manually control it.
OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE 

Manual white balance setting.

OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE 

Actual frame rate.

The actual frame rate will be calculated according to the exposure time and other parameters.

OB_FRAME_METADATA_TYPE_FRAME_RATE 

Frame rate.

OB_FRAME_METADATA_TYPE_AE_ROI_LEFT 

Left region of interest for the auto exposure Algorithm.

OB_FRAME_METADATA_TYPE_AE_ROI_TOP 

Top region of interest for the auto exposure Algorithm.

OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT 

Right region of interest for the auto exposure Algorithm.

OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM 

Bottom region of interest for the auto exposure Algorithm.

OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY 

Exposure priority.

OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME 

HDR sequence name.

OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE 

HDR sequence size.

OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX 

HDR sequence index.

OB_FRAME_METADATA_TYPE_LASER_POWER 

Laser power value in mW.

Attention
The laser power value is an approximate estimation.
OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL 

Laser power level.

OB_FRAME_METADATA_TYPE_LASER_STATUS 

Laser status.

0: Laser off, 1: Laser on

OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA 

GPIO input data.

OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_OFFSET 

disparity search offset value

OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_RANGE 

disparity search range

OB_FRAME_METADATA_TYPE_COUNT 

The number of frame metadata types, using for types iterating.

Attention
It is not a valid frame metadata type

Definition at line 1500 of file ObTypes.h.

◆ ob_uvc_backend_type

For Linux, there are two ways to access the UVC device, libuvc and v4l2. The backend type is used to select the backend to access the device.

Enumerator
OB_UVC_BACKEND_TYPE_AUTO 

Auto detect system capabilities and device hint to select backend.

OB_UVC_BACKEND_TYPE_LIBUVC 

Use libuvc backend to access the UVC device.

OB_UVC_BACKEND_TYPE_V4L2 

Use v4l2 backend to access the UVC device.

OB_UVC_BACKEND_TYPE_MSMF 

Use MSMF backend to access the UVC device.

Definition at line 1701 of file ObTypes.h.

◆ ob_playback_status

The playback status of the media.

Enumerator
OB_PLAYBACK_UNKNOWN 
OB_PLAYBACK_PLAYING 

The media is playing

OB_PLAYBACK_PAUSED 

The media is paused

OB_PLAYBACK_STOPPED 

The media is stopped

OB_PLAYBACK_COUNT 

Definition at line 1730 of file ObTypes.h.

◆ ob_intra_camera_sync_reference

Intra-camera Sync Reference based on the exposure start time, the exposure middle time, or the exposure end time.

Enumerator
START_OF_EXPOSURE 

start of exposure

MIDDLE_OF_EXPOSURE 

middle of exposure

END_OF_EXPOSURE 

end of exposure

Definition at line 1742 of file ObTypes.h.