Skip to main content Crate orbbec_sdk_sys Copy item path Source pub use self::OBPermissionType as ob_permission_type;pub use self::OBStatus as ob_status;pub use self::OBLogSeverity as ob_log_severity;pub use self::OBLogSeverity as DEVICE_LOG_SEVERITY_LEVEL;pub use self::OBLogSeverity as OBDeviceLogSeverityLevel;pub use self::OBLogSeverity as ob_device_log_severity_level;pub use self::OBExceptionType as ob_exception_type;pub use self::OBSensorType as ob_sensor_type;pub use self::OBStreamType as ob_stream_type;pub use self::OBFrameType as ob_frame_type;pub use self::OBPixelType as ob_pixel_type;pub use self::OBFormat as ob_format;pub use self::OBUpgradeState as OBFwUpdateState;pub use self::OBUpgradeState as ob_upgrade_state;pub use self::OBUpgradeState as ob_fw_update_state;pub use self::OBFileTranState as ob_file_tran_state;pub use self::OBDataTranState as ob_data_tran_state;pub use self::OBCameraDistortionModel as ob_camera_distortion_model;pub use self::OBAlignMode as ob_align_mode;pub use self::OBCameraPerformanceMode as ob_camera_performance_mode;pub use self::OBConvertFormat as ob_convert_format;pub use self::OBIMUSampleRate as OBGyroSampleRate;pub use self::OBIMUSampleRate as ob_gyro_sample_rate;pub use self::OBIMUSampleRate as OBAccelSampleRate;pub use self::OBIMUSampleRate as ob_accel_sample_rate;pub use self::OBIMUSampleRate as OB_SAMPLE_RATE;pub use self::OBGyroFullScaleRange as ob_gyro_full_scale_range;pub use self::OBGyroFullScaleRange as OB_GYRO_FULL_SCALE_RANGE;pub use self::OBAccelFullScaleRange as ob_accel_full_scale_range;pub use self::OBAccelFullScaleRange as OB_ACCEL_FULL_SCALE_RANGE;pub use self::OBDepthCroppingMode as ob_depth_cropping_mode;pub use self::OBDepthCroppingMode as OB_DEPTH_CROPPING_MODE;pub use self::OBDeviceType as ob_device_type;pub use self::OBDeviceType as OB_DEVICE_TYPE;pub use self::OBMediaType as ob_media_type;pub use self::OBMediaType as OB_MEDIA_TYPE;pub use self::OBMediaState as ob_media_state;pub use self::OBMediaState as OB_MEDIA_STATE_EM;pub use self::OBDepthPrecisionLevel as ob_depth_precision_level;pub use self::OBDepthPrecisionLevel as OB_DEPTH_PRECISION_LEVEL;pub use self::OBDepthPrecisionLevel as OBDepthUnit;pub use self::OBDepthPrecisionLevel as ob_depth_unit;pub use self::OBTofFilterRange as ob_tof_filter_range;pub use self::OBTofFilterRange as TOF_FILTER_RANGE;pub use self::OBCompressionMode as ob_compression_mode;pub use self::OBCompressionMode as OB_COMPRESSION_MODE;pub use self::OBSyncMode as ob_sync_mode;pub use self::OBSyncMode as OB_SYNC_MODE;pub use self::OBDepthWorkModeTag as ob_depth_work_mode_tag;pub use self::OBHoleFillingMode as ob_hole_filling_mode;pub use self::OB_EDGE_NOISE_REMOVAL_TYPE as OBEdgeNoiseRemovalType;pub use self::OB_EDGE_NOISE_REMOVAL_TYPE as ob_edge_noise_removal_type;pub use self::OB_DDO_NOISE_REMOVAL_TYPE as OBDDONoiseRemovalType;pub use self::OB_DDO_NOISE_REMOVAL_TYPE as ob_ddo_noise_removal_type;pub use self::OB_CMD_VERSION as OBCmdVersion;pub use self::OB_CMD_VERSION as ob_cmd_version;pub use self::OBCommunicationType as ob_communication_type;pub use self::OBCommunicationType as OB_COMMUNICATION_TYPE;pub use self::OBUSBPowerState as ob_usb_power_state;pub use self::OBDCPowerState as ob_dc_power_state;pub use self::ob_rotate_degree_type as OBRotateDegreeType;pub use self::ob_power_line_freq_mode as OBPowerLineFreqMode;pub use self::OB_FRAME_AGGREGATE_OUTPUT_MODE as OBFrameAggregateOutputMode;pub use self::OB_FRAME_AGGREGATE_OUTPUT_MODE as ob_frame_aggregate_output_mode;pub use self::OB_COORDINATE_SYSTEM_TYPE as OBCoordinateSystemType;pub use self::OB_COORDINATE_SYSTEM_TYPE as ob_coordinate_system_type;pub use self::OB_DEVICE_DEVELOPMENT_MODE as OBDeviceDevelopmentMode;pub use self::OB_DEVICE_DEVELOPMENT_MODE as ob_device_development_mode;pub use self::ob_multi_device_sync_mode as OBMultiDeviceSyncMode;pub use self::OBFilterConfigValueType as ob_filter_config_value_type;pub use self::ob_frame_metadata_type as OBFrameMetadataType;pub use self::ob_uvc_backend_type as OBUvcBackendType;pub use self::ob_playback_status as OBPlaybackStatus;pub use self::ob_intra_camera_sync_reference as OBIntraCameraSyncReference;pub use self::OBPropertyID as ob_property_id;pub use self::OBPropertyType as ob_property_type;AE_ROI @brief The rect of the region of interest BASELINE_CALIBRATION_PARAM @brief Baseline calibration parameters HDR_CONFIG @brief HDR Configuration OBAccelIntrinsic @brief Structure for accelerometer intrinsic parameters OBAccelValue @brief Data structures for accelerometers and gyroscopes OBBoolPropertyRange @brief Structure for boolean range OBCalibrationParam @brief calibration parameters OBCameraDistortion @brief Structure for distortion parameters OBCameraIntrinsic @brief Structure for camera intrinsic parameters OBCameraParam @brief Structure for camera parameters OBColorPoint @brief 3D point structure with color information OBCompressionParams Compression Params OBD2CTransform @brief Structure for rotation/transformation OBDataChunk @brief Structure for transmitting data blocks OBDepthWorkMode @brief Depth work mode OBDeviceSerialNumber @brief struct of serial number OBDeviceSyncConfig @brief Device synchronization configuration
@deprecated This structure is deprecated, please use @ref ob_multi_device_sync_config instead OBDeviceTemperature @brief Temperature parameters of the device (unit: Celsius) OBDispOffsetConfig @brief Disparity offset interleaving configuration OBDisparityParam @brief disparity parameters for disparity based camera OBEdgeNoiseRemovalFilterParams OBFilterConfigSchemaItem @brief Configuration Item for the filter OBFloatPropertyRange @brief Structure for float range OBGyroIntrinsic @brief Structure for gyroscope intrinsic parameters OBIntPropertyRange @brief Structure for integer range OBMGCFilterConfig @brief Configuration for mgc filter OBNetIpConfig @brief IP address configuration for network devices (IPv4) OBNoiseRemovalFilterParams OBPoint @brief 3D point structure in the SDK OBPoint2f @brief 2D point structure in the SDK OBPresetResolutionConfig OBPropertyItem @brief Used to describe the characteristics of each property OBProtocolVersion @brief Control command protocol version number OBRect @brief Rectangle OBSequenceIdItem @brief SequenceId fliter list item OBSpatialAdvancedFilterParams OBSpatialFastFilterParams OBSpatialModerateFilterParams OBTofExposureThresholdControl @brief TOF Exposure Threshold OBUint8PropertyRange @brief Structure for float range OBUint16PropertyRange @brief Structure for float range OBXYTables __fsid_t ob_camera_param_list_t ob_config_t ob_context_t ob_depth_work_mode_list_t ob_device_frame_interleave_list_t ob_device_info_t ob_device_list_t ob_device_preset_list_t ob_device_t ob_device_timestamp_reset_config @brief The timestamp reset configuration of the device. ob_error @brief The error class exposed by the SDK, users can get detailed error information according to the error ob_filter_config_schema_list_t ob_filter_list_t ob_filter_t ob_frame_t ob_margin_filter_config @brief Configuration for depth margin filter ob_multi_device_sync_config @brief The synchronization configuration of the device. ob_pipeline_t ob_playback_device_t ob_preset_resolution_config_list_t ob_record_device_t ob_sensor_list_t ob_sensor_t ob_stream_profile_list_t ob_stream_profile_t INT8_MAX INT8_MIN INT16_MAX INT16_MIN INT32_MAX INT32_MIN INTPTR_MAX INTPTR_MIN INT_FAST8_MAX INT_FAST8_MIN INT_FAST16_MAX INT_FAST16_MIN INT_FAST32_MAX INT_FAST32_MIN INT_LEAST8_MAX INT_LEAST8_MIN INT_LEAST16_MAX INT_LEAST16_MIN INT_LEAST32_MAX INT_LEAST32_MIN OBAccelFullScaleRange_OB_ACCEL_FS_2g < 1x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_3g < 3x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_4g < 4x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_6g < 6x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_8g < 8x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_12g < 12x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_16g < 16x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_24g < 24x the acceleration of gravity OBAccelFullScaleRange_OB_ACCEL_FS_UNKNOWN OBAlignMode_ALIGN_D2C_HW_MODE < Hardware D2C alignment mode OBAlignMode_ALIGN_D2C_SW_MODE < Software D2C alignment mode OBAlignMode_ALIGN_DISABLE < Turn off alignment OBCameraDistortionModel_OB_DISTORTION_BROWN_CONRADY < Unmodified Brown-Conrady distortion model OBCameraDistortionModel_OB_DISTORTION_BROWN_CONRADY_K6 < Unmodified Brown-Conrady distortion model with k6 supported OBCameraDistortionModel_OB_DISTORTION_INVERSE_BROWN_CONRADY < Equivalent to Brown-Conrady distortion, except undistorts image instead of distorting it OBCameraDistortionModel_OB_DISTORTION_KANNALA_BRANDT4 < Kannala-Brandt distortion model OBCameraDistortionModel_OB_DISTORTION_MODIFIED_BROWN_CONRADY < Equivalent to Brown-Conrady distortion, except that tangential distortion is applied to radially distorted points OBCameraDistortionModel_OB_DISTORTION_NONE < Rectilinear images. No distortion compensation required. OBCameraPerformanceMode_ADAPTIVE_PERFORMANCE_MODE < Camera adaptive mode OBCameraPerformanceMode_HIGH_PERFORMANCE_MODE < High Performance Mode OBCommunicationType_OB_COMM_NET < Ethernet OBCommunicationType_OB_COMM_USB < USB OBCompressionMode_OB_COMPRESSION_LOSSLESS < Lossless compression mode OBCompressionMode_OB_COMPRESSION_LOSSY < Lossy compression mode OBConvertFormat_FORMAT_BGRA_TO_BGR < BGRA to BGR OBConvertFormat_FORMAT_BGR_TO_RGB < BGR to RGB OBConvertFormat_FORMAT_I420_TO_RGB < I420 to RGB OBConvertFormat_FORMAT_MJPG_TO_BGR < MJPG to BGR OBConvertFormat_FORMAT_MJPG_TO_BGRA < MJPG to BGRA OBConvertFormat_FORMAT_MJPG_TO_I420 < MJPG to I420 OBConvertFormat_FORMAT_MJPG_TO_NV12 < MJPG to NV12 OBConvertFormat_FORMAT_MJPG_TO_NV21 < MJPG to NV21 OBConvertFormat_FORMAT_MJPG_TO_RGB < MJPG to RGB OBConvertFormat_FORMAT_NV12_TO_RGB < NV12 to RGB OBConvertFormat_FORMAT_NV21_TO_RGB < NV21 to RGB OBConvertFormat_FORMAT_RGBA_TO_RGB < RGBA to RGB OBConvertFormat_FORMAT_RGB_TO_BGR < RGB888 to BGR OBConvertFormat_FORMAT_UYVY_TO_RGB < UYVY to RGB OBConvertFormat_FORMAT_Y8_TO_RGB < Y8 to RGB OBConvertFormat_FORMAT_Y16_TO_RGB < Y16 to RGB OBConvertFormat_FORMAT_YUYV_TO_BGR < YUYV to BGR OBConvertFormat_FORMAT_YUYV_TO_BGRA < YUYV to BGRA OBConvertFormat_FORMAT_YUYV_TO_RGB < YUYV to RGB OBConvertFormat_FORMAT_YUYV_TO_RGBA < YUYV to RGBA OBConvertFormat_FORMAT_YUYV_TO_Y8 < YUYV to Y8 OBConvertFormat_FORMAT_YUYV_TO_Y16 < YUYV to Y16 OBDCPowerState_OB_DC_POWER_NO_PLUGIN < No plugin OBDCPowerState_OB_DC_POWER_PLUGIN < Plugin OBDataTranState_DATA_TRAN_ERR_BUSY < Transmission is busy OBDataTranState_DATA_TRAN_ERR_OTHER < Other errors OBDataTranState_DATA_TRAN_ERR_TRAN_FAILED < Transfer failed OBDataTranState_DATA_TRAN_ERR_UNSUPPORTED < Not supported OBDataTranState_DATA_TRAN_ERR_VERIFY_FAILED < Test failed OBDataTranState_DATA_TRAN_STAT_DONE < data transfer completed OBDataTranState_DATA_TRAN_STAT_STOPPED < data transfer stoped OBDataTranState_DATA_TRAN_STAT_TRANSFERRING < data transferring OBDataTranState_DATA_TRAN_STAT_VERIFYING < data verifying OBDataTranState_DATA_TRAN_STAT_VERIFY_DONE < data verify done OBDepthCroppingMode_DEPTH_CROPPING_MODE_AUTO < Automatic mode OBDepthCroppingMode_DEPTH_CROPPING_MODE_CLOSE < Close crop OBDepthCroppingMode_DEPTH_CROPPING_MODE_OPEN < Open crop OBDepthPrecisionLevel_OB_PRECISION_0MM05 < 0.05mm OBDepthPrecisionLevel_OB_PRECISION_0MM1 < 0.1mm OBDepthPrecisionLevel_OB_PRECISION_0MM2 < 0.2mm OBDepthPrecisionLevel_OB_PRECISION_0MM4 < 0.4mm OBDepthPrecisionLevel_OB_PRECISION_0MM5 < 0.5mm OBDepthPrecisionLevel_OB_PRECISION_0MM8 < 0.8mm OBDepthPrecisionLevel_OB_PRECISION_1MM < 1mm OBDepthPrecisionLevel_OB_PRECISION_COUNT OBDepthPrecisionLevel_OB_PRECISION_UNKNOWN OBDepthWorkModeTag_OB_CUSTOM_DEPTH_WORK_MODE OBDepthWorkModeTag_OB_DEVICE_DEPTH_WORK_MODE OBDeviceType_OB_DEVICE_TYPE_UNKNOWN < Unknown device type OBDeviceType_OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA < Binocular structured light camera OBDeviceType_OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA < Monocular structured light camera OBDeviceType_OB_TOF_CAMERA < Time-of-flight camera OBExceptionType_OB_EXCEPTION_STD_EXCEPTION OBExceptionType_OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED < Camera/Device has been disconnected, the camera/device is not available OBExceptionType_OB_EXCEPTION_TYPE_INVALID_VALUE < Invalid parameter type exception, need to check input parameter OBExceptionType_OB_EXCEPTION_TYPE_IO < SDK access IO exception error OBExceptionType_OB_EXCEPTION_TYPE_MEMORY < SDK access and use memory errors. For example, the frame fails to allocate memory OBExceptionType_OB_EXCEPTION_TYPE_NOT_IMPLEMENTED < SDK and firmware have not yet implemented this function or feature OBExceptionType_OB_EXCEPTION_TYPE_PLATFORM < An error in the SDK adaptation platform layer, which means an error in the implementation of a specific system
platform OBExceptionType_OB_EXCEPTION_TYPE_UNKNOWN < Unknown error, an error not clearly defined by the SDK OBExceptionType_OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION < Unsupported operation type error by SDK or device OBExceptionType_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 OBFileTranState_FILE_TRAN_ERR_DDR < DDR access failed OBFileTranState_FILE_TRAN_ERR_MD5_ERROR < MD5 checksum error OBFileTranState_FILE_TRAN_ERR_NOT_ENOUGH_SPACE < Insufficient target space error OBFileTranState_FILE_TRAN_ERR_PATH_NOT_WRITABLE < Destination path is not writable OBFileTranState_FILE_TRAN_ERR_TIMEOUT < Timeout error OBFileTranState_FILE_TRAN_ERR_WRITE_FLASH_ERROR < Write flash error OBFileTranState_FILE_TRAN_STAT_DONE < File transfer succeeded OBFileTranState_FILE_TRAN_STAT_PREPAR < Preparing OBFileTranState_FILE_TRAN_STAT_TRANSFER < File transfer OBFilterConfigValueType_OB_FILTER_CONFIG_VALUE_TYPE_BOOLEAN OBFilterConfigValueType_OB_FILTER_CONFIG_VALUE_TYPE_FLOAT OBFilterConfigValueType_OB_FILTER_CONFIG_VALUE_TYPE_INT OBFilterConfigValueType_OB_FILTER_CONFIG_VALUE_TYPE_INVALID OBFormat_OB_FORMAT_ACCEL < Acceleration data format OBFormat_OB_FORMAT_BA81 < Is same as Y8, using for right ir stream OBFormat_OB_FORMAT_BGR < BGR format (actual BGR888) OBFormat_OB_FORMAT_BGRA < BGRA format OBFormat_OB_FORMAT_BYR2 < byr2 format OBFormat_OB_FORMAT_COMPRESSED < Compression format OBFormat_OB_FORMAT_GRAY < GRAY (the actual format is the same as YUYV) OBFormat_OB_FORMAT_GYRO < Gyroscope data format OBFormat_OB_FORMAT_H264 < H.264 encoding format OBFormat_OB_FORMAT_H265 < H.265 encoding format OBFormat_OB_FORMAT_HEVC < HEVC encoding format (the actual format is the same as H265) OBFormat_OB_FORMAT_I420 < I420 format OBFormat_OB_FORMAT_MJPG < MJPEG encoding format OBFormat_OB_FORMAT_NV12 < NV12 format OBFormat_OB_FORMAT_NV21 < NV21 format OBFormat_OB_FORMAT_POINT < XYZ 3D coordinate point format, @ref OBPoint OBFormat_OB_FORMAT_RGB < RGB format (actual RGB888) OBFormat_OB_FORMAT_RGBA < RGBA format OBFormat_OB_FORMAT_RGB_POINT < XYZ 3D coordinate point format with RGB information, @ref OBColorPoint OBFormat_OB_FORMAT_RLE < RLE pressure test format (SDK will be unpacked into Y16 by default) OBFormat_OB_FORMAT_RVL < RVL pressure test format (SDK will be unpacked into Y16 by default) OBFormat_OB_FORMAT_RW16 < RAW16 format OBFormat_OB_FORMAT_UNKNOWN < unknown format OBFormat_OB_FORMAT_UYVY < UYVY format OBFormat_OB_FORMAT_Y8 < Y8 format, 8-bit per pixel, single-channel OBFormat_OB_FORMAT_Y10 < Y10 format, 10-bit per pixel, single-channel(SDK will unpack into Y16 by default) OBFormat_OB_FORMAT_Y11 < Y11 format, 11-bit per pixel, single-channel (SDK will unpack into Y16 by default) OBFormat_OB_FORMAT_Y12 < Y12 format, 12-bit per pixel, single-channel(SDK will unpack into Y16 by default) OBFormat_OB_FORMAT_Y14 < Y14 format, 14-bit per pixel, single-channel (SDK will unpack into Y16 by default) OBFormat_OB_FORMAT_Y16 < Y16 format, 16-bit per pixel, single-channel OBFormat_OB_FORMAT_Y12C4 < Y12C4 format OBFormat_OB_FORMAT_YUY2 < YUY2 format (the actual format is the same as YUYV) OBFormat_OB_FORMAT_YUYV < YUYV format OBFormat_OB_FORMAT_YV12 < Is same as Y12, using for right ir stream OBFormat_OB_FORMAT_Z16 < Is same as Y16 OBFrameType_OB_FRAME_ACCEL < Accelerometer data frame OBFrameType_OB_FRAME_COLOR < Color frame OBFrameType_OB_FRAME_CONFIDENCE < Confidence frame OBFrameType_OB_FRAME_DEPTH < Depth frame OBFrameType_OB_FRAME_GYRO < Gyroscope data frame OBFrameType_OB_FRAME_IR < IR frame OBFrameType_OB_FRAME_IR_LEFT < Left IR frame for stereo camera OBFrameType_OB_FRAME_IR_RIGHT < Right IR frame for stereo camera OBFrameType_OB_FRAME_POINTS < Point cloud frame OBFrameType_OB_FRAME_RAW_PHASE < Raw Phase frame OBFrameType_OB_FRAME_SET < Frame collection (internally contains a variety of data frames) OBFrameType_OB_FRAME_TYPE_COUNT < The total number of frame types, is not a valid frame type OBFrameType_OB_FRAME_UNKNOWN < Unknown frame type OBFrameType_OB_FRAME_VIDEO < Video frame OBGyroFullScaleRange_OB_GYRO_FS_16dps < 16 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_31dps < 31 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_62dps < 62 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_125dps < 125 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_250dps < 250 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_400dps < 400 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_500dps < 500 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_800dps < 800 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_1000dps < 1000 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_2000dps < 2000 degrees per second OBGyroFullScaleRange_OB_GYRO_FS_UNKNOWN OBHoleFillingMode_OB_HOLE_FILL_FAREST OBHoleFillingMode_OB_HOLE_FILL_NEAREST OBHoleFillingMode_OB_HOLE_FILL_TOP OBIMUSampleRate_OB_SAMPLE_RATE_1_5625_HZ < 1.5625Hz OBIMUSampleRate_OB_SAMPLE_RATE_1_KHZ < 1KHz OBIMUSampleRate_OB_SAMPLE_RATE_2_KHZ < 2KHz OBIMUSampleRate_OB_SAMPLE_RATE_3_125_HZ < 3.125Hz OBIMUSampleRate_OB_SAMPLE_RATE_4_KHZ < 4KHz OBIMUSampleRate_OB_SAMPLE_RATE_6_25_HZ < 6.25Hz OBIMUSampleRate_OB_SAMPLE_RATE_8_KHZ < 8KHz OBIMUSampleRate_OB_SAMPLE_RATE_12_5_HZ < 12.5Hz OBIMUSampleRate_OB_SAMPLE_RATE_16_KHZ < 16KHz OBIMUSampleRate_OB_SAMPLE_RATE_25_HZ < 25Hz OBIMUSampleRate_OB_SAMPLE_RATE_32_KHZ < 32Hz OBIMUSampleRate_OB_SAMPLE_RATE_50_HZ < 50Hz OBIMUSampleRate_OB_SAMPLE_RATE_100_HZ < 100Hz OBIMUSampleRate_OB_SAMPLE_RATE_200_HZ < 200Hz OBIMUSampleRate_OB_SAMPLE_RATE_400_HZ < 400Hz OBIMUSampleRate_OB_SAMPLE_RATE_500_HZ < 500Hz OBIMUSampleRate_OB_SAMPLE_RATE_800_HZ < 800Hz OBIMUSampleRate_OB_SAMPLE_RATE_UNKNOWN OBLogSeverity_OB_LOG_SEVERITY_DEBUG < debug OBLogSeverity_OB_LOG_SEVERITY_ERROR < error OBLogSeverity_OB_LOG_SEVERITY_FATAL < fatal error OBLogSeverity_OB_LOG_SEVERITY_INFO < information OBLogSeverity_OB_LOG_SEVERITY_OFF < off (close LOG) OBLogSeverity_OB_LOG_SEVERITY_WARN < warning OBMediaState_OB_MEDIA_BEGIN < Begin OBMediaState_OB_MEDIA_END < End OBMediaState_OB_MEDIA_PAUSE < Pause OBMediaState_OB_MEDIA_RESUME < Resume OBMediaType_OB_MEDIA_ACCEL_STREAM < Accelerometer stream OBMediaType_OB_MEDIA_ALL OBMediaType_OB_MEDIA_CAMERA_PARAM < Camera parameter OBMediaType_OB_MEDIA_COLOR_STREAM < Color stream OBMediaType_OB_MEDIA_DEPTH_STREAM < Depth stream OBMediaType_OB_MEDIA_DEVICE_INFO < Device information OBMediaType_OB_MEDIA_GYRO_STREAM < Gyroscope stream OBMediaType_OB_MEDIA_IR_LEFT_STREAM < Left infrared stream OBMediaType_OB_MEDIA_IR_RIGHT_STREAM < Right infrared stream OBMediaType_OB_MEDIA_IR_STREAM < Infrared stream OBMediaType_OB_MEDIA_STREAM_INFO < Stream information OBPermissionType_OB_PERMISSION_ANY < any situation above OBPermissionType_OB_PERMISSION_DENY < no permission OBPermissionType_OB_PERMISSION_READ < can read OBPermissionType_OB_PERMISSION_READ_WRITE < can read and write OBPermissionType_OB_PERMISSION_WRITE < can write OBPixelType_OB_PIXEL_DEPTH OBPixelType_OB_PIXEL_DISPARITY OBPixelType_OB_PIXEL_RAW_PHASE OBPixelType_OB_PIXEL_TOF_DEPTH OBPixelType_OB_PIXEL_UNKNOWN OBPropertyID_OB_DEVICE_AUTO_CAPTURE_ENABLE_BOOL @brief soft trigger auto capture enable, use in OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING mode OBPropertyID_OB_DEVICE_AUTO_CAPTURE_INTERVAL_TIME_INT @brief soft trigger auto capture interval time, use in OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING mode OBPropertyID_OB_DEVICE_PTP_CLOCK_SYNC_ENABLE_BOOL @brief PTP time synchronization enable OBPropertyID_OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL @brief Anti_collusion activation status OBPropertyID_OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL @brief Enter recovery mode (flashing mode) when boot the device
@attention The device will take effect after rebooting with the enable option. After entering recovery mode, you can upgrade the device system. Upgrading
the system may cause system damage, please use it with caution. OBPropertyID_OB_PROP_BRT_BOOL @brief BRT function switch (anti-background interference), 0: Disable, 1: Enable OBPropertyID_OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT @brief Number frame to capture once a ‘OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL’ effect. range: [1, 255] OBPropertyID_OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT @brief Capture number interval OBPropertyID_OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL @brief Signal to capture image OBPropertyID_OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT @brief Capture time interval OBPropertyID_OB_PROP_CAPTURE_INTERVAL_MODE_INT @brief Capture interval mode, 0:time interval, 1:number interval OBPropertyID_OB_PROP_CHECK_PPS_SYNC_IN_SIGNAL_BOOL @brief check pps sync in signal OBPropertyID_OB_PROP_COLOR_AE_MAX_EXPOSURE_INT @brief Color AE max exposure OBPropertyID_OB_PROP_COLOR_AUTO_EXPOSURE_BOOL @brief Color camera auto exposure OBPropertyID_OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT @brief Color camera auto exposure priority OBPropertyID_OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL @brief Color camera automatic white balance OBPropertyID_OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT @brief Color camera brightness compensation OBPropertyID_OB_PROP_COLOR_BRIGHTNESS_INT @brief Color camera brightness adjustment OBPropertyID_OB_PROP_COLOR_CONTRAST_INT @brief Color camera contrast adjustment OBPropertyID_OB_PROP_COLOR_DENOISING_LEVEL_INT @brief Color camera CCI denoising level. 0: Auto; 1-8: higher values indicate stronger denoising.
@note This setting has no effect when AE (Auto Exposure) is disabled. OBPropertyID_OB_PROP_COLOR_EXPOSURE_INT @brief Color camera exposure adjustment OBPropertyID_OB_PROP_COLOR_FLIP_BOOL @brief Color flip OBPropertyID_OB_PROP_COLOR_FOCUS_INT @brief Color camera FOCUS OBPropertyID_OB_PROP_COLOR_GAIN_INT @brief Color camera gain adjustment OBPropertyID_OB_PROP_COLOR_GAMMA_INT @brief Color camera gamma adjustment OBPropertyID_OB_PROP_COLOR_HDR_BOOL @brief Color camera HDR OBPropertyID_OB_PROP_COLOR_HUE_INT @brief Color camera color tint OBPropertyID_OB_PROP_COLOR_MAXIMAL_GAIN_INT @brief Color camera maximal gain OBPropertyID_OB_PROP_COLOR_MAXIMAL_SHUTTER_INT @brief Color camera shutter gain OBPropertyID_OB_PROP_COLOR_MIRROR_BOOL @brief Color mirror OBPropertyID_OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT @brief Color Camera Power Line Frequency OBPropertyID_OB_PROP_COLOR_ROLL_INT @brief Color camera image rotation OBPropertyID_OB_PROP_COLOR_ROTATE_INT @brief Color sensor rotation, angle{0, 90, 180, 270} OBPropertyID_OB_PROP_COLOR_SATURATION_INT @brief Color camera saturation adjustment OBPropertyID_OB_PROP_COLOR_SHARPNESS_INT @brief Color camera sharpness adjustment OBPropertyID_OB_PROP_COLOR_SHUTTER_INT @brief Color camera shutter adjustment OBPropertyID_OB_PROP_COLOR_WHITE_BALANCE_INT @brief Color camera white balance adjustment OBPropertyID_OB_PROP_CONFIDENCE_FLIP_BOOL @brief Confidence stream flip enable OBPropertyID_OB_PROP_CONFIDENCE_MIRROR_BOOL @brief Confidence stream mirror enable OBPropertyID_OB_PROP_CONFIDENCE_ROTATE_INT @brief Confidence stream rotate angle{0, 90, 180, 270} OBPropertyID_OB_PROP_CONFIDENCE_STREAM_FILTER_BOOL @brief Enable or disable confidence stream filter OBPropertyID_OB_PROP_CONFIDENCE_STREAM_FILTER_THRESHOLD_INT @brief Confidence stream filter threshold, range [0, 255] OBPropertyID_OB_PROP_D2C_PREPROCESS_BOOL @brief D2C preprocessing switch (such as RGB cropping), 0: off, 1: on OBPropertyID_OB_PROP_DC_POWER_STATE_INT @brief DC’s power state, enum type: OBDCPowerState OBPropertyID_OB_PROP_DEBUG_ESGM_CONFIDENCE_FLOAT @brief Confidence degree OBPropertyID_OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL @brief Hardware d2c is on OBPropertyID_OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT @brief Multi-resolution D2C mode OBPropertyID_OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL @brief Automatic exposure of depth camera (infrared camera will be set synchronously under some models of devices) OBPropertyID_OB_PROP_DEPTH_AUTO_EXPOSURE_PRIORITY_INT @brief Depth camera priority OBPropertyID_OB_PROP_DEPTH_CROPPING_MODE_INT @brief Depth cropping mode device: OB_DEPTH_CROPPING_MODE OBPropertyID_OB_PROP_DEPTH_EXPOSURE_INT @brief Depth camera exposure adjustment (infrared cameras will be set synchronously under some models of devices) OBPropertyID_OB_PROP_DEPTH_FLIP_BOOL @brief Depth flip OBPropertyID_OB_PROP_DEPTH_GAIN_INT @brief Depth camera gain adjustment (infrared cameras will be set synchronously under some models of devices) OBPropertyID_OB_PROP_DEPTH_HOLEFILTER_BOOL @brief Depth Holefilter OBPropertyID_OB_PROP_DEPTH_INDUSTRY_MODE_INT @brief Depth Stream Industry Working Mode Settings, currently only supported by DCW2. OBPropertyID_OB_PROP_DEPTH_MIRROR_BOOL @brief Depth mirror OBPropertyID_OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_BOOL @brief Software filter switch OBPropertyID_OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_MAX_DIFF_INT @brief maxdiff for depth noise removal filter OBPropertyID_OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_MAX_SPECKLE_SIZE_INT @brief maxSpeckleSize for depth noise removal filter OBPropertyID_OB_PROP_DEPTH_POSTFILTER_BOOL @brief Depth Postfilter OBPropertyID_OB_PROP_DEPTH_PRECISION_LEVEL_INT @brief the depth precision level, which may change the depth frame data unit, needs to be confirmed through the ValueScale interface of
DepthFrame OBPropertyID_OB_PROP_DEPTH_RM_FILTER_BOOL @brief Depth effect dedistortion, true: on, false: off. mutually exclusive with D2C function, RM_Filter disable When hardware or software D2C is enabled. OBPropertyID_OB_PROP_DEPTH_ROTATE_INT @brief Depth sensor rotation, angle{0, 90, 180, 270} OBPropertyID_OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT @brief Depth unit flexible adjustment OBPropertyID_OB_PROP_DEPTH_WITH_CONFIDENCE_STREAM_ENABLE_BOOL @brief Depth with confidence stream enable OBPropertyID_OB_PROP_DEVICE_COMMUNICATION_TYPE_INT @brief Device communication type, 0: USB; 1: Ethernet(RTSP) OBPropertyID_OB_PROP_DEVICE_DEVELOPMENT_MODE_INT @brief Device development mode switch, optional modes can refer to the definition in @ref OBDeviceDevelopmentMode,the default mode is
@ref OB_USER_MODE
@attention The device takes effect after rebooting when switching modes. OBPropertyID_OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL @brief Query whether the current device is running in recovery mode (read-only) OBPropertyID_OB_PROP_DEVICE_PERFORMANCE_MODE_INT @brief Switch device performance mode, currently available in Adaptive Mode and High Performance Mode, such as G335LE. OBPropertyID_OB_PROP_DEVICE_REBOOT_DELAY_INT @brief Reboot device delay mode. Delay time unit: ms, range: [0, 8000). OBPropertyID_OB_PROP_DEVICE_REPOWER_BOOL @brief Repower device (cut off power and power on again) OBPropertyID_OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL @brief Enable or disable the device to retry USB2.0 re-identification when the device is connected to a USB2.0 port.
@brief This feature ensures that the device is not mistakenly identified as a USB 2.0 device when connected to a USB 3.0 port. OBPropertyID_OB_PROP_DEVICE_WORK_MODE_INT @brief Device operating mode (power consumption) OBPropertyID_OB_PROP_DISPARITY_TO_DEPTH_BOOL @brief Disparity to depth switch, false: switch to software disparity convert to depth, true: switch to hardware disparity convert to depth OBPropertyID_OB_PROP_DISP_SEARCH_OFFSET_INT @brief Disparity search range offset, range: [0, 127] OBPropertyID_OB_PROP_DISP_SEARCH_RANGE_MODE_INT @brief Disparity search range mode, 1: 128, 2: 256 OBPropertyID_OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL @brief External signal trigger restart function switch, 0: Disable, 1: Enable OBPropertyID_OB_PROP_FAN_WORK_MODE_INT @brief Fan mode switch OBPropertyID_OB_PROP_FLOOD_BOOL @brief IR flood switch OBPropertyID_OB_PROP_FLOOD_LEVEL_INT @brief IR flood level OBPropertyID_OB_PROP_FRAME_INTERLEAVE_CONFIG_INDEX_INT @brief frame interleave config index OBPropertyID_OB_PROP_FRAME_INTERLEAVE_ENABLE_BOOL @brief frame interleave enable (true:enable,false:disable) OBPropertyID_OB_PROP_FRAME_INTERLEAVE_LASER_PATTERN_SYNC_DELAY_INT @brief laser pattern sync with delay(us) OBPropertyID_OB_PROP_GPM_BOOL @brief Enable/disable GPM function OBPropertyID_OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL @brief Hardware distortion switch Rectify OBPropertyID_OB_PROP_HDR_MERGE_BOOL @brief Depth HDR merge, true: on, false: off. OBPropertyID_OB_PROP_HEARTBEAT_BOOL @brief Heartbeat monitoring function switch, 0: Disable, 1: Enable OBPropertyID_OB_PROP_HW_NOISE_REMOVE_FILTER_ENABLE_BOOL @brief hardware noise remove filter switch OBPropertyID_OB_PROP_HW_NOISE_REMOVE_FILTER_THRESHOLD_FLOAT @brief hardware noise remove filter threshold ,range [0.0 - 1.0] OBPropertyID_OB_PROP_INDICATOR_LIGHT_BOOL @brief Indicator switch, 0: Disable, 1: Enable OBPropertyID_OB_PROP_INTRA_CAMERA_SYNC_REFERENCE_INT @brief Intra-camera Sync Reference based on the exposure start time, the exposure middle time, or the exposure end time. the definition in @ref
OBIntraCameraSyncReference OBPropertyID_OB_PROP_IR_AE_MAX_EXPOSURE_INT @brief Max exposure time of IR auto exposure OBPropertyID_OB_PROP_IR_AUTO_EXPOSURE_BOOL @brief Infrared camera auto exposure (depth camera will be set synchronously under some models of devices) OBPropertyID_OB_PROP_IR_BRIGHTNESS_INT @brief IR brightness OBPropertyID_OB_PROP_IR_CHANNEL_DATA_SOURCE_INT @brief Select Infrared camera data source channel. If not support throw exception. 0 : IR stream from IR Left sensor; 1 : IR stream from IR Right sensor; OBPropertyID_OB_PROP_IR_EXPOSURE_INT @brief Infrared camera exposure adjustment (some models of devices will set the depth camera synchronously) OBPropertyID_OB_PROP_IR_FLIP_BOOL @brief IR flip OBPropertyID_OB_PROP_IR_GAIN_INT @brief Infrared camera gain adjustment (the depth camera will be set synchronously under some models of devices) OBPropertyID_OB_PROP_IR_LONG_EXPOSURE_BOOL @brief IR long exposure mode switch read and write. OBPropertyID_OB_PROP_IR_MIRROR_BOOL @brief IR mirror OBPropertyID_OB_PROP_IR_RECTIFY_BOOL @brief ir rectify status,true: ir rectify, false: no rectify OBPropertyID_OB_PROP_IR_RIGHT_FLIP_BOOL @brief Right IR sensor flip state. true: flip image, false: origin, default: false OBPropertyID_OB_PROP_IR_RIGHT_MIRROR_BOOL @brief Right IR sensor mirror state OBPropertyID_OB_PROP_IR_RIGHT_ROTATE_INT @brief Right IR sensor rotation, angle{0, 90, 180, 270} OBPropertyID_OB_PROP_IR_ROTATE_INT @brief IR/Left-IR sensor rotation, angle{0, 90, 180, 270} OBPropertyID_OB_PROP_IR_SHORT_EXPOSURE_BOOL @brief The enable/disable switch for IR short exposure function, supported only by a few devices. OBPropertyID_OB_PROP_LASER_ALWAYS_ON_BOOL @brief Laser always on, true: always on, false: off, laser will be turned off when out of exposure time OBPropertyID_OB_PROP_LASER_BOOL @brief Laser switch OBPropertyID_OB_PROP_LASER_CONTROL_INT @brief Laser control, 0: off, 1: on, 2: auto OBPropertyID_OB_PROP_LASER_CURRENT_FLOAT @brief Laser current (uint: mA) OBPropertyID_OB_PROP_LASER_HIGH_TEMPERATURE_PROTECT_BOOL @brief Laser high temperature protection OBPropertyID_OB_PROP_LASER_MODE_INT @brief laser mode, the firmware terminal currently only return 1: IR Drive, 2: Torch OBPropertyID_OB_PROP_LASER_ON_OFF_PATTERN_INT @brief Laser on/off alternate mode, 0: off, 1: on-off alternate, 2: off-on alternate
@attention When turn on this mode, the laser will turn on and turn off alternately each frame. OBPropertyID_OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL @brief Query the status of laser overcurrent protection (read-only) OBPropertyID_OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT @brief Get hardware laser power actual level which real state of laser element. OB_PROP_LASER_POWER_LEVEL_CONTROL_INT99 will effect this command
which it setting and changed the hardware laser energy level. OBPropertyID_OB_PROP_LASER_POWER_LEVEL_CONTROL_INT @brief Laser power level OBPropertyID_OB_PROP_LASER_PULSE_WIDTH_INT @brief laser pulse width OBPropertyID_OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL @brief Query the status of laser pulse width protection (read-only) OBPropertyID_OB_PROP_LDP_BOOL @brief LDP switch OBPropertyID_OB_PROP_LDP_MEASURE_DISTANCE_INT @brief LDP’s measure distance, unit: mm OBPropertyID_OB_PROP_LDP_STATUS_BOOL @brief LDP status OBPropertyID_OB_PROP_LOW_EXPOSURE_LASER_CONTROL_BOOL @brief low exposure laser control OBPropertyID_OB_PROP_MAX_DEPTH_INT @brief Maximum depth threshold OBPropertyID_OB_PROP_MIN_DEPTH_INT @brief Minimum depth threshold OBPropertyID_OB_PROP_NETWORK_BANDWIDTH_TYPE_INT @brief Read the current network bandwidth type of the network device, whether it is Gigabit Ethernet or Fast Ethernet, such as G335LE. OBPropertyID_OB_PROP_ON_CHIP_CALIBRATION_ENABLE_BOOL @brief Enable or disable on-chip calibration OBPropertyID_OB_PROP_ON_CHIP_CALIBRATION_HEALTH_CHECK_FLOAT @brief Get the health check result from device,range is [0.0f,1.5f] OBPropertyID_OB_PROP_RECTIFY2_BOOL @brief brt2r-rectify function switch (brt2r is a special module on mx6600), 0: Disable, 1: Rectify Enable OBPropertyID_OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL @brief Restore factory settings and factory parameters
@attention This command can only be written, and the parameter value must be true. The command takes effect after restarting the device. OBPropertyID_OB_PROP_RGB_CUSTOM_CROP_BOOL @brief Custom RGB cropping switch, 0 is off, 1 is on custom cropping, and the ROI cropping area is issued OBPropertyID_OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL @brief Accel data conversion function switch (on by default) OBPropertyID_OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL @brief Depth data unpacking function switch (each open stream will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) OBPropertyID_OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL @brief Software disparity to depth OBPropertyID_OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL @brief Gyro data conversion function switch (on by default) OBPropertyID_OB_PROP_SDK_IR_FRAME_UNPACK_BOOL @brief IR data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) OBPropertyID_OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL @brief Left IR frame data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) OBPropertyID_OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL @brief Right IR frame data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) OBPropertyID_OB_PROP_SKIP_FRAME_BOOL @brief Setting and getting the USB device frame skipping mode status, true: frame skipping mode, false: non-frame skipping mode. OBPropertyID_OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL @brief Slave/secondary device synchronization status (read-only) OBPropertyID_OB_PROP_SWITCH_IR_MODE_INT @brief Switch infrared imaging mode, 0: active IR mode, 1: passive IR mode OBPropertyID_OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL @brief Multi-DeviceSync synchronized signal trigger out is enable state. true: enable, false: disable OBPropertyID_OB_PROP_TEMPERATURE_COMPENSATION_BOOL @brief Enable/disable temperature compensation OBPropertyID_OB_PROP_TIMER_RESET_DELAY_US_INT @brief Delay to reset device time, unit: us OBPropertyID_OB_PROP_TIMER_RESET_ENABLE_BOOL OBPropertyID_OB_PROP_TIMER_RESET_SIGNAL_BOOL @brief Reset device time to zero OBPropertyID_OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL @brief Enable send reset device time signal to other device. true: enable, false: disable OBPropertyID_OB_PROP_TIMESTAMP_OFFSET_INT @brief Timestamp adjustment OBPropertyID_OB_PROP_TOF_FILTER_RANGE_INT @brief tof filter range configuration OBPropertyID_OB_PROP_USB_POWER_STATE_INT @brief USB’s power state, enum type: OBUSBPowerState OBPropertyID_OB_PROP_WATCHDOG_BOOL @brief Watchdog function switch, 0: Disable, 1: Enable OBPropertyID_OB_RAW_DATA_CAMERA_CALIB_JSON_FILE @brief Calibration JSON file read from device (Femto Mega, read only) OBPropertyID_OB_STRUCT_ASIC_SERIAL_NUMBER @brief ASIC serial number OBPropertyID_OB_STRUCT_BASELINE_CALIBRATION_PARAM @brief Baseline calibration parameters OBPropertyID_OB_STRUCT_COLOR_AE_ROI @brief Color Sensor AE ROI configuration
@brief The Value type is @ref OBRegionOfInterest OBPropertyID_OB_STRUCT_CURRENT_DEPTH_ALG_MODE @brief The current camera depth mode OBPropertyID_OB_STRUCT_DEPTH_AE_ROI @brief Depth Sensor AE ROI configuration
@brief The Value type is @ref OBRegionOfInterest
@brief Since the ir sensor is the same physical sensor as the depth sensor, this property will also effect the ir sensor. OBPropertyID_OB_STRUCT_DEPTH_HDR_CONFIG @brief Using to configure the depth sensor’s HDR mode
@brief The Value type is @ref OBHdrConfig OBPropertyID_OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST @brief A list of depth accuracy levels, returning an array of uin16_t, corresponding to the enumeration OBPropertyID_OB_STRUCT_DEVICE_IP_ADDR_CONFIG @brief Device IP address configuration OBPropertyID_OB_STRUCT_DEVICE_SERIAL_NUMBER @brief get/set serial number OBPropertyID_OB_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD @brief Device network static ip config record
@brief Using for get last static ip config, witch is record in device flash when user set static ip config OBPropertyID_OB_STRUCT_DEVICE_TEMPERATURE @brief Device temperature information OBPropertyID_OB_STRUCT_DEVICE_TIME @brief get/set device time OBPropertyID_OB_STRUCT_DISP_OFFSET_CONFIG @brief Disparity offset interleaving OBPropertyID_OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG @brief Multi-device synchronization mode and parameter configuration OBPropertyID_OB_STRUCT_PRESET_RESOLUTION_CONFIG @brief Preset resolution ratio configuration OBPropertyID_OB_STRUCT_RGB_CROP_ROI @brief RGB cropping ROI OBPropertyID_OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL @brief TOF exposure threshold range OBPropertyType_OB_BOOL_PROPERTY < Boolean property OBPropertyType_OB_FLOAT_PROPERTY < Floating-point property OBPropertyType_OB_INT_PROPERTY < Integer property OBPropertyType_OB_STRUCT_PROPERTY < Struct property OBSensorType_OB_SENSOR_ACCEL < Accel OBSensorType_OB_SENSOR_COLOR < Color OBSensorType_OB_SENSOR_CONFIDENCE < Confidence OBSensorType_OB_SENSOR_DEPTH < Depth OBSensorType_OB_SENSOR_GYRO < Gyro OBSensorType_OB_SENSOR_IR < IR OBSensorType_OB_SENSOR_IR_LEFT < left IR for stereo camera OBSensorType_OB_SENSOR_IR_RIGHT < Right IR for stereo camera OBSensorType_OB_SENSOR_RAW_PHASE < Raw Phase OBSensorType_OB_SENSOR_TYPE_COUNT OBSensorType_OB_SENSOR_UNKNOWN < Unknown type sensor OBStatus_OB_STATUS_ERROR < status error OBStatus_OB_STATUS_OK < status ok OBStreamType_OB_STREAM_ACCEL < Accelerometer data stream OBStreamType_OB_STREAM_COLOR < color stream OBStreamType_OB_STREAM_CONFIDENCE < Confidence Stream OBStreamType_OB_STREAM_DEPTH < depth stream OBStreamType_OB_STREAM_GYRO < Gyroscope data stream OBStreamType_OB_STREAM_IR < IR stream OBStreamType_OB_STREAM_IR_LEFT < Left IR stream for stereo camera OBStreamType_OB_STREAM_IR_RIGHT < Right IR stream for stereo camera OBStreamType_OB_STREAM_RAW_PHASE < RawPhase Stream OBStreamType_OB_STREAM_TYPE_COUNT < The total number of stream type,is not a valid stream type OBStreamType_OB_STREAM_UNKNOWN < Unknown type stream OBStreamType_OB_STREAM_VIDEO < Video stream (infrared, color, depth streams are all video streams) OBSyncMode_OB_SYNC_MODE_CLOSE @brief Close synchronize mode
@brief Single device, neither process input trigger signal nor output trigger signal
@brief Each Sensor in a single device automatically triggers OBSyncMode_OB_SYNC_MODE_IR_IMU_SYNC @brief IR and IMU sync signal OBSyncMode_OB_SYNC_MODE_PRIMARY @brief Primary synchronize mode
@brief Primary device. Ignore process input trigger signal, only output trigger signal to secondary devices.
@brief Inside single device, RGB as Major sensor: RGB -> IR/Depth/TOF OBSyncMode_OB_SYNC_MODE_PRIMARY_IR_TRIGGER @brief IR Primary synchronize mode
@brief Primary device. Ignore process input trigger signal, only output trigger signal to secondary devices.
@brief Inside device, IR is the primary signal source: IR/Depth/TOF -> RGB OBSyncMode_OB_SYNC_MODE_PRIMARY_MCU_TRIGGER @brief MCU Primary synchronize mode
@brief Primary device. Ignore process input trigger signal, only output trigger signal to secondary devices.
@brief Inside device, MCU is the primary signal source: MCU -> RGB && MCU -> IR/Depth/TOF OBSyncMode_OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER @brief Software trigger synchronize mode
@brief Host, triggered by software control (receive the upper computer command trigger), at the same time to the trunk output trigger signal
@brief Different sensors in a single machine receive trigger signals respectively: soft trigger -> RGB && soft trigger -> IR/Depth/TOF OBSyncMode_OB_SYNC_MODE_SECONDARY @brief Secondary synchronize mode
@brief Secondary device. Both process input trigger signal and output trigger signal to other devices.
@brief Different sensors in a single devices receive trigger signals respectively: ext trigger -> RGB && ext trigger -> IR/Depth/TOF OBSyncMode_OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER @brief Software trigger synchronize mode as secondary device
@brief 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.
@brief Different sensors in a single machine receive trigger signals respectively: ext trigger -> RGB && ext trigger -> IR/Depth/TOF OBSyncMode_OB_SYNC_MODE_STANDALONE @brief Standalone synchronize mode
@brief Single device, neither process input trigger signal nor output trigger signal
@brief Inside single device, RGB as Major sensor: RGB -> IR/Depth/TOF OBSyncMode_OB_SYNC_MODE_UNKNOWN @brief Unknown type OBTofFilterRange_OB_TOF_FILTER_RANGE_CLOSE < Close range OBTofFilterRange_OB_TOF_FILTER_RANGE_DEBUG < Debug range OBTofFilterRange_OB_TOF_FILTER_RANGE_LONG < Long range OBTofFilterRange_OB_TOF_FILTER_RANGE_MIDDLE < Middle range OBUSBPowerState_OB_USB_POWER_5V_0A9 < 5V/0.9A OBUSBPowerState_OB_USB_POWER_5V_1A5 < 5V/1.5A OBUSBPowerState_OB_USB_POWER_5V_3A0 < 5V/3.0A OBUSBPowerState_OB_USB_POWER_NO_PLUGIN < No plugin OBUpgradeState_ERR_DDR < DDR access error OBUpgradeState_ERR_ERASE < Flash parameter failed OBUpgradeState_ERR_FLASH_TYPE < Flash type error OBUpgradeState_ERR_IMAGE_SIZE < Image file size error OBUpgradeState_ERR_INVALID_COUNT < invalid firmware/preset count OBUpgradeState_ERR_MISMATCH < Mismatch firmware error OBUpgradeState_ERR_OTHER < other errors OBUpgradeState_ERR_PROGRAM < Program execution failed OBUpgradeState_ERR_TIMEOUT < timeout error OBUpgradeState_ERR_UNSUPPORT_DEV < Unsupported device error OBUpgradeState_ERR_VERIFY < Verification failed OBUpgradeState_STAT_DONE < update completed OBUpgradeState_STAT_DONE_WITH_DUPLICATES < update completed, but some files were duplicated and ignored OBUpgradeState_STAT_FILE_TRANSFER < file transfer OBUpgradeState_STAT_IN_PROGRESS < upgrade in process OBUpgradeState_STAT_START < start the upgrade OBUpgradeState_STAT_VERIFY_IMAGE < Image file verification OBUpgradeState_STAT_VERIFY_SUCCESS < Image file verifify success OB_CMD_VERSION_OB_CMD_VERSION_INVALID < Invalid version OB_CMD_VERSION_OB_CMD_VERSION_NOVERSION OB_CMD_VERSION_OB_CMD_VERSION_V0 < Version 1.0 OB_CMD_VERSION_OB_CMD_VERSION_V1 < Version 2.0 OB_CMD_VERSION_OB_CMD_VERSION_V2 < Version 3.0 OB_CMD_VERSION_OB_CMD_VERSION_V3 < Version 4.0 OB_COORDINATE_SYSTEM_TYPE_OB_LEFT_HAND_COORDINATE_SYSTEM OB_COORDINATE_SYSTEM_TYPE_OB_RIGHT_HAND_COORDINATE_SYSTEM OB_DDO_NOISE_REMOVAL_TYPE_OB_NR_LUT OB_DDO_NOISE_REMOVAL_TYPE_OB_NR_OVERALL OB_DEFAULT_STRIDE_BYTES OB_DEVICE_DEVELOPMENT_MODE_OB_DEVELOPER_MODE @brief Developer mode, which allows developers to access the operating system and software/hardware resources on the device directly OB_DEVICE_DEVELOPMENT_MODE_OB_USER_MODE @brief User mode (default mode), which provides full camera device functionality OB_EDGE_NOISE_REMOVAL_TYPE_OB_MGA_FILTER OB_EDGE_NOISE_REMOVAL_TYPE_OB_MGC_FILTER OB_EDGE_NOISE_REMOVAL_TYPE_OB_MGH_FILTER OB_EDGE_NOISE_REMOVAL_TYPE_OB_MG_FILTER OB_FPS_ANY OB_FRAME_AGGREGATE_OUTPUT_MODE_OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE @brief Only FrameSet that contains all types of data frames will be output OB_FRAME_AGGREGATE_OUTPUT_MODE_OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION @brief FrameSet for any case will be output OB_FRAME_AGGREGATE_OUTPUT_MODE_OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE @brief Color Frame Require output mode
@brief Suitable for Color using H264, H265 and other inter-frame encoding format open stream OB_FRAME_AGGREGATE_OUTPUT_MODE_OB_FRAME_AGGREGATE_OUTPUT_DISABLE @brief Disable Frame Aggreate OB_HEIGHT_ANY OB_PATH_MAX OB_PROFILE_DEFAULT OB_WIDTH_ANY PTRDIFF_MAX PTRDIFF_MIN SIG_ATOMIC_MAX SIG_ATOMIC_MIN SIZE_MAX UINT8_MAX UINT16_MAX UINT32_MAX UINTPTR_MAX UINT_FAST8_MAX UINT_FAST16_MAX UINT_FAST32_MAX UINT_LEAST8_MAX UINT_LEAST16_MAX UINT_LEAST32_MAX WINT_MAX WINT_MIN _ATFILE_SOURCE _BITS_STDINT_INTN_H _BITS_STDINT_LEAST_H _BITS_STDINT_UINTN_H _BITS_TIME64_H _BITS_TYPESIZES_H _BITS_TYPES_H _BITS_WCHAR_H _DEFAULT_SOURCE _FEATURES_H _POSIX_C_SOURCE _POSIX_SOURCE _STDC_PREDEF_H _STDINT_H _SYS_CDEFS_H __FD_SETSIZE __GLIBC_MINOR__ __GLIBC_USE_C2X_STRTOL __GLIBC_USE_DEPRECATED_GETS __GLIBC_USE_DEPRECATED_SCANF __GLIBC_USE_IEC_60559_BFP_EXT __GLIBC_USE_IEC_60559_BFP_EXT_C2X __GLIBC_USE_IEC_60559_EXT __GLIBC_USE_IEC_60559_FUNCS_EXT __GLIBC_USE_IEC_60559_FUNCS_EXT_C2X __GLIBC_USE_IEC_60559_TYPES_EXT __GLIBC_USE_ISOC2X __GLIBC_USE_LIB_EXT2 __GLIBC__ __GNU_LIBRARY__ __HAVE_GENERIC_SELECTION __INO_T_MATCHES_INO64_T __KERNEL_OLD_TIMEVAL_MATCHES_TIMEVAL64 __LDOUBLE_REDIRECTS_TO_FLOAT128_ABI __OFF_T_MATCHES_OFF64_T __RLIM_T_MATCHES_RLIM64_T __STATFS_MATCHES_STATFS64 __STDC_IEC_559_COMPLEX__ __STDC_IEC_559__ __STDC_IEC_60559_BFP__ __STDC_IEC_60559_COMPLEX__ __STDC_ISO_10646__ __SYSCALL_WORDSIZE __TIMESIZE __USE_ATFILE __USE_FORTIFY_LEVEL __USE_ISOC11 __USE_ISOC95 __USE_ISOC99 __USE_MISC __USE_POSIX __USE_POSIX2 __USE_POSIX199309 __USE_POSIX199506 __USE_POSIX_IMPLICITLY __USE_XOPEN2K __USE_XOPEN2K8 __WORDSIZE __WORDSIZE_TIME64_COMPAT32 __bool_true_false_are_defined __glibc_c99_flexarr_available false_ ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE @brief Actual frame rate
@brief The actual frame rate will be calculated according to the exposure time and other parameters. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM @brief Bottom region of interest for the auto exposure Algorithm. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_AE_ROI_LEFT @brief Left region of interest for the auto exposure Algorithm. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT @brief Right region of interest for the auto exposure Algorithm. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_AE_ROI_TOP @brief Top region of interest for the auto exposure Algorithm. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE @brief Auto exposure status
@brief If the value is 0, it means the auto exposure is disabled. Otherwise, it means the auto exposure is enabled. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE @brief Auto white balance status
@brief 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_OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION @brief Backlight compensation ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_BRIGHTNESS @brief Brightness ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_CONTRAST @brief Contrast ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_COUNT @brief The number of frame metadata types, using for types iterating
@attention It is not a valid frame metadata type ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_OFFSET @brief disparity search offset value ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_RANGE @brief disparity search range ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_EXPOSURE @brief Exposure time ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY @brief Exposure priority ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_FRAME_NUMBER @brief The number of current frame. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_FRAME_RATE @brief Frame rate ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_GAIN @brief Gain ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_GAMMA @brief Gamma ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA @brief GPIO input data ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX @brief HDR sequence index ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME @brief HDR sequence name ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE @brief HDR sequence size ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_HUE @brief Hue ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_LASER_POWER @brief Laser power value in mW ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL @brief Laser power level ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_LASER_STATUS @brief Laser status
@brief 0: Laser off, 1: Laser on ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION @brief Low light compensation ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE @brief Manual white balance setting ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY @brief Power line frequency
@brief For anti-flickering, 0: Close, 1: 50Hz, 2: 60Hz, 3: Auto ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_SATURATION @brief Saturation ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP @brief Timestamp in the middle of the capture.
@brief Usually is the middle of the exposure time. ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_SHARPNESS @brief Sharpness ob_frame_metadata_type_OB_FRAME_METADATA_TYPE_TIMESTAMP @brief 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_OB_FRAME_METADATA_TYPE_WHITE_BALANCE @brief White balance ob_intra_camera_sync_reference_END_OF_EXPOSURE < end of exposure ob_intra_camera_sync_reference_MIDDLE_OF_EXPOSURE < middle of exposure ob_intra_camera_sync_reference_START_OF_EXPOSURE < start of exposure ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN @brief free run mode
@brief The device does not synchronize with other devices,
@brief The Color and Depth can be set to different frame rates. ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING @brief hardware triggering mode
@brief 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 @ref framesPerTrigger.
@brief The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by @ref colorDelayUs, @ref
depthDelayUs or @ref trigger2ImageDelayUs. ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_IR_IMU_SYNC @brief IR and IMU sync mode ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_PRIMARY @brief primary mode
@brief 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.
@brief The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by @ref colorDelayUs, @ref
depthDelayUs or @ref trigger2ImageDelayUs. ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_SECONDARY @brief secondary mode
@brief 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.
@brief The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by @ref colorDelayUs, @ref
depthDelayUs or @ref trigger2ImageDelayUs.
@brief 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. ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED @brief secondary synced mode
@brief 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.
@brief The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by @ref colorDelayUs, @ref
depthDelayUs or @ref trigger2ImageDelayUs.
@brief 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. ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING @brief software triggering mode
@brief 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 @ref ob_device_trigger_capture. The number of images captured each time can be set by @ref
framesPerTrigger.
@brief The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by @ref colorDelayUs, @ref
depthDelayUs or @ref trigger2ImageDelayUs. ob_multi_device_sync_mode_OB_MULTI_DEVICE_SYNC_MODE_STANDALONE @brief standalone mode
@brief The device does not synchronize with other devices.
@brief The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized. ob_playback_status_OB_PLAYBACK_COUNT ob_playback_status_OB_PLAYBACK_PAUSED < The media is paused ob_playback_status_OB_PLAYBACK_PLAYING < The media is playing ob_playback_status_OB_PLAYBACK_STOPPED < The media is stopped ob_playback_status_OB_PLAYBACK_UNKNOWN ob_power_line_freq_mode_OB_POWER_LINE_FREQ_MODE_50HZ < 50Hz ob_power_line_freq_mode_OB_POWER_LINE_FREQ_MODE_60HZ < 60Hz ob_power_line_freq_mode_OB_POWER_LINE_FREQ_MODE_CLOSE < Close ob_rotate_degree_type_OB_ROTATE_DEGREE_0 < Rotate 0 ob_rotate_degree_type_OB_ROTATE_DEGREE_90 < Rotate 90 ob_rotate_degree_type_OB_ROTATE_DEGREE_180 < Rotate 180 ob_rotate_degree_type_OB_ROTATE_DEGREE_270 < Rotate 270 ob_uvc_backend_type_OB_UVC_BACKEND_TYPE_AUTO @brief Auto detect system capabilities and device hint to select backend ob_uvc_backend_type_OB_UVC_BACKEND_TYPE_LIBUVC @brief Use libuvc backend to access the UVC device ob_uvc_backend_type_OB_UVC_BACKEND_TYPE_MSMF @brief Use MSMF backend to access the UVC device ob_uvc_backend_type_OB_UVC_BACKEND_TYPE_V4L2 @brief Use v4l2 backend to access the UVC device true_ ob_accel_frame_get_temperature ⚠ @brief Get the temperature when acquiring the accelerometer frame. ob_accel_frame_get_value ⚠ @brief Get accelerometer frame data. ob_accel_range_type_to_string ⚠ @brief Convert OBAccelFullScaleRange to “ char* “ type and then return. ob_accel_stream_profile_get_full_scale_range ⚠ @brief Get the full-scale range of the accelerometer stream. ob_accel_stream_profile_get_intrinsic ⚠ @brief Get the intrinsic of the accelerometer stream. ob_accel_stream_profile_get_sample_rate ⚠ @brief Get the sampling frequency of the accelerometer frame. ob_accel_stream_profile_set_intrinsic ⚠ @brief Set the intrinsic of the accelerometer stream. ob_align_filter_set_align_to_stream_profile ⚠ @brief Set the align to stream profile for the align filter.
@brief It is useful when the align target stream dose not started (without any frame to get intrinsics and extrinsics). ob_camera_param_list_get_count ⚠ @brief Get the number of camera parameter lists ob_camera_param_list_get_param ⚠ @brief Get camera parameters from the camera parameter list ob_config_disable_all_stream ⚠ @brief Disable all streams in the pipeline configuration ob_config_disable_stream ⚠ @brief Disable a specific stream in the pipeline configuration ob_config_enable_accel_stream ⚠ @brief Enable accelerometer stream with specified parameters ob_config_enable_all_stream ⚠ @brief Enable all streams in the pipeline configuration ob_config_enable_gyro_stream ⚠ @brief Enable gyroscope stream with specified parameters ob_config_enable_stream ⚠ @brief Enable a stream with default profile ob_config_enable_stream_with_stream_profile ⚠ @brief Enable a stream according to the stream profile ob_config_enable_video_stream ⚠ @brief Enable video stream with specified parameters ob_config_get_enabled_stream_profile_list ⚠ @brief Get the enabled stream profile list in the pipeline configuration ob_config_set_align_mode ⚠ @brief Set the alignment mode for the pipeline configuration ob_config_set_depth_scale_after_align_require ⚠ @brief Set whether depth scaling is required after enable depth to color alignment
@brief After enabling depth to color alignment, the depth image may need to be scaled to match the color image size. ob_config_set_frame_aggregate_output_mode ⚠ @brief Set the frame aggregation output mode for the pipeline configuration
@brief The processing strategy when the FrameSet generated by the frame aggregation function does not contain the frames of all opened streams (which
can be caused by different frame rates of each stream, or by the loss of frames of one stream): drop directly or output to the user. ob_create_accel_stream_profile ⚠ @brief Create a accel stream profile object ob_create_config ⚠ @brief Create the pipeline configuration ob_create_context ⚠ @brief Create a context object with the default configuration file ob_create_context_with_config ⚠ @brief Create a context object with a specified configuration file ob_create_error ⚠ @brief Create a new error object. ob_create_filter ⚠ @brief Create a Filter object. ob_create_frame ⚠ @brief Crate a frame object based on the specified parameters. ob_create_frame_from_buffer ⚠ @brief Create a frame object based on an externally created buffer. ob_create_frame_from_other_frame ⚠ @brief Create (clone) a frame object based on the specified other frame object.
@brief The new frame object will have the same properties as the other frame object, but the data buffer is newly allocated. ob_create_frame_from_stream_profile ⚠ @brief Create a frame object according to the specified stream profile. ob_create_frameset ⚠ @brief Create an empty frameset object.
@brief A frameset object is a special type of frame object that can be used to store multiple frames. ob_create_gyro_stream_profile ⚠ @brief Create a gyro stream profile object ob_create_net_device ⚠ @brief Create a network device object ob_create_pipeline ⚠ @brief Create a pipeline object ob_create_pipeline_with_device ⚠ @brief Using device objects to create pipeline objects ob_create_playback_device ⚠ @brief Create a playback device for the specified file path. ob_create_private_filter ⚠ @brief Create a private Filter object with activation key.
@brief Some private filters require an activation key to be activated, its depends on the vendor of the filter. ob_create_record_device ⚠ @brief Create a recording device for the specified device with a specified file path and compression enabled. ob_create_stream_profile ⚠ @brief Create a stream profile object ob_create_stream_profile_from_other_stream_profile ⚠ @brief Copy the stream profile object from an other stream profile object ob_create_stream_profile_with_new_format ⚠ @brief Copy the stream profile object with a new format object ob_create_video_frame ⚠ @brief Create an video frame object based on the specified parameters. ob_create_video_frame_from_buffer ⚠ @brief Create a video frame object based on an externally created buffer. ob_create_video_stream_profile ⚠ @brief Create a video stream profile object ob_delete_camera_param_list ⚠ @brief Delete the camera parameter list ob_delete_config ⚠ @brief Delete the pipeline configuration ob_delete_context ⚠ @brief Delete a context object ob_delete_depth_work_mode_list ⚠ @brief Free the resources of ob_depth_work_mode_list ob_delete_device ⚠ @brief Delete a device. ob_delete_device_info ⚠ @brief Delete device information. ob_delete_device_list ⚠ @brief Delete a device list. ob_delete_error ⚠ @brief Delete the error object. ob_delete_filter ⚠ @brief Delete the filter. ob_delete_filter_config_schema_list ⚠ @brief Delete a list of filter config schema items. ob_delete_filter_list ⚠ @brief Delete a list of ob_filter objects. ob_delete_frame ⚠ @brief Delete a frame object
@brief This function will decrease the reference count of the frame object and release the memory if the reference count becomes 0. ob_delete_frame_interleave_list ⚠ @brief Delete the available frame interleave list. ob_delete_pipeline ⚠ @brief Delete pipeline objects ob_delete_preset_list ⚠ @brief Delete the available preset list. ob_delete_preset_resolution_config_list ⚠ @brief Delete the available preset resolution list. ob_delete_record_device ⚠ @brief Delete a recording device. ob_delete_sensor ⚠ @brief Delete a sensor object. ob_delete_sensor_list ⚠ @brief Delete a list of sensor objects. ob_delete_stream_profile ⚠ @brief Delete the stream configuration. ob_delete_stream_profile_list ⚠ @brief Delete the stream profile list. ob_depth_frame_get_value_scale ⚠ @brief Get the value scale of the depth frame. The pixel value of the depth frame is multiplied by the scale to give a depth value in millimeters.
For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValuevalueScale = 10000 0.1=1000mm. ob_depth_frame_set_value_scale ⚠ @brief Set the value scale of the depth frame. The pixel value of the depth frame is multiplied by the scale to give a depth value in millimeters.
For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValuevalueScale = 10000 0.1=1000mm. ob_depth_work_mode_list_get_count ⚠ \if English
@brief Get the depth work mode count that ob_depth_work_mode_list hold
@param[in] work_mode_list data struct contain list of ob_depth_work_mode
@param[out] error Pointer to an error object that will be set if an error occurs.
@return The total number contained in ob_depth_work_mode_list ob_depth_work_mode_list_get_item ⚠ @brief Get the index target of ob_depth_work_mode from work_mode_list ob_device_enable_global_timestamp ⚠ @brief Enable or disable global timestamp. ob_device_enable_heartbeat ⚠ @brief Enable or disable the device heartbeat.
@brief After enable the device heartbeat, the sdk will start a thread to send heartbeat signal to the device error every 3 seconds. ob_device_export_current_settings_as_preset_json_data ⚠ @brief Export current device settings as a preset json data.
@brief After exporting the preset, a new preset named as the @ref presetName will be added to the available preset list. ob_device_export_current_settings_as_preset_json_file ⚠ @brief Export current settings as a preset json file.
@brief After exporting the custom preset, the available preset list will be appended with the custom preset and named as the file name. ob_device_frame_interleave_list_get_count ⚠ @brief Get the number of frame interleave in the frame interleave list. ob_device_frame_interleave_list_get_name ⚠ @brief Get the name of frame interleave in the frame interleave list. ob_device_frame_interleave_list_has_frame_interleave ⚠ @brief Check if the interleave ae list has the interleave ae. ob_device_get_available_frame_interleave_list ⚠ @brief Get the available frame interleave list. ob_device_get_available_preset_list ⚠ @brief Get the available preset list. ob_device_get_available_preset_resolution_config_list ⚠ ob_device_get_bool_property ⚠ @brief Get a boolean type of device property. ob_device_get_bool_property_range ⚠ @brief Get the boolean type of device property range. ob_device_get_calibration_camera_param_list ⚠ @brief Get the original parameter list of camera calibration saved on the device. ob_device_get_current_depth_work_mode ⚠ @brief Get the current depth work mode. ob_device_get_current_depth_work_mode_name ⚠ @brief Get current depth mode name
@brief According the current preset name to return current depth mode name
@return const char* return the current depth mode name. ob_device_get_current_preset_name ⚠ @brief Get the current preset name.
@brief The preset mean a set of parameters or configurations that can be applied to the device to achieve a specific effect or function. ob_device_get_depth_work_mode_list ⚠ @brief Request the list of supported depth work modes. ob_device_get_device_info ⚠ @brief Get device information. ob_device_get_device_state ⚠ @brief Get the current device status. ob_device_get_extension_info ⚠ @brief Get the device extension information.
@brief Extension information is a set of key-value pair of string, user cat get the information by the key. ob_device_get_float_property ⚠ @brief Get a float type of device property. ob_device_get_float_property_range ⚠ @brief Get the float type of device property range. ob_device_get_int_property ⚠ @brief Get an integer type of device property. ob_device_get_int_property_range ⚠ @brief Get the integer type of device property range. ob_device_get_multi_device_sync_config ⚠ @brief get the current multi device sync configuration of the device. ob_device_get_raw_data ⚠ @brief Get raw data of a device property. ob_device_get_sensor ⚠ @brief Get a device’s sensor. ob_device_get_sensor_list ⚠ @brief List all sensors. ob_device_get_structured_data ⚠ @brief Get structured data of a device property. ob_device_get_supported_multi_device_sync_mode_bitmap ⚠ @brief Get the supported multi device sync mode bitmap of the device.
@brief For example, if the return value is 0b00001100, it means the device supports @ref OB_MULTI_DEVICE_SYNC_MODE_PRIMARY and @ref
OB_MULTI_DEVICE_SYNC_MODE_SECONDARY. User can check the supported mode by the code: ob_device_get_supported_property_count ⚠ @brief Get the number of properties supported by the device. ob_device_get_supported_property_item ⚠ @brief Get the type of property supported by the device. ob_device_get_timestamp_reset_config ⚠ @brief get the timestamp reset configuration of the device. ob_device_info_get_asicName ⚠ @brief Get the chip name ob_device_info_get_connection_type ⚠ @brief Get the device connection type ob_device_info_get_device_type ⚠ @brief Get the device type ob_device_info_get_firmware_version ⚠ @brief Get the firmware version number ob_device_info_get_gateway ⚠ @brief Get the network device gateway address ob_device_info_get_hardware_version ⚠ @brief Get the hardware version number ob_device_info_get_ip_address ⚠ @brief Get the device IP address ob_device_info_get_name ⚠ @brief Get device name ob_device_info_get_pid ⚠ @brief Get device pid ob_device_info_get_serial_number ⚠ @brief Get device serial number ob_device_info_get_subnet_mask ⚠ @brief Get the network device subnet mask ob_device_info_get_supported_min_sdk_version ⚠ @brief Get the minimum SDK version number supported by the device ob_device_info_get_uid ⚠ @brief Get device uid ob_device_info_get_vid ⚠ @brief Get device vid ob_device_is_extension_info_exist ⚠ @brief Check if the device extension information exists. ob_device_is_frame_interleave_supported ⚠ @brief Check if the device supports the frame interleave feature. ob_device_is_global_timestamp_supported ⚠ @brief Check if the device supports global timestamp. ob_device_is_property_supported ⚠ @brief Check if a device property permission is supported. ob_device_list_get_count ⚠ @brief Get the number of devices ob_device_list_get_device ⚠ @brief Create a device. ob_device_list_get_device_by_serial_number ⚠ @brief Create a device. ob_device_list_get_device_by_uid ⚠ @brief Create device by uid
@brief On Linux platform, for usb device, the uid of the device is composed of bus-port-dev, for example 1-1.2-1. But the SDK will remove the dev number and
only keep the bus-port as the uid to create the device, for example 1-1.2, so that we can create a device connected to the specified USB port. Similarly,
users can also directly pass in bus-port as uid to create device.
@brief For GMSL device, the uid is GMSL port with “gmsl2-” prefix, for example gmsl2-1. ob_device_list_get_device_connection_type ⚠ @brief Get device connection type ob_device_list_get_device_gateway ⚠ @brief Get device gateway ob_device_list_get_device_ip_address ⚠ @brief Get device ip address ob_device_list_get_device_local_gateway ⚠ @brief Get the gateway of the host network interface corresponding to the network device. ob_device_list_get_device_local_ip ⚠ @brief Get the IP address of the host network interface corresponding to the network device. ob_device_list_get_device_local_mac ⚠ @brief Get the MAC address of the host network interface corresponding to the network device. ob_device_list_get_device_local_subnet_length ⚠ @brief Get the subnet length of the host network interface corresponding to the network device. ob_device_list_get_device_name ⚠ @brief Get device name ob_device_list_get_device_pid ⚠ @brief Get the pid of the specified device ob_device_list_get_device_serial_number ⚠ @brief Get the serial number of the specified device. ob_device_list_get_device_subnet_mask ⚠ @brief Get device subnet mask ob_device_list_get_device_uid ⚠ @brief Get the uid of the specified device ob_device_list_get_device_vid ⚠ @brief Get the vid of the specified device ob_device_load_frame_interleave ⚠ @brief load the frame interleave mode according to frame interleavee name. ob_device_load_preset ⚠ @brief Get the available preset list.
@attention After loading the preset, the settings in the preset will set to the device immediately. Therefore, it is recommended to re-read the device
settings to update the user program temporarily. ob_device_load_preset_from_json_data ⚠ @brief Load custom preset from data.
@brief After loading the custom preset, the settings in the custom preset will set to the device immediately.
@brief After loading the custom preset, the available preset list will be appended with the custom preset and named as the @ref presetName. ob_device_load_preset_from_json_file ⚠ @brief Load preset from json string.
@brief After loading the custom preset, the settings in the custom preset will set to the device immediately.
@brief After loading the custom preset, the available preset list will be appended with the custom preset and named as the file name. ob_device_preset_list_get_count ⚠ @brief Get the number of preset in the preset list. ob_device_preset_list_get_name ⚠ @brief Get the name of the preset in the preset list. ob_device_preset_list_has_preset ⚠ @brief Check if the preset list has the preset. ob_device_preset_resolution_config_get_count ⚠ ob_device_preset_resolution_config_list_get_item ⚠ @brief Get the preset resolution in the preset resolution list. ob_device_read_customer_data ⚠ @brief Get customer data of a device property. ob_device_reboot ⚠ @brief Device reboot
@attention The device will be disconnected and reconnected. After the device is disconnected, the interface access to the device handle may be abnormal.
Please use the ob_delete_device interface to delete the handle directly. After the device is reconnected, it can be obtained again. ob_device_send_and_receive_data ⚠ @brief Send data to the device and receive data from the device.
@brief This is a factory and debug function, which can be used to send and receive data from the device. The data format is secret and belongs to the device
vendor. ob_device_set_bool_property ⚠ @brief Set a boolean type of device property. ob_device_set_float_property ⚠ @brief Set a float type of device property. ob_device_set_int_property ⚠ @brief Set an integer type of device property. ob_device_set_multi_device_sync_config ⚠ @brief set the multi device sync configuration of the device. ob_device_set_state_changed_callback ⚠ @brief Set the device state changed callback. ob_device_set_structured_data ⚠ @brief Set structured data. ob_device_set_timestamp_reset_config ⚠ @brief set the timestamp reset configuration of the device. ob_device_switch_depth_work_mode ⚠ @brief Switch the depth work mode by ob_depth_work_mode.
Prefer to use ob_device_switch_depth_work_mode_by_name to switch depth mode when the complete name of the depth work mode is known. ob_device_switch_depth_work_mode_by_name ⚠ @brief Switch the depth work mode by work mode name. ob_device_timer_sync_with_host ⚠ @brief synchronize the timer of the device with the host.
@brief After calling this function, the timer of the device will be synchronized with the host. User can call this function to multiple devices to
synchronize all timers of the devices. ob_device_timestamp_reset ⚠ @brief send the timestamp reset command to the device.
@brief The device will reset the timer for calculating the timestamp for output frames to 0 after receiving the timestamp reset command when the timestamp
reset function is enabled. The timestamp reset function can be enabled by call @ref ob_device_set_timestamp_reset_config. ob_device_trigger_capture ⚠ @brief send the capture command to the device to trigger the capture.
@brief The device will start one time capture after receiving the capture command when it is in the @ref OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING ob_device_update_firmware ⚠ @brief Update the device firmware. ob_device_update_firmware_from_data ⚠ @brief Update the device firmware from data. ob_device_update_optional_depth_presets ⚠ @brief Update the device optional depth presets. ob_device_write_customer_data ⚠ @brief Set customer data. ob_disparity_based_stream_profile_get_disparity_param ⚠ @brief Get the process param of the disparity stream ob_disparity_based_stream_profile_set_disparity_param ⚠ @brief Set the disparity process param of the disparity stream. ob_enable_device_clock_sync ⚠ @brief Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported). ob_enable_net_device_enumeration ⚠ @brief Enable or disable network device enumeration
@brief After enabling, the network device will be automatically discovered and can be retrieved through @ref ob_query_device_list. The default state can be
set in the configuration file. ob_error_get_args ⚠ @brief Get the error parameters. ob_error_get_exception_type ⚠ @brief Get the type of exception that caused the error. ob_error_get_function ⚠ @brief Get the name of the API function that caused the error. ob_error_get_message ⚠ @brief Get the error message. ob_error_get_status ⚠ @brief Get the error status. ob_filter_config_schema_list_get_count ⚠ @brief Get the number of config schema items in the config schema list ob_filter_config_schema_list_get_item ⚠ @brief Get the config schema item by index ob_filter_enable ⚠ @brief Enable the frame post processing
@brief The filter default is enable. ob_filter_get_config_schema ⚠ @brief Get config schema of the filter
@brief The returned string is a csv format string representing the configuration schema of the filter. The format of the string is:
<parameter_name>, <parameter_type: “int”, “float”, “bool”>, <minimum_value>, <maximum_value>, <value_step>, <default_value>, <parameter_description> ob_filter_get_config_schema_list ⚠ @brief Get the filter config schema list of the filter
@brief The returned string is a list of ob_config_schema_item representing the configuration schema of the filter. ob_filter_get_config_value ⚠ @brief Get the filter config value by name and cast to double. ob_filter_get_name ⚠ @brief Get the name of ob_filter ob_filter_get_vendor_specific_code ⚠ @brief Get the vendor specific code of a filter by filter name.
@brief A private filter can define its own vendor specific code for specific purposes. ob_filter_is_enabled ⚠ @brief Get the enable status of the frame post processing ob_filter_list_get_count ⚠ @brief Get the number of filter in the list ob_filter_list_get_filter ⚠ @brief Get the filter by index ob_filter_process ⚠ @brief Process the frame (synchronous interface). ob_filter_push_frame ⚠ @brief Push the frame into the pending cache for the filter (asynchronous callback interface).
@brief The frame will be processed by the filter when the processing thread is available and return a new processed frame to the callback function. ob_filter_reset ⚠ @brief Reset the filter, clears the cache, and resets the state. If the asynchronous interface is used, the processing thread will also be stopped and the
pending cache frames will be cleared. ob_filter_set_callback ⚠ @brief Set the processing result callback function for the filter (asynchronous callback interface). ob_filter_set_config_value ⚠ @brief Set the filter config value by name. ob_filter_update_config ⚠ @brief Update config of the filter ob_force_ip_config ⚠ @brief “Force” a static IP address configuration in a device identified by its MAC Address. ob_format_to_string ⚠ @brief Convert OBFormat to “ char* “ type and then return. ob_format_type_to_string ⚠ @brief Convert OBFormat to “ char* “ type and then return. ob_frame_add_ref ⚠ @brief Increase the reference count of a frame object.
@brief The reference count is used to manage the lifetime of the frame object. ob_frame_copy_info ⚠ @brief Copy the information of the source frame object to the destination frame object.
@brief Including the index, timestamp, system timestamp, global timestamp and metadata will be copied. ob_frame_get_data ⚠ @brief Get the data buffer of a frame. ob_frame_get_data_size ⚠ @brief Get the frame data size ob_frame_get_device ⚠ @brief Get the device of the frame ob_frame_get_format ⚠ @brief Get the frame format ob_frame_get_global_timestamp_us ⚠ @brief Get the global timestamp of the frame in microseconds.
@brief The global timestamp is the time point when the frame was captured by the device, and has been converted to the host clock domain. The
conversion process base on the frame timestamp and can eliminate the timer drift of the device ob_frame_get_index ⚠ @brief Get the frame index ob_frame_get_metadata ⚠ @brief Get the metadata of the frame ob_frame_get_metadata_size ⚠ @brief Get the metadata size of the frame ob_frame_get_metadata_value ⚠ @brief Get the metadata value of the frame ob_frame_get_sensor ⚠ @brief Get the sensor of the frame ob_frame_get_stream_profile ⚠ @brief Get the stream profile of the frame ob_frame_get_system_timestamp_us ⚠ @brief Get the system timestamp of the frame in microseconds.
@brief The system timestamp is the time point when the frame was received by the host, on host clock domain. ob_frame_get_timestamp_us ⚠ @brief Get the frame timestamp (also known as device timestamp, hardware timestamp) of the frame in microseconds.
@brief The hardware timestamp is the time point when the frame was captured by the device (Typically in the mid-exposure, unless otherwise stated), on device
clock domain. ob_frame_get_type ⚠ @brief Get the frame type ob_frame_has_metadata ⚠ @brief check if the frame contains the specified metadata ob_frame_set_stream_profile ⚠ @brief Set (override) the stream profile of the frame ob_frame_set_system_timestamp_us ⚠ @brief Set the system timestamp of the frame in microseconds. ob_frame_set_timestamp_us ⚠ @brief Set the frame timestamp (also known as the device timestamp, hardware timestamp) of a frame object. ob_frame_type_to_string ⚠ @brief Convert OBFrameType to “ char* “ type and then return. ob_frame_update_data ⚠ @brief Update the data of a frame.
@brief The data will be memcpy to the frame data buffer.
@brief The frame data size will be also updated as the input data size. ob_frame_update_metadata ⚠ @brief Update the metadata of the frame
@brief The metadata will be memcpy to the frame metadata buffer.
@brief The frame metadata size will be also updated as the input metadata size. ob_frameset_get_color_frame ⚠ @brief Get the color frame from the frameset. ob_frameset_get_count ⚠ @brief Get the number of frames contained in the frameset ob_frameset_get_depth_frame ⚠ @brief Get the depth frame from the frameset. ob_frameset_get_frame ⚠ @brief Get a frame of a specific type from the frameset. ob_frameset_get_frame_by_index ⚠ @brief Get a frame at a specific index from the FrameSet ob_frameset_get_ir_frame ⚠ @brief Get the infrared frame from the frameset. ob_frameset_get_points_frame ⚠ @brief Get point cloud frame from the frameset. ob_frameset_push_frame ⚠ @brief Push a frame to the frameset ob_free_idle_memory ⚠ @brief Free idle memory from the internal frame memory pool ob_get_d2c_depth_profile_list ⚠ @brief Return a list of D2C-enabled depth sensor resolutions corresponding to the input color sensor resolution ob_get_major_version ⚠ @brief Get the SDK major version number. ob_get_minor_version ⚠ @brief Get the SDK minor version number. ob_get_patch_version ⚠ @brief Get the SDK patch version number. ob_get_stage_version ⚠ @brief Get the SDK stage version.
@attention The returned char* does not need to be freed. ob_get_version ⚠ @brief Get the SDK version number. ob_gyro_frame_get_temperature ⚠ @brief Get the temperature when acquiring the gyroscope frame. ob_gyro_frame_get_value ⚠ @brief Get gyroscope frame data. ob_gyro_range_type_to_string ⚠ @brief Convert OBGyroFullScaleRange to “ char* “ type and then return. ob_gyro_stream_get_intrinsic ⚠ @brief Get the intrinsic of the gyroscope stream. ob_gyro_stream_profile_get_full_scale_range ⚠ @brief Get the full-scale range of the gyroscope stream. ob_gyro_stream_profile_get_sample_rate ⚠ @brief Get the sampling frequency of the gyroscope stream. ob_gyro_stream_set_intrinsic ⚠ @brief Set the intrinsic of the gyroscope stream. ob_imu_rate_type_to_string ⚠ @brief Convert OBIMUSampleRate to “ char* “ type and then return. ob_ir_frame_get_source_sensor_type ⚠ @brief Get the source sensor type of the ir frame (left or right for dual camera) ob_meta_data_type_to_string ⚠ @brief Convert OBFrameMetadataType to “ char* “ type and then return. ob_pipeline_disable_frame_sync ⚠ @brief Disable frame synchronization ob_pipeline_enable_frame_sync ⚠ @brief Enable frame synchronization
@brief Synchronize the frames of different streams by using the timestamp information of the frames.
@brief Dynamically (when pipeline is started) enable/disable frame synchronization is allowed. ob_pipeline_get_calibration_param ⚠ @brief Get device calibration parameters with the specified configuration ob_pipeline_get_camera_param ⚠ @brief Get current camera parameters
@attention If D2C is enabled, it will return the camera parameters after D2C, if not, it will return to the default parameters ob_pipeline_get_camera_param_with_profile ⚠ @brief Get the current camera parameters ob_pipeline_get_config ⚠ @brief Get the configuration object associated with the pipeline
@brief Returns default configuration if the user has not configured ob_pipeline_get_device ⚠ @brief Get the device object associated with the pipeline ob_pipeline_get_stream_profile_list ⚠ @brief Get the stream profile list associated with the pipeline ob_pipeline_start ⚠ @brief Start the pipeline with default parameters ob_pipeline_start_with_callback ⚠ @brief Start the pipeline and set the frame collection data callback ob_pipeline_start_with_config ⚠ @brief Start the pipeline with configuration parameters ob_pipeline_stop ⚠ @brief Stop pipeline ob_pipeline_switch_config ⚠ @brief Switch the corresponding configuration ob_pipeline_wait_for_frameset ⚠ @brief Wait for a set of frames to be returned synchronously ob_playback_device_get_current_playback_status ⚠ @brief Get the current playback status of the played data. ob_playback_device_get_duration ⚠ @brief Get the duration of the played data. ob_playback_device_get_position ⚠ @brief Get the current playback position of the played data. ob_playback_device_pause ⚠ @brief Pause playback on the specified playback device. ob_playback_device_resume ⚠ @brief Resume playback on the specified playback device. ob_playback_device_seek ⚠ @brief Set the playback to a specified time point of the played data. ob_playback_device_set_playback_rate ⚠ @brief Set the playback to a specified time point of the played data. ob_playback_device_set_playback_status_changed_callback ⚠ @brief Set a callback function to receive playback status updates. ob_point_cloud_frame_get_height ⚠ @brief Get point cloud frame height ob_point_cloud_frame_get_width ⚠ @brief Get point cloud frame width ob_points_frame_get_coordinate_value_scale ⚠ @brief Get the point coordinate value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position
value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = xscale =
10000 0.1 = 1000mm. ob_query_device_list ⚠ @brief Get a list of enumerated devices ob_record_device_pause ⚠ @brief Pause recording on the specified recording device. ob_record_device_resume ⚠ @brief Resume recording on the specified recording device. ob_sensor_create_recommended_filter_list ⚠ @brief Create a list of recommended filters for the specified sensor. ob_sensor_get_stream_profile_list ⚠ @brief Get a list of all supported stream profiles. ob_sensor_get_type ⚠ @brief Get the type of the sensor. ob_sensor_list_get_count ⚠ @brief Get the number of sensors in the sensor list. ob_sensor_list_get_sensor ⚠ @brief Get a sensor by index number. ob_sensor_list_get_sensor_by_type ⚠ @brief Get a sensor by sensor type. ob_sensor_list_get_sensor_type ⚠ @brief Get the sensor type. ob_sensor_start ⚠ @brief Open the current sensor and set the callback data frame. ob_sensor_stop ⚠ @brief Stop the sensor stream. ob_sensor_switch_profile ⚠ @brief Switch resolutions. ob_sensor_type_to_stream_type ⚠ @brief Convert OBStreamType to OBSensorType. ob_sensor_type_to_string ⚠ @brief Convert OBSensorType to “ char* “ type and then return. ob_set_device_changed_callback ⚠ @brief Set a device plug-in callback function
@attention The added and removed device lists returned through the callback interface need to be released manually
@attention This function supports multiple callbacks. Each call to this function adds a new callback to an internal list. ob_set_extensions_directory ⚠ @brief Set the extensions directory
@brief The extensions directory is used to search for dynamic libraries that provide additional functionality to the SDK, such as the Frame filters. ob_set_logger_severity ⚠ @brief Set the global log level ob_set_logger_to_callback ⚠ @brief Set the log callback function ob_set_logger_to_console ⚠ @brief Set the log output to the console ob_set_logger_to_file ⚠ @brief Set the log output to a file ob_set_uvc_backend_type ⚠ @brief For linux, there are two ways to enable the UVC backend: libuvc and v4l2. This function is used to set the backend type.
@brief It is effective when the new device is created. ob_stream_profile_get_extrinsic_to ⚠ @brief Get the extrinsic for source stream to target stream ob_stream_profile_get_format ⚠ @brief Get stream profile format ob_stream_profile_get_type ⚠ @brief Get stream profile type ob_stream_profile_list_get_accel_stream_profile ⚠ @brief Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches,
the first one in the list will be returned by default. If no matched profile is found, an error will be returned. ob_stream_profile_list_get_count ⚠ @brief Get the number of StreamProfile lists. ob_stream_profile_list_get_gyro_stream_profile ⚠ @brief Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches,
the first one in the list will be returned by default. If no matched profile is found, an error will be returned. ob_stream_profile_list_get_profile ⚠ @brief Get the corresponding StreamProfile by subscripting. ob_stream_profile_list_get_video_stream_profile ⚠ @brief Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches,
the first one in the list will be returned by default. If no matched profile is found, an error will be returned. ob_stream_profile_set_extrinsic_to ⚠ @brief Set the extrinsic for source stream to target stream ob_stream_profile_set_extrinsic_to_type ⚠ @brief Set the extrinsic for source stream to target stream type ob_stream_profile_set_format ⚠ @brief Set stream profile format ob_stream_profile_set_type ⚠ @brief Set stream profile type ob_stream_type_to_string ⚠ @brief Convert OBStreamType to “ char* “ type and then return. ob_video_frame_get_height ⚠ @brief Get video frame height ob_video_frame_get_pixel_available_bit_size ⚠ @brief Get the effective number of pixels (such as Y16 format frame, but only the lower 10 bits are effective bits, and the upper 6 bits are filled with 0)
@attention Only valid for Y8/Y10/Y11/Y12/Y14/Y16 format ob_video_frame_get_pixel_type ⚠ @brief Get video frame pixel format
@brief Usually used to determine the pixel type of depth frame (depth, disparity, raw phase, etc.) ob_video_frame_get_width ⚠ @brief Get video frame width ob_video_frame_set_pixel_available_bit_size ⚠ @brief Set the effective number of pixels (such as Y16 format frame, but only the lower 10 bits are effective bits, and the upper 6 bits are filled with 0)
@attention Only valid for Y8/Y10/Y11/Y12/Y14/Y16 format ob_video_frame_set_pixel_type ⚠ @brief Set video frame pixel format ob_video_stream_profile_get_distortion ⚠ @brief Get the distortion of the video stream profile ob_video_stream_profile_get_fps ⚠ @brief Get the frame rate of the video stream ob_video_stream_profile_get_height ⚠ @brief Get the height of the video stream ob_video_stream_profile_get_intrinsic ⚠ @brief Get the intrinsic of the video stream profile ob_video_stream_profile_get_width ⚠ @brief Get the width of the video stream ob_video_stream_profile_set_distortion ⚠ @brief Set the distortion of the video stream profile ob_video_stream_profile_set_height ⚠ @brief Set the height of the video stream ob_video_stream_profile_set_intrinsic ⚠ @brief Set the intrinsic of the video stream profile ob_video_stream_profile_set_width ⚠ @brief Set the width of the video stream DEVICE_IP_ADDR_CONFIG @brief IP address configuration for network devices (IPv4) DEVICE_TEMPERATURE @brief Temperature parameters of the device (unit: Celsius) OBAccelFullScaleRange @brief Enumeration of accelerometer ranges OBAlignMode @brief Alignment mode OBBaselineCalibrationParam @brief Baseline calibration parameters OBCameraDistortionModel \brief Distortion model: defines how pixel coordinates should be mapped to sensor coordinates. OBCameraPerformanceMode @brief Camera performance mode OBCommunicationType @brief Device communication mode OBCompressionMode @brief Compression mode OBConvertFormat @brief Enumeration of format conversion types OBDCPowerState @brief DC power status OBDataTranState @brief Enumeration value describing the data transfer status OBDepthCroppingMode @brief Enumeration for depth crop modes OBDepthPrecisionLevel @brief 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 OBDepthWorkModeTag @brief Preset tag OBDeviceState @brief Device state OBDeviceTimestampResetConfig @brief The timestamp reset configuration of the device. OBDeviceType @brief Enumeration for device types OBExceptionType @brief 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 OBExtrinsic @brief Structure for rotation/transformation OBFileTranState @brief Enumeration value describing the file transfer status OBFilterConfigValueType OBFloat3D @brief Data structures for accelerometers and gyroscopes OBFormat @brief Enumeration value describing the pixel format OBFrameType @brief Enumeration value describing the type of frame OBGyroFullScaleRange @brief Enumeration of gyroscope ranges OBGyroValue @brief Data structures for accelerometers and gyroscopes OBHdrConfig @brief HDR Configuration OBHoleFillingMode @brief Hole fillig mode OBIMUSampleRate @brief Enumeration of IMU sample rate values (gyroscope or accelerometer) OBLogSeverity @brief log level, the higher the level, the stronger the log filter OBMarginFilterConfig @brief Configuration for depth margin filter OBMediaState @brief Enumeration for record playback status OBMediaType @brief Enumeration for types of media to record or playback OBMultiDeviceSyncConfig @brief The synchronization configuration of the device. OBPermissionType @brief the permission type of api or property OBPixelType @brief Enumeration value describing the pixel type of frame (usually used for depth frame) OBPoint3f @brief 3D point structure in the SDK OBPropertyID @brief Enumeration value describing all attribute control commands of the device OBPropertyType @brief The data type used to describe all property settings OBRegionOfInterest @brief The rect of the region of interest OBSensorType @brief Enumeration value describing the sensor type OBSerialNumber @brief struct of serial number OBStatus @brief error code OBStreamType @brief Enumeration value describing the type of data stream OBSyncMode @brief Sync mode
@deprecated This define is deprecated, please use @ref ob_multi_device_sync_mode instead OBTofFilterRange @brief Enumeration for TOF filter scene ranges OBTransform @brief Structure for rotation/transformation OBUSBPowerState @brief USB power status OBUpgradeState @brief Enumeration value describing the firmware upgrade status OB_CMD_VERSION @brief Command version associated with property id OB_COMPRESSION_PARAMS Compression Params OB_COORDINATE_SYSTEM_TYPE @brief Enumeration of point cloud coordinate system types OB_DDO_NOISE_REMOVAL_TYPE @brief Denoising method OB_DEVICE_DEVELOPMENT_MODE @brief Enumeration of device development modes OB_DEVICE_SYNC_CONFIG @brief Device synchronization configuration
@deprecated This structure is deprecated, please use @ref ob_multi_device_sync_config instead OB_EDGE_NOISE_REMOVAL_TYPE OB_FRAME_AGGREGATE_OUTPUT_MODE @brief Frame aggregate output mode TOF_EXPOSURE_THRESHOLD_CONTROL @brief TOF Exposure Threshold __blkcnt64_t __blkcnt_t __blksize_t __caddr_t __clock_t __clockid_t __daddr_t __dev_t __fsblkcnt64_t __fsblkcnt_t __fsfilcnt64_t __fsfilcnt_t __fsword_t __gid_t __id_t __ino64_t __ino_t __int8_t __int16_t __int32_t __int64_t __int_least8_t __int_least16_t __int_least32_t __int_least64_t __intmax_t __intptr_t __key_t __loff_t __mode_t __nlink_t __off64_t __off_t __pid_t __quad_t __rlim64_t __rlim_t __sig_atomic_t __socklen_t __ssize_t __suseconds64_t __suseconds_t __syscall_slong_t __syscall_ulong_t __time_t __timer_t __u_char __u_int __u_long __u_quad_t __u_short __uid_t __uint8_t __uint16_t __uint32_t __uint64_t __uint_least8_t __uint_least16_t __uint_least32_t __uint_least64_t __uintmax_t __useconds_t int_fast8_t int_fast16_t int_fast32_t int_fast64_t int_least8_t int_least16_t int_least32_t int_least64_t intmax_t ob_accel_intrinsic @brief Structure for accelerometer intrinsic parameters ob_accel_value @brief Data structures for accelerometers and gyroscopes ob_baseline_calibration_param @brief Baseline calibration parameters ob_bool_property_range @brief Structure for boolean range ob_calibration_param @brief calibration parameters ob_camera_distortion @brief Structure for distortion parameters ob_camera_intrinsic @brief Structure for camera intrinsic parameters ob_camera_param @brief Structure for camera parameters ob_camera_param_list ob_color_point @brief 3D point structure with color information ob_compression_params Compression Params ob_config ob_context ob_d2c_transform @brief Structure for rotation/transformation ob_data_chunk @brief Structure for transmitting data blocks ob_depth_work_mode @brief Depth work mode ob_depth_work_mode_list ob_device ob_device_changed_callback @brief Callback for device change ob_device_frame_interleave_list ob_device_fw_update_callback @brief Callback for firmware upgrade ob_device_info ob_device_list ob_device_preset_list ob_device_serial_number @brief struct of serial number ob_device_state @brief Device state ob_device_state_callback @brief Callback for device status ob_device_sync_config @brief Device synchronization configuration
@deprecated This structure is deprecated, please use @ref ob_multi_device_sync_config instead ob_device_temperature @brief Temperature parameters of the device (unit: Celsius) ob_disp_offset_config @brief Disparity offset interleaving configuration ob_disparity_param @brief disparity parameters for disparity based camera ob_edge_noise_removal_filter_params ob_extrinsic @brief Structure for rotation/transformation ob_file_send_callback @brief Callback for file transfer ob_filter ob_filter_config_schema_item @brief Configuration Item for the filter ob_filter_config_schema_list ob_filter_list ob_float_3d @brief Data structures for accelerometers and gyroscopes ob_float_property_range @brief Structure for float range ob_frame ob_frame_callback @brief Callback for frame ob_frame_destroy_callback @brief Customize the delete callback ob_frame_metadata_type @brief Frame metadata types
@brief The frame metadata is a set of meta info generated by the device for current individual frame. ob_frameset_callback @brief Callback for frameset ob_get_data_callback @brief Callback for reading data ob_gyro_intrinsic @brief Structure for gyroscope intrinsic parameters ob_gyro_value @brief Data structures for accelerometers and gyroscopes ob_hdr_config @brief HDR Configuration ob_int_property_range @brief Structure for integer range ob_intra_camera_sync_reference @brief Intra-camera Sync Reference based on the exposure start time, the exposure middle time, or the exposure end time. ob_log_callback @brief Callback for receiving log ob_media_state_callback @brief Callback for media status (recording and playback) ob_mgc_filter_config @brief Configuration for mgc filter ob_multi_device_sync_mode @brief The synchronization mode of the device. ob_net_ip_config @brief IP address configuration for network devices (IPv4) ob_noise_removal_filter_params ob_pipeline ob_playback_device ob_playback_status @brief The playback status of the media ob_playback_status_changed_callback ob_point @brief 3D point structure in the SDK ob_point2f @brief 2D point structure in the SDK ob_point3f @brief 3D point structure in the SDK ob_power_line_freq_mode @brief Power line frequency mode, for color camera anti-flicker configuration ob_preset_resolution_config_list ob_preset_resolution_ratio_config ob_property_item @brief Used to describe the characteristics of each property ob_protocol_version @brief Control command protocol version number ob_record_device ob_rect @brief Rectangle ob_region_of_interest @brief The rect of the region of interest ob_rotate_degree_type @brief Rotate degree ob_sensor ob_sensor_list ob_sequence_id_item @brief SequenceId fliter list item ob_serial_number @brief struct of serial number ob_set_data_callback @brief Callback for writing data ob_spatial_advanced_filter_params ob_spatial_fast_filter_params ob_spatial_moderate_filter_params ob_stream_profile ob_stream_profile_list ob_tof_exposure_threshold_control @brief TOF Exposure Threshold ob_transform @brief Structure for rotation/transformation ob_uint8_property_range @brief Structure for float range ob_uint16_property_range @brief Structure for float range ob_uvc_backend_type @brief 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. ob_xy_tables uint_fast8_t uint_fast16_t uint_fast32_t uint_fast64_t uint_least8_t uint_least16_t uint_least32_t uint_least64_t uintmax_t