OrbbecSDK 2.8.6
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Loading...
Searching...
No Matches
ObTypes.h
Go to the documentation of this file.
1// Copyright (c) Orbbec Inc. All Rights Reserved.
2// Licensed under the MIT License.
3
8
9#pragma once
10
11#include "Export.h"
12
13#include <stdbool.h>
14#include <stdint.h>
15
16#pragma pack(push, 1) // struct 1-byte align
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22typedef struct ob_context_t ob_context;
23typedef struct ob_device_t ob_device;
24typedef struct ob_device_info_t ob_device_info;
25typedef struct ob_device_list_t ob_device_list;
26typedef struct ob_record_device_t ob_record_device;
27typedef struct ob_playback_device_t ob_playback_device;
28typedef struct ob_camera_param_list_t ob_camera_param_list;
29typedef struct ob_sensor_t ob_sensor;
30typedef struct ob_sensor_list_t ob_sensor_list;
31typedef struct ob_stream_profile_t ob_stream_profile;
32typedef struct ob_stream_profile_list_t ob_stream_profile_list;
33typedef struct ob_frame_t ob_frame;
34typedef struct ob_filter_t ob_filter;
35typedef struct ob_filter_list_t ob_filter_list;
36typedef struct ob_pipeline_t ob_pipeline;
37typedef struct ob_config_t ob_config;
38typedef struct ob_depth_work_mode_list_t ob_depth_work_mode_list;
39typedef struct ob_device_preset_list_t ob_device_preset_list;
40typedef struct ob_filter_config_schema_list_t ob_filter_config_schema_list;
41typedef struct ob_device_frame_interleave_list_t ob_device_frame_interleave_list;
42typedef struct ob_preset_resolution_config_list_t ob_preset_resolution_config_list;
43
44#define OB_WIDTH_ANY 0
45#define OB_HEIGHT_ANY 0
46#define OB_FPS_ANY 0
47#define OB_FORMAT_ANY OB_FORMAT_UNKNOWN
48#define OB_PROFILE_DEFAULT 0
49#define OB_DEFAULT_STRIDE_BYTES 0
50#define OB_ACCEL_FULL_SCALE_RANGE_ANY OB_ACCEL_FS_UNKNOWN
51#define OB_ACCEL_SAMPLE_RATE_ANY OB_SAMPLE_RATE_UNKNOWN
52#define OB_GYRO_FULL_SCALE_RANGE_ANY OB_GYRO_FS_UNKNOWN
53#define OB_GYRO_SAMPLE_RATE_ANY OB_SAMPLE_RATE_UNKNOWN
54#define OB_LIDAR_SCAN_ANY OB_LIDAR_SCAN_UNKNOWN
55
59#define OB_PATH_MAX (1024)
60
72
117
130#define OB_LOG_SEVERITY_NONE OB_LOG_SEVERITY_OFF
131
155
166
175
196
218
242
247typedef enum {
248 OB_PIXEL_UNKNOWN = -1, // Unknown pixel type, or undefined pixel type for current frame
249 OB_PIXEL_DEPTH = 0, // Depth pixel type, the value of the pixel is the distance from the camera to the object
250 OB_PIXEL_DISPARITY = 2, // Disparity for structured light camera
251 OB_PIXEL_RAW_PHASE = 3, // Raw phase for tof camera
252 OB_PIXEL_TOF_DEPTH = 4, // Depth for tof camera
255
301
302#define OB_FORMAT_RGB888 OB_FORMAT_RGB // Alias of OB_FORMAT_RGB for compatibility
303#define OB_FORMAT_MJPEG OB_FORMAT_MJPG // Alias of OB_FORMAT_MJPG for compatibility
304
305// Check if the format is a fixed data size format
306#define IS_FIXED_SIZE_FORMAT(format) \
307 (format != OB_FORMAT_MJPG && format != OB_FORMAT_H264 && format != OB_FORMAT_H265 && format != OB_FORMAT_HEVC && format != OB_FORMAT_RLE \
308 && format != OB_FORMAT_RVL)
309
310// Check if the format is a packed format, which means the data of pixels is not continuous or bytes aligned in memory
311#define IS_PACKED_FORMAT(format) \
312 (format == OB_FORMAT_Y10 || format == OB_FORMAT_Y11 || format == OB_FORMAT_Y12 || format == OB_FORMAT_Y14 || format == OB_FORMAT_RLE)
313
341
357
374
378typedef struct {
379 uint8_t *data;
380 uint32_t size;
381 uint32_t offset;
382 uint32_t fullDataSize;
384
388typedef struct {
389 int32_t cur;
390 int32_t max;
391 int32_t min;
392 int32_t step;
393 int32_t def;
395
399typedef struct {
400 float cur;
401 float max;
402 float min;
403 float step;
404 float def;
406
410typedef struct {
411 uint16_t cur;
412 uint16_t max;
413 uint16_t min;
414 uint16_t step;
415 uint16_t def;
417
421typedef struct {
422 uint8_t cur;
423 uint8_t max;
424 uint8_t min;
425 uint8_t step;
426 uint8_t def;
428
432typedef struct {
433 bool cur;
434 bool max;
435 bool min;
436 bool step;
437 bool def;
439
451
455typedef struct {
456 float fx;
457 float fy;
458 float cx;
459 float cy;
460 int16_t width;
461 int16_t height;
463
467typedef struct {
469 double randomWalk;
471 double bias[3];
472 double gravity[3];
474 double tempSlope[9];
476
488
492typedef struct {
493 float k1;
494 float k2;
495 float k3;
496 float k4;
497 float k5;
498 float k6;
499 float p1;
500 float p2;
503
511
523
530
541
554
569
579
588
592typedef struct {
593 uint32_t x;
594 uint32_t y;
595 uint32_t width;
596 uint32_t height;
598
627
628// DEPRECATED: Only used for old version program compatibility, will be completely deleted in subsequent iterative versions
629#define FORMAT_MJPEG_TO_I420 FORMAT_MJPG_TO_I420
630#define FORMAT_MJPEG_TO_NV21 FORMAT_MJPG_TO_NV21
631#define FORMAT_MJPEG_TO_BGRA FORMAT_MJPG_TO_BGRA
632#define FORMAT_YUYV_TO_RGB888 FORMAT_YUYV_TO_RGB
633#define FORMAT_I420_TO_RGB888 FORMAT_I420_TO_RGB
634#define FORMAT_NV21_TO_RGB888 FORMAT_NV21_TO_RGB
635#define FORMAT_NV12_TO_RGB888 FORMAT_NV12_TO_RGB
636#define FORMAT_UYVY_TO_RGB888 FORMAT_UYVY_TO_RGB
637#define FORMAT_MJPG_TO_RGB888 FORMAT_MJPG_TO_RGB
638#define FORMAT_MJPG_TO_BGR888 FORMAT_MJPG_TO_BGR
639#define FORMAT_MJPEG_TO_RGB888 FORMAT_MJPG_TO_RGB
640#define FORMAT_MJPEG_TO_BGR888 FORMAT_MJPG_TO_BGR
641#define FORMAT_RGB888_TO_BGR FORMAT_RGB_TO_BGR
642
667
685
701
710
725
730
742
746#define OB_SDK_STATUS_FRAME_DROP_DATA (1ULL << 0)
747#define OB_SDK_STATUS_FRAME_DROP_TIMESTAMP (1ULL << 1)
748#define OB_SDK_STATUS_FRAME_DROP_MATCH (1ULL << 2)
749#define OB_SDK_STATUS_FRAME_QUEUE_OVERFLOW (1ULL << 3)
750#define OB_SDK_STATUS_FRAME_WAIT_TIMEOUT (1ULL << 4)
751#define OB_SDK_STATUS_STREAM_NO_FRAME (1ULL << 5)
752
763
780
790
801
821
832
850
855typedef struct {
856 double zpd; // the distance to calib plane
857 double zpps; // zpps=z0/fx
858 float baseline; // baseline length, for monocular camera,it means the distance of laser to the center of IR-CMOS
859 double fx; // focus
860 uint8_t bitSize; // disparity bit size (raw disp bit size, for example: MX6000 is 12, MX6600 is 14)
861 float unit; // reference units: unit=10 denote 1cm; unit=1 denote 1mm; unit=0.5 denote 0.5mm; and so on
862 float minDisparity; // dual disparity coefficient
863 uint8_t packMode; // data pack mode
864 float dispOffset; // disparity offset, actual disp=chip disp + disp_offset
865 int32_t invalidDisp; // invalid disparity, usually is 0, dual IR add a auxiliary value.
866 int32_t dispIntPlace; // disp integer digits, default is 8, Gemini2 XL is 10
867 uint8_t isDualCamera; // 0 monocular camera, 1 dual camera
869
883typedef struct {
884 float x;
885 float y;
886 float z;
888
892typedef struct {
893 float x;
894 float y;
896
897typedef struct {
898 float *xTable;
899 float *yTable;
900 int width;
901 int height;
903
907typedef struct {
908 float x;
909 float y;
910 float z;
911 float r;
912 float g;
913 float b;
915
924
928typedef struct {
929 float x;
930 float y;
931 float z;
932 uint8_t reflectivity;
933 uint8_t tag;
935
939typedef struct {
940 float distance;
941 float theta;
942 float phi;
943 uint8_t reflectivity;
944 uint8_t tag;
946
955
965
973
1053
1111
1120
1140
1148
1152typedef enum {
1154 OB_HOLE_FILL_NEAREST = 1, // "max" means farest for depth, and nearest for disparity; FILL_NEAREST
1155 OB_HOLE_FILL_FAREST = 2, // FILL_FAREST
1158
1162
1163typedef struct {
1164 uint8_t radius; // window_size
1165 uint8_t magnitude; // magnitude
1166 uint16_t disp_diff; // smooth_delta
1168
1169typedef struct {
1170 uint8_t magnitude; // magnitude
1171 float alpha; // smooth_alpha
1172 uint16_t disp_diff; // smooth_delta
1173 uint16_t radius; // hole_fill
1175
1183
1192
1198
1208
1223
1233
1237typedef struct {
1241 uint8_t major;
1242
1246 uint8_t minor;
1247
1251 uint8_t patch;
1253
1257typedef enum {
1258 OB_CMD_VERSION_V0 = (uint16_t)0,
1259 OB_CMD_VERSION_V1 = (uint16_t)1,
1260 OB_CMD_VERSION_V2 = (uint16_t)2,
1261 OB_CMD_VERSION_V3 = (uint16_t)3,
1262
1263 OB_CMD_VERSION_NOVERSION = (uint16_t)0xfffe,
1264 OB_CMD_VERSION_INVALID = (uint16_t)0xffff,
1267
1291typedef struct {
1297 uint16_t dhcp;
1298
1302 uint8_t address[4];
1303
1307 uint8_t mask[4];
1308
1312 uint8_t gateway[4];
1314
1315#define OBDeviceIpAddrConfig OBNetIpConfig
1316#define ob_device_ip_addr_config OBNetIpConfig
1317
1318// IP bit masks
1319#define OB_NET_IP_FLAG_DHCP (0x01u)
1320#define OB_NET_IP_FLAG_PERSISTENT (0x02u)
1321
1340typedef struct {
1341 uint16_t flags;
1345 uint8_t address[4];
1346 uint8_t mask[4];
1347 uint8_t gateway[4];
1349
1353typedef enum {
1358
1369
1378
1389
1399
1431#define OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE
1432
1441
1457
1461typedef enum {
1467
1476
1571
1634
1662
1676
1680typedef struct {
1681
1689 uint8_t enable;
1691 uint32_t exposure_1;
1692 uint32_t gain_1;
1693 uint32_t exposure_2;
1694 uint32_t gain_2;
1696
1706
1726
1733
1743
1752
1757typedef enum {
1764
1772
1777
1783
1790
1797
1803
1808
1813
1818
1823
1828
1833
1838
1843
1849
1856
1861
1867
1872
1877
1882
1887
1892
1897
1902
1907
1912
1919
1924
1930
1935
1940
1945
1953
1983
1995
2005
2006// For compatibility
2007#define OB_FRAME_METADATA_TYPE_LASER_POWER_MODE OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL
2008#define OB_FRAME_METADATA_TYPE_EMITTER_MODE OB_FRAME_METADATA_TYPE_LASER_STATUS
2009#define START_OF_EXPOSURE OB_START_OF_EXPOSURE
2010#define MIDDLE_OF_EXPOSURE OB_MIDDLE_OF_EXPOSURE
2011#define END_OF_EXPOSURE OB_END_OF_EXPOSURE
2012
2024
2032
2041typedef void (*ob_file_send_callback)(ob_file_tran_state state, const char *message, uint8_t percent, void *user_data);
2042
2051typedef void (*ob_device_fw_update_callback)(ob_fw_update_state state, const char *message, uint8_t percent, void *user_data);
2052
2060typedef void (*ob_device_state_callback)(ob_device_state state, const char *message, void *user_data);
2061
2069typedef void (*ob_set_data_callback)(ob_data_tran_state state, uint8_t percent, void *user_data);
2070
2078typedef void (*ob_get_data_callback)(ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data);
2079
2086typedef void (*ob_media_state_callback)(ob_media_state state, void *user_data);
2087
2095typedef void (*ob_device_changed_callback)(ob_device_list *removed, ob_device_list *added, void *user_data);
2096
2097// typedef void (*ob_net_device_added_callback)(const char *added, void *user_data);
2098// typedef void (*ob_net_device_removed_callback)(const char *removed, void *user_data);
2099
2106typedef void (*ob_frame_callback)(ob_frame *frame, void *user_data);
2107#define ob_filter_callback ob_frame_callback
2108#define ob_playback_callback ob_frame_callback
2109
2116typedef void (*ob_frameset_callback)(ob_frame *frameset, void *user_data);
2117
2124typedef void(ob_frame_destroy_callback)(uint8_t *buffer, void *user_data);
2125
2133typedef void(ob_log_callback)(ob_log_severity severity, const char *message, void *user_data);
2134
2141typedef void (*ob_playback_status_changed_callback)(ob_playback_status status, void *user_data);
2142
2149typedef void (*ob_pipeline_status_callback)(ob_pipeline_status status, void *user_data);
2150
2155#define INVALID_CALLBACK_ID (0)
2156
2163#define ob_is_video_sensor_type(sensor_type) \
2164 (sensor_type == OB_SENSOR_COLOR || sensor_type == OB_SENSOR_COLOR_LEFT || sensor_type == OB_SENSOR_COLOR_RIGHT || sensor_type == OB_SENSOR_DEPTH \
2165 || sensor_type == OB_SENSOR_IR || sensor_type == OB_SENSOR_IR_LEFT || sensor_type == OB_SENSOR_IR_RIGHT || sensor_type == OB_SENSOR_CONFIDENCE)
2166
2173#define ob_is_video_stream_type(stream_type) \
2174 (stream_type == OB_STREAM_COLOR || stream_type == OB_STREAM_COLOR_LEFT || stream_type == OB_STREAM_COLOR_RIGHT || stream_type == OB_STREAM_DEPTH \
2175 || stream_type == OB_STREAM_IR || stream_type == OB_STREAM_IR_LEFT || stream_type == OB_STREAM_IR_RIGHT || stream_type == OB_STREAM_VIDEO \
2176 || stream_type == OB_STREAM_CONFIDENCE)
2177
2184#define is_ir_sensor(sensor_type) (sensor_type == OB_SENSOR_IR || sensor_type == OB_SENSOR_IR_LEFT || sensor_type == OB_SENSOR_IR_RIGHT)
2185#define isIRSensor is_ir_sensor
2186
2193#define is_color_sensor(sensor_type) (sensor_type == OB_SENSOR_COLOR || sensor_type == OB_SENSOR_COLOR_LEFT || sensor_type == OB_SENSOR_COLOR_RIGHT)
2194#define isColorSensor is_color_sensor
2195
2202#define is_ir_stream(stream_type) (stream_type == OB_STREAM_IR || stream_type == OB_STREAM_IR_LEFT || stream_type == OB_STREAM_IR_RIGHT)
2203#define isIRStream is_ir_stream
2204
2211#define is_color_stream(stream_type) (stream_type == OB_STREAM_COLOR || stream_type == OB_STREAM_COLOR_LEFT || stream_type == OB_STREAM_COLOR_RIGHT)
2212#define isColorStream is_color_stream
2213
2220#define is_ir_frame(frame_type) (frame_type == OB_FRAME_IR || frame_type == OB_FRAME_IR_LEFT || frame_type == OB_FRAME_IR_RIGHT)
2221#define isIRFrame is_ir_frame
2222
2229#define is_color_frame(frame_type) (frame_type == OB_FRAME_COLOR || frame_type == OB_FRAME_COLOR_LEFT || frame_type == OB_FRAME_COLOR_RIGHT)
2230#define isColorFrame is_color_frame
2231
2235#define OB_DEFAULT_DECRYPT_KEY (nullptr)
2236
2237#ifdef __cplusplus
2238}
2239#endif
2240
2241#pragma pack(pop)
struct ob_filter_list_t ob_filter_list
Definition ObTypes.h:35
struct ob_sensor_t ob_sensor
Definition ObTypes.h:29
struct ob_frame_t ob_frame
Definition ObTypes.h:33
enum OBDepthPrecisionLevel OBDepthUnit
struct OBAccelValue OBGyroValue
struct OBD2CTransform ob_d2c_transform
enum OBFormat ob_format
enum OBMediaType ob_media_type
void(* ob_get_data_callback)(ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data)
Callback for reading data.
Definition ObTypes.h:2078
enum ob_power_line_freq_mode OBPowerLineFreqMode
struct OBPoint2f ob_point2f
struct OBCameraParam ob_camera_param
enum OBPipelineIssue ob_pipeline_issue
OBLiDARScanRate
Data structures for LiDAR scan rate.
Definition ObTypes.h:714
@ OB_LIDAR_SCAN_25HZ
Definition ObTypes.h:720
@ OB_LIDAR_SCAN_20HZ
Definition ObTypes.h:719
@ OB_LIDAR_SCAN_30HZ
Definition ObTypes.h:721
@ OB_LIDAR_SCAN_10HZ
Definition ObTypes.h:717
@ OB_LIDAR_SCAN_UNKNOWN
Definition ObTypes.h:715
@ OB_LIDAR_SCAN_15HZ
Definition ObTypes.h:718
@ OB_LIDAR_SCAN_5HZ
Definition ObTypes.h:716
@ OB_LIDAR_SCAN_40HZ
Definition ObTypes.h:722
enum OBDepthPrecisionLevel ob_depth_unit
OBSensorType
Enumeration value describing the sensor type.
Definition ObTypes.h:179
@ OB_SENSOR_CONFIDENCE
Definition ObTypes.h:189
@ OB_SENSOR_IR_RIGHT
Definition ObTypes.h:187
@ OB_SENSOR_COLOR_RIGHT
Definition ObTypes.h:192
@ OB_SENSOR_GYRO
Definition ObTypes.h:185
@ OB_SENSOR_COLOR
Definition ObTypes.h:182
@ OB_SENSOR_TYPE_COUNT
Definition ObTypes.h:193
@ OB_SENSOR_LIDAR
Definition ObTypes.h:190
@ OB_SENSOR_UNKNOWN
Definition ObTypes.h:180
@ OB_SENSOR_IR
Definition ObTypes.h:181
@ OB_SENSOR_DEPTH
Definition ObTypes.h:183
@ OB_SENSOR_IR_LEFT
Definition ObTypes.h:186
@ OB_SENSOR_ACCEL
Definition ObTypes.h:184
@ OB_SENSOR_RAW_PHASE
Definition ObTypes.h:188
@ OB_SENSOR_COLOR_LEFT
Definition ObTypes.h:191
enum OBSyncMode ob_sync_mode
enum OBUpgradeState ob_upgrade_state
void(* ob_device_changed_callback)(ob_device_list *removed, ob_device_list *added, void *user_data)
Callback for device change.
Definition ObTypes.h:2095
struct OBAccelValue ob_float_3d
OBIMUSampleRate
Enumeration of IMU sample rate values (gyroscope or accelerometer)
Definition ObTypes.h:646
@ OB_SAMPLE_RATE_100_HZ
Definition ObTypes.h:654
@ OB_SAMPLE_RATE_4_KHZ
Definition ObTypes.h:659
@ OB_SAMPLE_RATE_800_HZ
Definition ObTypes.h:664
@ OB_SAMPLE_RATE_3_125_HZ
Definition ObTypes.h:649
@ OB_SAMPLE_RATE_6_25_HZ
Definition ObTypes.h:650
@ OB_SAMPLE_RATE_UNKNOWN
Definition ObTypes.h:647
@ OB_SAMPLE_RATE_500_HZ
Definition ObTypes.h:656
@ OB_SAMPLE_RATE_32_KHZ
Definition ObTypes.h:662
@ OB_SAMPLE_RATE_50_HZ
Definition ObTypes.h:653
@ OB_SAMPLE_RATE_1_5625_HZ
Definition ObTypes.h:648
@ OB_SAMPLE_RATE_12_5_HZ
Definition ObTypes.h:651
@ OB_SAMPLE_RATE_400_HZ
Definition ObTypes.h:663
@ OB_SAMPLE_RATE_1_KHZ
Definition ObTypes.h:657
@ OB_SAMPLE_RATE_200_HZ
Definition ObTypes.h:655
@ OB_SAMPLE_RATE_2_KHZ
Definition ObTypes.h:658
@ OB_SAMPLE_RATE_25_HZ
Definition ObTypes.h:652
@ OB_SAMPLE_RATE_16_KHZ
Definition ObTypes.h:661
@ OB_SAMPLE_RATE_8_KHZ
Definition ObTypes.h:660
struct OBDeviceSerialNumber ob_device_serial_number
struct OBPresetResolutionConfig ob_preset_resolution_ratio_config
struct OBSequenceIdItem ob_sequence_id_item
enum OBDCPowerState ob_dc_power_state
struct ob_camera_param_list_t ob_camera_param_list
Definition ObTypes.h:28
struct OBColorPoint ob_color_point
struct OBDeviceSyncConfig OB_DEVICE_SYNC_CONFIG
struct OBPoint OBPoint3f
OBStatus
error code
Definition ObTypes.h:76
@ OB_ERROR_DEVICE_RESPONSE_CHANNEL_FAILURE
Definition ObTypes.h:113
@ OB_ERROR_DEVICE_CONNECT_FAILED
Definition ObTypes.h:92
@ OB_ERROR_DEVICE_DISCONNECTED
Definition ObTypes.h:94
@ OB_ERROR_BUFFER_TOO_SMALL
Definition ObTypes.h:85
@ OB_ERROR_INVALID_DATA_LEN
Definition ObTypes.h:84
@ OB_ERROR_DEVICE_RESPONSE_WARNING
Definition ObTypes.h:112
@ OB_ERROR_DEVICE_ACCESS_DENIED
Definition ObTypes.h:93
@ OB_ERROR_DEVICE_UNKNOWN
Definition ObTypes.h:106
@ OB_ERROR_DEVICE_RESPONSE_WRONG_ID
Definition ObTypes.h:108
@ OB_ERROR_IO_FAILURE
Definition ObTypes.h:97
@ OB_ERROR_DEVICE_RESPONSE_WRONG_OPCODE
Definition ObTypes.h:109
@ OB_ERROR_INVALID_PARAMETER
Definition ObTypes.h:82
@ OB_ERROR_FRAME_DATA
Definition ObTypes.h:102
@ OB_ERROR_DEVICE_RESPONSE_ERROR
Definition ObTypes.h:111
@ OB_ERROR_RESOURCE_BUSY
Definition ObTypes.h:98
@ OB_ERROR_INVALID_DATA
Definition ObTypes.h:83
@ OB_ERROR_NOT_IMPLEMENTED
Definition ObTypes.h:88
@ OB_ERROR_MEMORY
Definition ObTypes.h:86
@ OB_ERROR_FRAME_DATA_LEN
Definition ObTypes.h:103
@ OB_ERROR_WRONG_API_CALL_SEQUENCE
Definition ObTypes.h:90
@ OB_ERROR_ITEM_NOT_FOUND
Definition ObTypes.h:96
@ OB_ERROR_WAIT_TIMEOUT
Definition ObTypes.h:87
@ OB_STATUS_OK
Definition ObTypes.h:77
@ OB_ERROR_FRAME_QUEUE_OVERFLOW
Definition ObTypes.h:101
@ OB_ERROR_UNSUPPORTED_OPERATION
Definition ObTypes.h:89
@ OB_ERROR_NO_DEVICE
Definition ObTypes.h:91
@ OB_STATUS_ERROR
Definition ObTypes.h:78
@ OB_ERROR_UNKNOWN
Definition ObTypes.h:79
@ OB_ERROR_DEVICE_RESPONSE_BAD_MAGIC
Definition ObTypes.h:107
@ OB_ERROR_DEVICE_UNAVAILABLE
Definition ObTypes.h:95
@ OB_ERROR_DEVICE_RESPONSE_WRONG_DATA_SIZE
Definition ObTypes.h:110
struct OBLiDARPoint ob_lidar_point
ob_device_access_mode
Device access mode for GVCP device.
Definition ObTypes.h:2016
@ OB_DEVICE_DEFAULT_ACCESS
Default access: control access for capable devices, ignored otherwise.
Definition ObTypes.h:2021
@ OB_DEVICE_MONITOR_ACCESS
Monitor access: read-only; no write or control privileges.
Definition ObTypes.h:2020
@ OB_DEVICE_ACCESS_DENIED
No access. This value is only used as a return value.
Definition ObTypes.h:2017
@ OB_DEVICE_EXCLUSIVE_ACCESS
Exclusive access: full read/write, no other application allowed; can preempt existing monitor access.
Definition ObTypes.h:2018
@ OB_DEVICE_CONTROL_ACCESS
Control access: read/write allowed; other applications permitted read-only monitor access.
Definition ObTypes.h:2019
struct ob_device_info_t ob_device_info
Definition ObTypes.h:24
struct OBHardwareDecimationConfig ob_hardware_decimation_config
enum OB_DDO_NOISE_REMOVAL_TYPE ob_ddo_noise_removal_type
OBGyroFullScaleRange
Enumeration of gyroscope ranges.
Definition ObTypes.h:671
@ OB_GYRO_FS_800dps
Definition ObTypes.h:682
@ OB_GYRO_FS_UNKNOWN
Definition ObTypes.h:672
@ OB_GYRO_FS_500dps
Definition ObTypes.h:678
@ OB_GYRO_FS_250dps
Definition ObTypes.h:677
@ OB_GYRO_FS_62dps
Definition ObTypes.h:675
@ OB_GYRO_FS_16dps
Definition ObTypes.h:673
@ OB_GYRO_FS_125dps
Definition ObTypes.h:676
@ OB_GYRO_FS_400dps
Definition ObTypes.h:681
@ OB_GYRO_FS_1000dps
Definition ObTypes.h:679
@ OB_GYRO_FS_31dps
Definition ObTypes.h:674
@ OB_GYRO_FS_2000dps
Definition ObTypes.h:680
struct BASELINE_CALIBRATION_PARAM ob_baseline_calibration_param
enum OB_EDGE_NOISE_REMOVAL_TYPE OBEdgeNoiseRemovalType
struct ob_context_t ob_context
Definition ObTypes.h:22
enum OBLogSeverity OBDeviceLogSeverityLevel
enum OBIMUSampleRate OB_SAMPLE_RATE
struct ob_stream_profile_t ob_stream_profile
Definition ObTypes.h:31
struct OBXYTables ob_xy_tables
uint64_t OBDeviceState
Device state.
Definition ObTypes.h:729
struct OBDeviceTemperature DEVICE_TEMPERATURE
enum OBExceptionType ob_exception_type
enum OB_FRAME_AGGREGATE_OUTPUT_MODE ob_frame_aggregate_output_mode
ob_power_line_freq_mode
Power line frequency mode, for color camera anti-flicker configuration.
Definition ObTypes.h:1393
@ OB_POWER_LINE_FREQ_MODE_60HZ
60Hz
Definition ObTypes.h:1396
@ OB_POWER_LINE_FREQ_MODE_50HZ
50Hz
Definition ObTypes.h:1395
@ OB_POWER_LINE_FREQ_MODE_CLOSE
Close.
Definition ObTypes.h:1394
OBGvcpPortScheme
GVCP port scheme.
Definition ObTypes.h:170
@ OB_GVCP_PORT_SCHEME_STANDARD
Definition ObTypes.h:171
@ OB_GVCP_PORT_SCHEME_B
Definition ObTypes.h:172
OBMediaState
Enumeration for record playback status.
Definition ObTypes.h:825
@ OB_MEDIA_BEGIN
Definition ObTypes.h:826
@ OB_MEDIA_RESUME
Definition ObTypes.h:828
@ OB_MEDIA_END
Definition ObTypes.h:829
@ OB_MEDIA_PAUSE
Definition ObTypes.h:827
OBFormat
Enumeration value describing the pixel format.
Definition ObTypes.h:259
@ OB_FORMAT_YUYV
Definition ObTypes.h:261
@ OB_FORMAT_Y11
Definition ObTypes.h:272
@ OB_FORMAT_ACCEL
Definition ObTypes.h:277
@ OB_FORMAT_Y12C4
Definition ObTypes.h:294
@ OB_FORMAT_Y16
Definition ObTypes.h:269
@ OB_FORMAT_RGB_POINT
Definition ObTypes.h:280
@ OB_FORMAT_BA81
Definition ObTypes.h:290
@ OB_FORMAT_YV12
Definition ObTypes.h:289
@ OB_FORMAT_RGBA
Definition ObTypes.h:291
@ OB_FORMAT_BGR
Definition ObTypes.h:283
@ OB_FORMAT_Z16
Definition ObTypes.h:288
@ OB_FORMAT_Y12
Definition ObTypes.h:273
@ OB_FORMAT_BGRA
Definition ObTypes.h:285
@ OB_FORMAT_LIDAR_CALIBRATION
Definition ObTypes.h:298
@ OB_FORMAT_NV21
Definition ObTypes.h:265
@ OB_FORMAT_RGB
Definition ObTypes.h:282
@ OB_FORMAT_UNKNOWN
Definition ObTypes.h:260
@ OB_FORMAT_Y10
Definition ObTypes.h:271
@ OB_FORMAT_H265
Definition ObTypes.h:268
@ OB_FORMAT_UYVY
Definition ObTypes.h:263
@ OB_FORMAT_Y14
Definition ObTypes.h:284
@ OB_FORMAT_I420
Definition ObTypes.h:276
@ OB_FORMAT_YUY2
Definition ObTypes.h:262
@ OB_FORMAT_BYR2
Definition ObTypes.h:292
@ OB_FORMAT_RLE
Definition ObTypes.h:281
@ OB_FORMAT_MJPG
Definition ObTypes.h:266
@ OB_FORMAT_LIDAR_POINT
Definition ObTypes.h:295
@ OB_FORMAT_COMPRESSED
Definition ObTypes.h:286
@ OB_FORMAT_GRAY
Definition ObTypes.h:274
@ OB_FORMAT_H264
Definition ObTypes.h:267
@ OB_FORMAT_POINT
Definition ObTypes.h:279
@ OB_FORMAT_RVL
Definition ObTypes.h:287
@ OB_FORMAT_RW16
Definition ObTypes.h:293
@ OB_FORMAT_LIDAR_SCAN
Definition ObTypes.h:297
@ OB_FORMAT_GYRO
Definition ObTypes.h:278
@ OB_FORMAT_Y8
Definition ObTypes.h:270
@ OB_FORMAT_NV12
Definition ObTypes.h:264
@ OB_FORMAT_HEVC
Definition ObTypes.h:275
@ OB_FORMAT_LIDAR_SPHERE_POINT
Definition ObTypes.h:296
struct OBRect ob_rect
OBCameraDistortionModel
Distortion model: defines how pixel coordinates should be mapped to sensor coordinates.
Definition ObTypes.h:441
@ OB_DISTORTION_INVERSE_BROWN_CONRADY
Definition ObTypes.h:445
@ OB_DISTORTION_BROWN_CONRADY
Definition ObTypes.h:446
@ OB_DISTORTION_KANNALA_BRANDT4
Definition ObTypes.h:448
@ OB_DISTORTION_BROWN_CONRADY_K6
Definition ObTypes.h:447
@ OB_DISTORTION_MODIFIED_BROWN_CONRADY
Definition ObTypes.h:443
@ OB_DISTORTION_NONE
Definition ObTypes.h:442
struct OBNoiseRemovalFilterParams ob_noise_removal_filter_params
enum OBGyroFullScaleRange ob_gyro_full_scale_range
struct OBDeviceSerialNumber ob_serial_number
enum OBColorPreset ob_color_preset
void(* ob_pipeline_status_callback)(ob_pipeline_status status, void *user_data)
Callback for pipeline status notification.
Definition ObTypes.h:2149
enum OBUpgradeState OBFwUpdateState
OBDataTranState
Enumeration value describing the data transfer status.
Definition ObTypes.h:361
@ DATA_TRAN_ERR_TRAN_FAILED
Definition ObTypes.h:369
@ DATA_TRAN_STAT_VERIFYING
Definition ObTypes.h:365
@ DATA_TRAN_STAT_TRANSFERRING
Definition ObTypes.h:366
@ DATA_TRAN_ERR_OTHER
Definition ObTypes.h:371
@ DATA_TRAN_ERR_VERIFY_FAILED
Definition ObTypes.h:370
@ DATA_TRAN_ERR_UNSUPPORTED
Definition ObTypes.h:368
@ DATA_TRAN_STAT_DONE
Definition ObTypes.h:364
@ DATA_TRAN_ERR_BUSY
Definition ObTypes.h:367
@ DATA_TRAN_STAT_VERIFY_DONE
Definition ObTypes.h:362
@ DATA_TRAN_STAT_STOPPED
Definition ObTypes.h:363
struct ob_stream_profile_list_t ob_stream_profile_list
Definition ObTypes.h:32
struct HDR_CONFIG OBHdrConfig
enum OBDepthCroppingMode OB_DEPTH_CROPPING_MODE
struct OBAccelIntrinsic ob_accel_intrinsic
OBTofFilterRange
Enumeration for TOF filter scene ranges.
Definition ObTypes.h:873
@ OB_TOF_FILTER_RANGE_LONG
Definition ObTypes.h:876
@ OB_TOF_FILTER_RANGE_CLOSE
Definition ObTypes.h:874
@ OB_TOF_FILTER_RANGE_MIDDLE
Definition ObTypes.h:875
@ OB_TOF_FILTER_RANGE_DEBUG
Definition ObTypes.h:877
enum ob_multi_device_sync_mode OBMultiDeviceSyncMode
enum ob_frame_metadata_type OBFrameMetadataType
OBFrameType
Enumeration value describing the type of frame.
Definition ObTypes.h:222
@ OB_FRAME_IR_RIGHT
Definition ObTypes.h:233
@ OB_FRAME_ACCEL
Definition ObTypes.h:228
@ OB_FRAME_COLOR_RIGHT
Definition ObTypes.h:238
@ OB_FRAME_GYRO
Definition ObTypes.h:231
@ OB_FRAME_IR_LEFT
Definition ObTypes.h:232
@ OB_FRAME_LIDAR_POINTS
Definition ObTypes.h:236
@ OB_FRAME_COLOR_LEFT
Definition ObTypes.h:237
@ OB_FRAME_TYPE_COUNT
Definition ObTypes.h:239
@ OB_FRAME_VIDEO
Definition ObTypes.h:224
@ OB_FRAME_COLOR
Definition ObTypes.h:226
@ OB_FRAME_UNKNOWN
Definition ObTypes.h:223
@ OB_FRAME_RAW_PHASE
Definition ObTypes.h:234
@ OB_FRAME_SET
Definition ObTypes.h:229
@ OB_FRAME_CONFIDENCE
Definition ObTypes.h:235
@ OB_FRAME_POINTS
Definition ObTypes.h:230
@ OB_FRAME_IR
Definition ObTypes.h:225
@ OB_FRAME_DEPTH
Definition ObTypes.h:227
OBStreamType
Enumeration value describing the type of data stream.
Definition ObTypes.h:200
@ OB_STREAM_CONFIDENCE
Definition ObTypes.h:211
@ OB_STREAM_RAW_PHASE
Definition ObTypes.h:210
@ OB_STREAM_GYRO
Definition ObTypes.h:207
@ OB_STREAM_UNKNOWN
Definition ObTypes.h:201
@ OB_STREAM_IR
Definition ObTypes.h:203
@ OB_STREAM_TYPE_COUNT
Definition ObTypes.h:215
@ OB_STREAM_DEPTH
Definition ObTypes.h:205
@ OB_STREAM_COLOR_RIGHT
Definition ObTypes.h:214
@ OB_STREAM_IR_RIGHT
Definition ObTypes.h:209
@ OB_STREAM_IR_LEFT
Definition ObTypes.h:208
@ OB_STREAM_VIDEO
Definition ObTypes.h:202
@ OB_STREAM_COLOR_LEFT
Definition ObTypes.h:213
@ OB_STREAM_ACCEL
Definition ObTypes.h:206
@ OB_STREAM_LIDAR
Definition ObTypes.h:212
@ OB_STREAM_COLOR
Definition ObTypes.h:204
ob_uvc_backend_type
For Linux, there are two ways to access the UVC device, libuvc and v4l2. The backend type is used to ...
Definition ObTypes.h:1958
@ OB_UVC_BACKEND_TYPE_MSMF
Use MSMF backend to access the UVC device.
Definition ObTypes.h:1980
@ OB_UVC_BACKEND_TYPE_V4L2
Use v4l2 backend to access the UVC device.
Definition ObTypes.h:1975
@ OB_UVC_BACKEND_TYPE_LIBUVC
Use libuvc backend to access the UVC device.
Definition ObTypes.h:1969
@ OB_UVC_BACKEND_TYPE_AUTO
Auto detect system capabilities and device hint to select backend.
Definition ObTypes.h:1963
enum OBCompressionMode ob_compression_mode
OBDeviceType
Enumeration for device types.
Definition ObTypes.h:794
@ OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA
Definition ObTypes.h:796
@ OB_DEVICE_TYPE_UNKNOWN
Definition ObTypes.h:795
@ OB_TOF_CAMERA
Definition ObTypes.h:798
@ OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA
Definition ObTypes.h:797
enum OBDeviceType ob_device_type
void(* ob_file_send_callback)(ob_file_tran_state state, const char *message, uint8_t percent, void *user_data)
Callback for file transfer.
Definition ObTypes.h:2041
enum OB_DEVICE_DEVELOPMENT_MODE ob_device_development_mode
struct BASELINE_CALIBRATION_PARAM OBBaselineCalibrationParam
struct OBCompressionParams OB_COMPRESSION_PARAMS
struct OBNetIpConfigV2 ob_net_ip_config_v2
enum OB_CMD_VERSION ob_cmd_version
struct OBDisparityParam ob_disparity_param
struct ob_playback_device_t ob_playback_device
Definition ObTypes.h:27
struct OBDeviceSerialNumber OBSerialNumber
enum OBAccelFullScaleRange OB_ACCEL_FULL_SCALE_RANGE
struct ob_device_t ob_device
Definition ObTypes.h:23
enum OBDepthPrecisionLevel OB_DEPTH_PRECISION_LEVEL
struct AE_ROI ob_region_of_interest
enum OBStatus ob_error_code
OBDepthCroppingMode
Enumeration for depth crop modes.
Definition ObTypes.h:784
@ DEPTH_CROPPING_MODE_AUTO
Definition ObTypes.h:785
@ DEPTH_CROPPING_MODE_OPEN
Definition ObTypes.h:787
@ DEPTH_CROPPING_MODE_CLOSE
Definition ObTypes.h:786
struct OBEdgeNoiseRemovalFilterParams ob_edge_noise_removal_filter_params
enum OBCameraPerformanceMode ob_camera_performance_mode
struct OBCameraDistortion ob_camera_distortion
enum OBHoleFillingMode ob_hole_filling_mode
enum OB_DDO_NOISE_REMOVAL_TYPE OBDDONoiseRemovalType
Denoising method.
enum OBIMUSampleRate OBGyroSampleRate
enum OBTofFilterRange TOF_FILTER_RANGE
struct OBNetIpConfig ob_net_ip_config
struct ob_config_t ob_config
Definition ObTypes.h:37
enum OBLogSeverity ob_log_severity
OBExceptionType
The exception types in the SDK, through the exception type, you can easily determine the specific typ...
Definition ObTypes.h:136
@ OB_EXCEPTION_TYPE_PLATFORM
Definition ObTypes.h:140
@ OB_EXCEPTION_TYPE_UNKNOWN
Definition ObTypes.h:137
@ OB_EXCEPTION_TYPE_NOT_IMPLEMENTED
Definition ObTypes.h:144
@ OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE
Definition ObTypes.h:143
@ OB_EXCEPTION_TYPE_INVALID_VALUE
Definition ObTypes.h:142
@ OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION
Definition ObTypes.h:147
@ OB_EXCEPTION_TYPE_IO
Definition ObTypes.h:145
@ OB_EXCEPTION_TYPE_RESOURCE_BUSY
Definition ObTypes.h:152
@ OB_EXCEPTION_TYPE_INVALID_DATA
Definition ObTypes.h:150
@ OB_EXCEPTION_TYPE_NOT_FOUND
Definition ObTypes.h:151
@ OB_EXCEPTION_TYPE_DEVICE_UNAVAILABLE
Definition ObTypes.h:149
@ OB_EXCEPTION_TYPE_ACCESS_DENIED
Definition ObTypes.h:148
@ OB_EXCEPTION_TYPE_MEMORY
Definition ObTypes.h:146
@ OB_EXCEPTION_STD_EXCEPTION
Definition ObTypes.h:138
@ OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED
Definition ObTypes.h:139
struct OBAccelValue ob_accel_value
struct OBCompressionParams ob_compression_params
enum OBAlignMode ob_align_mode
struct ob_filter_t ob_filter
Definition ObTypes.h:34
struct OBLiDARScanPoint ob_lidar_scan_point
OBAccelFullScaleRange
Enumeration of accelerometer ranges.
Definition ObTypes.h:689
@ OB_ACCEL_FS_4g
Definition ObTypes.h:692
@ OB_ACCEL_FS_16g
Definition ObTypes.h:694
@ OB_ACCEL_FS_2g
Definition ObTypes.h:691
@ OB_ACCEL_FS_8g
Definition ObTypes.h:693
@ OB_ACCEL_FS_12g
Definition ObTypes.h:697
@ OB_ACCEL_FS_UNKNOWN
Definition ObTypes.h:690
@ OB_ACCEL_FS_6g
Definition ObTypes.h:696
@ OB_ACCEL_FS_3g
Definition ObTypes.h:695
@ OB_ACCEL_FS_24g
Definition ObTypes.h:698
struct ob_margin_filter_config OBMarginFilterConfig
enum OB_COORDINATE_SYSTEM_TYPE ob_coordinate_system_type
enum OBLiDARScanRate OB_LIDAR_SCAN_RATE
struct OBCalibrationParam ob_calibration_param
void ob_log_callback(ob_log_severity severity, const char *message, void *user_data)
Callback for receiving log.
Definition ObTypes.h:2133
enum OBLogSeverity ob_device_log_severity_level
struct ob_depth_work_mode_list_t ob_depth_work_mode_list
Definition ObTypes.h:38
enum OBFileTranState ob_file_tran_state
OB_CMD_VERSION
Command version associated with property id.
Definition ObTypes.h:1257
@ OB_CMD_VERSION_NOVERSION
Definition ObTypes.h:1263
@ OB_CMD_VERSION_V0
Version 1.0.
Definition ObTypes.h:1258
@ OB_CMD_VERSION_V1
Version 2.0.
Definition ObTypes.h:1259
@ OB_CMD_VERSION_INVALID
Invalid version.
Definition ObTypes.h:1264
@ OB_CMD_VERSION_V3
Version 4.0.
Definition ObTypes.h:1261
@ OB_CMD_VERSION_V2
Version 3.0.
Definition ObTypes.h:1260
enum OBCommunicationType ob_communication_type
OBFileTranState
Enumeration value describing the file transfer status.
Definition ObTypes.h:345
@ FILE_TRAN_ERR_DDR
Definition ObTypes.h:349
@ FILE_TRAN_STAT_DONE
Definition ObTypes.h:347
@ FILE_TRAN_ERR_MD5_ERROR
Definition ObTypes.h:352
@ FILE_TRAN_ERR_NOT_ENOUGH_SPACE
Definition ObTypes.h:350
@ FILE_TRAN_ERR_WRITE_FLASH_ERROR
Definition ObTypes.h:353
@ FILE_TRAN_ERR_PATH_NOT_WRITABLE
Definition ObTypes.h:351
@ FILE_TRAN_ERR_TIMEOUT
Definition ObTypes.h:354
@ FILE_TRAN_STAT_PREPAR
Definition ObTypes.h:348
@ FILE_TRAN_STAT_TRANSFER
Definition ObTypes.h:346
OBCommunicationType
Device communication mode.
Definition ObTypes.h:1353
@ OB_COMM_NET
Ethernet.
Definition ObTypes.h:1355
@ OB_COMM_USB
USB.
Definition ObTypes.h:1354
enum OBUSBPowerState ob_usb_power_state
enum OBIMUSampleRate ob_accel_sample_rate
OBColorPreset
Color camera preset.
Definition ObTypes.h:1461
@ OB_WARM_BIASED_AWB
Warm Biased AWB for mixed lighting is designed for mixed illumination combining standard white light ...
Definition ObTypes.h:1473
@ OB_DEFAULT
Suitable for standard single-color-temperature lighting environments (e.g., typical indoor white LED ...
Definition ObTypes.h:1466
enum OBTofFilterRange ob_tof_filter_range
struct OBDeviceTemperature ob_device_temperature
struct OBDataChunk ob_data_chunk
enum ob_ip_source_type OBIpSourceType
struct OBUint8PropertyRange ob_uint8_property_range
enum OBConvertFormat ob_convert_format
enum OBStatus OBErrorCode
enum OBIMUSampleRate OBAccelSampleRate
enum OBStreamType ob_stream_type
enum OBDataTranState ob_data_tran_state
enum OBLiDARScanRate ob_lidar_scan_rate
OBSyncMode
Sync mode.
Definition ObTypes.h:978
@ OB_SYNC_MODE_STANDALONE
Standalone synchronize mode.
Definition ObTypes.h:991
@ OB_SYNC_MODE_CLOSE
Close synchronize mode.
Definition ObTypes.h:984
@ OB_SYNC_MODE_PRIMARY
Primary synchronize mode.
Definition ObTypes.h:998
@ OB_SYNC_MODE_PRIMARY_MCU_TRIGGER
MCU Primary synchronize mode.
Definition ObTypes.h:1015
@ OB_SYNC_MODE_SECONDARY
Secondary synchronize mode.
Definition ObTypes.h:1008
@ OB_SYNC_MODE_IR_IMU_SYNC
IR and IMU sync signal.
Definition ObTypes.h:1044
@ OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER
Software trigger synchronize mode.
Definition ObTypes.h:1031
@ OB_SYNC_MODE_PRIMARY_IR_TRIGGER
IR Primary synchronize mode.
Definition ObTypes.h:1022
@ OB_SYNC_MODE_UNKNOWN
Unknown type.
Definition ObTypes.h:1049
@ OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER
Software trigger synchronize mode as secondary device.
Definition ObTypes.h:1039
struct OBAccelValue ob_gyro_value
enum OB_DEVICE_DEVELOPMENT_MODE OBDeviceDevelopmentMode
enum OBUpgradeState ob_fw_update_state
struct OBPoint ob_point
struct ob_filter_config_schema_list_t ob_filter_config_schema_list
Definition ObTypes.h:40
ob_playback_status
The playback status of the media.
Definition ObTypes.h:1987
@ OB_PLAYBACK_UNKNOWN
Definition ObTypes.h:1988
@ OB_PLAYBACK_COUNT
Definition ObTypes.h:1992
@ OB_PLAYBACK_PLAYING
Definition ObTypes.h:1989
@ OB_PLAYBACK_STOPPED
Definition ObTypes.h:1991
@ OB_PLAYBACK_PAUSED
Definition ObTypes.h:1990
struct OBSpatialAdvancedFilterParams ob_spatial_advanced_filter_params
struct OBTofExposureThresholdControl ob_tof_exposure_threshold_control
struct OBDepthWorkMode ob_depth_work_mode
struct ob_device_timestamp_reset_config OBDeviceTimestampResetConfig
enum OB_COORDINATE_SYSTEM_TYPE OBCoordinateSystemType
enum OBCompressionMode OB_COMPRESSION_MODE
struct HDR_CONFIG ob_hdr_config
struct OBD2CTransform OBExtrinsic
enum OBMediaState OB_MEDIA_STATE_EM
struct OBLutNoiseRemovalFilterParams ob_lut_noise_removal_filter_params
struct OBFloatPropertyRange ob_float_property_range
enum OB_FRAME_AGGREGATE_OUTPUT_MODE OBFrameAggregateOutputMode
OBDepthWorkModeTag
Preset tag.
Definition ObTypes.h:1115
@ OB_DEVICE_DEPTH_WORK_MODE
Definition ObTypes.h:1116
@ OB_CUSTOM_DEPTH_WORK_MODE
Definition ObTypes.h:1117
struct OBPipelineStatus ob_pipeline_status
OB_FRAME_AGGREGATE_OUTPUT_MODE
Frame aggregate output mode.
Definition ObTypes.h:1403
@ OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE
Color Frame Require output mode.
Definition ObTypes.h:1415
@ OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION
FrameSet for any case will be output.
Definition ObTypes.h:1422
@ OB_FRAME_AGGREGATE_OUTPUT_DISABLE
Disable Frame Aggreate.
Definition ObTypes.h:1428
@ OB_FRAME_AGGREGATE_OUTPUT_ALL_TYPE_FRAME_REQUIRE
Only FrameSet that contains all types of data frames will be output.
Definition ObTypes.h:1407
struct OBFilterConfigSchemaItem ob_filter_config_schema_item
enum OBFilterConfigValueType ob_filter_config_value_type
OB_EDGE_NOISE_REMOVAL_TYPE
Definition ObTypes.h:1176
@ OB_MGA_FILTER
Definition ObTypes.h:1179
@ OB_MGC_FILTER
Definition ObTypes.h:1180
@ OB_MGH_FILTER
Definition ObTypes.h:1178
@ OB_MG_FILTER
Definition ObTypes.h:1177
struct OBBoolPropertyRange ob_bool_property_range
OB_DEVICE_DEVELOPMENT_MODE
Enumeration of device development modes.
Definition ObTypes.h:1445
@ OB_USER_MODE
User mode (default mode), which provides full camera device functionality.
Definition ObTypes.h:1449
@ OB_DEVELOPER_MODE
Developer mode, which allows developers to access the operating system and software/hardware resource...
Definition ObTypes.h:1454
struct OBDeviceSyncConfig ob_device_sync_config
enum ob_intra_camera_sync_reference OBIntraCameraSyncReference
struct ob_multi_device_sync_config OBMultiDeviceSyncConfig
enum OB_EDGE_NOISE_REMOVAL_TYPE ob_edge_noise_removal_type
OB_DDO_NOISE_REMOVAL_TYPE
Denoising method.
Definition ObTypes.h:1187
@ OB_NR_OVERALL
Definition ObTypes.h:1189
@ OB_NR_LUT
Definition ObTypes.h:1188
uint64_t ob_callback_id
Definition ObTypes.h:2154
enum OBDepthWorkModeTag ob_depth_work_mode_tag
enum ob_device_access_mode OBDeviceAccessMode
ob_multi_device_sync_mode
The synchronization mode of the device.
Definition ObTypes.h:1480
@ OB_MULTI_DEVICE_SYNC_MODE_IR_IMU_SYNC
IR and IMU sync mode.
Definition ObTypes.h:1563
@ OB_MULTI_DEVICE_SYNC_MODE_SECONDARY
secondary mode
Definition ObTypes.h:1516
@ OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING
software triggering mode
Definition ObTypes.h:1542
@ OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING
hardware triggering mode
Definition ObTypes.h:1558
@ OB_MULTI_DEVICE_SYNC_MODE_STANDALONE
standalone mode
Definition ObTypes.h:1494
@ OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED
secondary synced mode
Definition ObTypes.h:1529
@ OB_MULTI_DEVICE_SYNC_MODE_PRIMARY
primary mode
Definition ObTypes.h:1503
@ OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_SYNCED
The device captures data in software synchronization mode, starting acquisition based on the system t...
Definition ObTypes.h:1568
@ OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN
free run mode
Definition ObTypes.h:1487
OBPermissionType
the permission type of api or property
Definition ObTypes.h:64
@ OB_PERMISSION_DENY
Definition ObTypes.h:65
@ OB_PERMISSION_ANY
Definition ObTypes.h:69
@ OB_PERMISSION_READ
Definition ObTypes.h:66
@ OB_PERMISSION_READ_WRITE
Definition ObTypes.h:68
@ OB_PERMISSION_WRITE
Definition ObTypes.h:67
struct OBSpatialModerateFilterParams ob_spatial_moderate_filter_params
enum OBIMUSampleRate ob_gyro_sample_rate
struct AE_ROI OBRegionOfInterest
OBCompressionMode
Compression mode.
Definition ObTypes.h:950
@ OB_COMPRESSION_LOSSY
Definition ObTypes.h:952
@ OB_COMPRESSION_LOSSLESS
Definition ObTypes.h:951
OBDCPowerState
DC power status.
Definition ObTypes.h:1373
@ OB_DC_POWER_PLUGIN
Plugin.
Definition ObTypes.h:1375
@ OB_DC_POWER_NO_PLUGIN
No plugin.
Definition ObTypes.h:1374
enum OBGvcpPortScheme ob_gvcp_port_scheme
ob_intra_camera_sync_reference
Intra-camera Sync Reference based on the exposure start time, the exposure middle time,...
Definition ObTypes.h:1999
@ OB_MIDDLE_OF_EXPOSURE
Definition ObTypes.h:2001
@ OB_END_OF_EXPOSURE
Definition ObTypes.h:2002
@ OB_START_OF_EXPOSURE
Definition ObTypes.h:2000
enum OBAccelFullScaleRange ob_accel_full_scale_range
void ob_frame_destroy_callback(uint8_t *buffer, void *user_data)
Customize the delete callback.
Definition ObTypes.h:2124
struct OBNetIpConfig DEVICE_IP_ADDR_CONFIG
struct OBIntPropertyRange ob_int_property_range
struct OBGyroIntrinsic ob_gyro_intrinsic
enum ob_uvc_backend_type OBUvcBackendType
struct ob_device_frame_interleave_list_t ob_device_frame_interleave_list
Definition ObTypes.h:41
struct OBD2CTransform ob_transform
OBUpgradeState
Enumeration value describing the firmware upgrade status.
Definition ObTypes.h:317
@ ERR_TRANSFER
Definition ObTypes.h:338
@ ERR_DDR
Definition ObTypes.h:332
@ STAT_DONE
Definition ObTypes.h:322
@ ERR_IMAGE_SIZE
Definition ObTypes.h:330
@ STAT_IN_PROGRESS
Definition ObTypes.h:323
@ ERR_OTHER
Definition ObTypes.h:331
@ STAT_VERIFY_IMAGE
Definition ObTypes.h:325
@ ERR_FLASH_TYPE
Definition ObTypes.h:329
@ ERR_FILE_READ
Definition ObTypes.h:337
@ ERR_VERIFY
Definition ObTypes.h:326
@ ERR_ERASE
Definition ObTypes.h:328
@ STAT_VERIFY_SUCCESS
Definition ObTypes.h:320
@ ERR_MISMATCH
Definition ObTypes.h:334
@ ERR_UNSUPPORT_DEV
Definition ObTypes.h:335
@ STAT_DONE_REBOOT_AND_REUPDATE
Definition ObTypes.h:318
@ STAT_START
Definition ObTypes.h:324
@ ERR_INVALID_COUNT
Definition ObTypes.h:336
@ ERR_TIMEOUT
Definition ObTypes.h:333
@ STAT_FILE_TRANSFER
Definition ObTypes.h:321
@ STAT_DONE_WITH_DUPLICATES
Definition ObTypes.h:319
@ ERR_PROGRAM
Definition ObTypes.h:327
OBUSBPowerState
USB power status.
Definition ObTypes.h:1362
@ OB_USB_POWER_5V_1A5
5V/1.5A
Definition ObTypes.h:1365
@ OB_USB_POWER_5V_3A0
5V/3.0A
Definition ObTypes.h:1366
@ OB_USB_POWER_5V_0A9
5V/0.9A
Definition ObTypes.h:1364
@ OB_USB_POWER_NO_PLUGIN
No plugin.
Definition ObTypes.h:1363
enum OB_CMD_VERSION OBCmdVersion
struct OBD2CTransform OBTransform
enum OBSyncMode OB_SYNC_MODE
struct ob_device_list_t ob_device_list
Definition ObTypes.h:25
struct OBAccelValue OBFloat3D
OBPixelType
Enumeration value describing the pixel type of frame (usually used for depth frame)
Definition ObTypes.h:247
@ OB_PIXEL_DISPARITY
Definition ObTypes.h:250
@ OB_PIXEL_UNKNOWN
Definition ObTypes.h:248
@ OB_PIXEL_DEPTH
Definition ObTypes.h:249
@ OB_PIXEL_TOF_DEPTH
Definition ObTypes.h:252
@ OB_PIXEL_RAW_PHASE
Definition ObTypes.h:251
struct ob_device_preset_list_t ob_device_preset_list
Definition ObTypes.h:39
enum OBFrameType ob_frame_type
struct OBSpatialFastFilterParams ob_spatial_fast_filter_params
struct ob_preset_resolution_config_list_t ob_preset_resolution_config_list
Definition ObTypes.h:42
enum ob_playback_status OBPlaybackStatus
enum OBCameraDistortionModel ob_camera_distortion_model
enum OBDeviceType OB_DEVICE_TYPE
uint64_t OBCallbackId
Callback Id.
Definition ObTypes.h:2154
uint64_t ob_device_state
Definition ObTypes.h:729
ob_ip_source_type
Definition ObTypes.h:2025
@ OB_IP_SOURCE_PERSISTENT
Persistent IP (Static IP stored in memory).
Definition ObTypes.h:2029
@ OB_IP_SOURCE_NONE
No IP configuration active (e.g. USB device).
Definition ObTypes.h:2026
@ OB_IP_SOURCE_LLA
LLA (Link-Local Address / Auto IP).
Definition ObTypes.h:2027
@ OB_IP_SOURCE_DHCP
DHCP (Dynamic Host Configuration Protocol).
Definition ObTypes.h:2028
OBHoleFillingMode
Hole fillig mode.
Definition ObTypes.h:1152
@ OB_HOLE_FILL_FAREST
Definition ObTypes.h:1155
@ OB_HOLE_FILL_NEAREST
Definition ObTypes.h:1154
@ OB_HOLE_FILL_TOP
Definition ObTypes.h:1153
enum OBSensorType ob_sensor_type
enum OBDepthPrecisionLevel ob_depth_precision_level
void(* ob_frame_callback)(ob_frame *frame, void *user_data)
Callback for frame.
Definition ObTypes.h:2106
OBCameraPerformanceMode
Camera performance mode.
Definition ObTypes.h:583
@ HIGH_PERFORMANCE_MODE
Definition ObTypes.h:585
@ ADAPTIVE_PERFORMANCE_MODE
Definition ObTypes.h:584
void(* ob_set_data_callback)(ob_data_tran_state state, uint8_t percent, void *user_data)
Callback for writing data.
Definition ObTypes.h:2069
struct OBD2CTransform ob_extrinsic
struct OBLiDARSpherePoint ob_lidar_sphere_point
struct OBDispOffsetConfig ob_disp_offset_config
struct ob_sensor_list_t ob_sensor_list
Definition ObTypes.h:30
struct OBProtocolVersion ob_protocol_version
enum ob_rotate_degree_type OBRotateDegreeType
struct ob_pipeline_t ob_pipeline
Definition ObTypes.h:36
void(* ob_playback_status_changed_callback)(ob_playback_status status, void *user_data)
Callback for playback status notification.
Definition ObTypes.h:2141
void(* ob_media_state_callback)(ob_media_state state, void *user_data)
Callback for media status (recording and playback)
Definition ObTypes.h:2086
void(* ob_device_fw_update_callback)(ob_fw_update_state state, const char *message, uint8_t percent, void *user_data)
Callback for firmware upgrade.
Definition ObTypes.h:2051
enum OBGyroFullScaleRange OB_GYRO_FULL_SCALE_RANGE
enum OBMediaState ob_media_state
OBAlignMode
Alignment mode.
Definition ObTypes.h:573
@ ALIGN_D2C_HW_MODE
Definition ObTypes.h:575
@ ALIGN_DISABLE
Definition ObTypes.h:574
@ ALIGN_D2C_SW_MODE
Definition ObTypes.h:576
enum OBMediaType OB_MEDIA_TYPE
struct OBTofExposureThresholdControl TOF_EXPOSURE_THRESHOLD_CONTROL
struct OBPoint ob_point3f
ob_frame_metadata_type
Frame metadata types.
Definition ObTypes.h:1757
@ OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY
Power line frequency.
Definition ObTypes.h:1848
@ OB_FRAME_METADATA_TYPE_SATURATION
Saturation.
Definition ObTypes.h:1822
@ OB_FRAME_METADATA_TYPE_AE_ROI_TOP
Top region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1881
@ OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE
HDR sequence size.
Definition ObTypes.h:1906
@ OB_FRAME_METADATA_TYPE_FRAME_NUMBER
The number of current frame.
Definition ObTypes.h:1776
@ OB_FRAME_METADATA_TYPE_SHARPNESS
Sharpness.
Definition ObTypes.h:1827
@ OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE
Manual white balance setting.
Definition ObTypes.h:1860
@ OB_FRAME_METADATA_TYPE_AE_ROI_LEFT
Left region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1876
@ OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP
Timestamp in the middle of the capture.
Definition ObTypes.h:1771
@ OB_FRAME_METADATA_TYPE_COUNT
The number of frame metadata types, using for types iterating.
Definition ObTypes.h:1950
@ OB_FRAME_METADATA_TYPE_BRIGHTNESS
Brightness.
Definition ObTypes.h:1812
@ OB_FRAME_METADATA_TYPE_CONTRAST
Contrast.
Definition ObTypes.h:1817
@ OB_FRAME_METADATA_TYPE_HUE
Hue.
Definition ObTypes.h:1837
@ OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM
Bottom region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1891
@ OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX
HDR sequence index.
Definition ObTypes.h:1911
@ OB_FRAME_METADATA_TYPE_LASER_STATUS
Laser status.
Definition ObTypes.h:1929
@ OB_FRAME_METADATA_TYPE_WHITE_BALANCE
White balance.
Definition ObTypes.h:1807
@ OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT
Right region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1886
@ OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_RANGE
disparity search range
Definition ObTypes.h:1944
@ OB_FRAME_METADATA_TYPE_GAIN
Gain.
Definition ObTypes.h:1796
@ OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL
Laser power level.
Definition ObTypes.h:1923
@ OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA
GPIO input data.
Definition ObTypes.h:1934
@ OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME
HDR sequence name.
Definition ObTypes.h:1901
@ OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY
Exposure priority.
Definition ObTypes.h:1896
@ OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE
Auto white balance status.
Definition ObTypes.h:1802
@ OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION
Backlight compensation.
Definition ObTypes.h:1832
@ OB_FRAME_METADATA_TYPE_TIMESTAMP
Timestamp when the frame is captured.
Definition ObTypes.h:1763
@ OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE
Actual frame rate.
Definition ObTypes.h:1866
@ OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION
Low light compensation.
Definition ObTypes.h:1855
@ OB_FRAME_METADATA_TYPE_LASER_POWER
Laser power value in mW.
Definition ObTypes.h:1918
@ OB_FRAME_METADATA_TYPE_FRAME_RATE
Frame rate.
Definition ObTypes.h:1871
@ OB_FRAME_METADATA_TYPE_DISPARITY_SEARCH_OFFSET
disparity search offset value
Definition ObTypes.h:1939
@ OB_FRAME_METADATA_TYPE_EXPOSURE
Exposure time.
Definition ObTypes.h:1789
@ OB_FRAME_METADATA_TYPE_GAMMA
Gamma.
Definition ObTypes.h:1842
@ OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE
Auto exposure status.
Definition ObTypes.h:1782
OBDepthPrecisionLevel
Enumeration for depth precision levels.
Definition ObTypes.h:838
@ OB_PRECISION_0MM05
Definition ObTypes.h:845
@ OB_PRECISION_UNKNOWN
Definition ObTypes.h:846
@ OB_PRECISION_0MM8
Definition ObTypes.h:840
@ OB_PRECISION_0MM5
Definition ObTypes.h:844
@ OB_PRECISION_1MM
Definition ObTypes.h:839
@ OB_PRECISION_COUNT
Definition ObTypes.h:847
@ OB_PRECISION_0MM4
Definition ObTypes.h:841
@ OB_PRECISION_0MM2
Definition ObTypes.h:843
@ OB_PRECISION_0MM1
Definition ObTypes.h:842
ob_rotate_degree_type
Rotate degree.
Definition ObTypes.h:1382
@ OB_ROTATE_DEGREE_0
Rotate 0.
Definition ObTypes.h:1383
@ OB_ROTATE_DEGREE_90
Rotate 90.
Definition ObTypes.h:1384
@ OB_ROTATE_DEGREE_180
Rotate 180.
Definition ObTypes.h:1385
@ OB_ROTATE_DEGREE_270
Rotate 270.
Definition ObTypes.h:1386
enum OBStatus ob_status
struct ob_record_device_t ob_record_device
Definition ObTypes.h:26
OBConvertFormat
Enumeration of format conversion types.
Definition ObTypes.h:602
@ FORMAT_MJPG_TO_NV21
Definition ObTypes.h:609
@ FORMAT_NV12_TO_RGB
Definition ObTypes.h:606
@ FORMAT_BGRA_TO_BGR
Definition ObTypes.h:622
@ FORMAT_YUYV_TO_Y8
Definition ObTypes.h:620
@ FORMAT_YUYV_TO_RGBA
Definition ObTypes.h:617
@ FORMAT_UYVY_TO_RGB
Definition ObTypes.h:613
@ FORMAT_MJPG_TO_BGR
Definition ObTypes.h:611
@ FORMAT_NV21_TO_RGB
Definition ObTypes.h:605
@ FORMAT_Y16_TO_RGB
Definition ObTypes.h:623
@ FORMAT_RGB_TO_BGR
Definition ObTypes.h:608
@ FORMAT_BGR_TO_RGB
Definition ObTypes.h:614
@ FORMAT_MJPG_TO_BGRA
Definition ObTypes.h:612
@ FORMAT_MJPG_TO_I420
Definition ObTypes.h:607
@ FORMAT_YUYV_TO_RGB
Definition ObTypes.h:603
@ FORMAT_YUYV_TO_BGR
Definition ObTypes.h:616
@ FORMAT_MJPG_TO_NV12
Definition ObTypes.h:615
@ FORMAT_YUYV_TO_Y16
Definition ObTypes.h:619
@ FORMAT_I420_TO_RGB
Definition ObTypes.h:604
@ FORMAT_MJPG_TO_RGB
Definition ObTypes.h:610
@ FORMAT_YUYV_TO_BGRA
Definition ObTypes.h:618
@ FORMAT_Y8_TO_RGB
Definition ObTypes.h:624
@ FORMAT_RGBA_TO_RGB
Definition ObTypes.h:621
enum OBCommunicationType OB_COMMUNICATION_TYPE
enum OBLogSeverity DEVICE_LOG_SEVERITY_LEVEL
struct OBUint16PropertyRange ob_uint16_property_range
void(* ob_device_state_callback)(ob_device_state state, const char *message, void *user_data)
Callback for device status.
Definition ObTypes.h:2060
OBMediaType
Enumeration for types of media to record or playback.
Definition ObTypes.h:805
@ OB_MEDIA_STREAM_INFO
Definition ObTypes.h:813
@ OB_MEDIA_IR_LEFT_STREAM
Definition ObTypes.h:814
@ OB_MEDIA_ALL
Definition ObTypes.h:817
@ OB_MEDIA_IR_RIGHT_STREAM
Definition ObTypes.h:815
@ OB_MEDIA_DEPTH_STREAM
Definition ObTypes.h:807
@ OB_MEDIA_IR_STREAM
Definition ObTypes.h:808
@ OB_MEDIA_CAMERA_PARAM
Definition ObTypes.h:811
@ OB_MEDIA_GYRO_STREAM
Definition ObTypes.h:809
@ OB_MEDIA_DEVICE_INFO
Definition ObTypes.h:812
@ OB_MEDIA_ACCEL_STREAM
Definition ObTypes.h:810
@ OB_MEDIA_COLOR_STREAM
Definition ObTypes.h:806
enum OBDepthCroppingMode ob_depth_cropping_mode
enum OBPermissionType ob_permission_type
struct OBNetIpConfigV2 DEVICE_IP_ADDR_CONFIG_V2
OBLogSeverity
log level, the higher the level, the stronger the log filter
Definition ObTypes.h:121
@ OB_LOG_SEVERITY_DEBUG
Definition ObTypes.h:122
@ OB_LOG_SEVERITY_ERROR
Definition ObTypes.h:125
@ OB_LOG_SEVERITY_INFO
Definition ObTypes.h:123
@ OB_LOG_SEVERITY_OFF
Definition ObTypes.h:127
@ OB_LOG_SEVERITY_WARN
Definition ObTypes.h:124
@ OB_LOG_SEVERITY_FATAL
Definition ObTypes.h:126
OBPipelineIssue
Pipeline issue location flags observed during streaming.
Definition ObTypes.h:734
@ OB_PIPELINE_ISSUE_NONE
Definition ObTypes.h:735
@ OB_PIPELINE_ISSUE_FW
Definition ObTypes.h:738
@ OB_PIPELINE_ISSUE_SDK
Definition ObTypes.h:736
@ OB_PIPELINE_ISSUE_HW
Definition ObTypes.h:739
@ OB_PIPELINE_ISSUE_DRIVER
Definition ObTypes.h:737
enum OBPixelType ob_pixel_type
struct OBMgcNoiseRemovalFilterParams ob_mgc_noise_removal_filter_params
OBFilterConfigValueType
Definition ObTypes.h:1707
@ OB_FILTER_CONFIG_VALUE_TYPE_FLOAT
Definition ObTypes.h:1710
@ OB_FILTER_CONFIG_VALUE_TYPE_INT
Definition ObTypes.h:1709
@ OB_FILTER_CONFIG_VALUE_TYPE_BOOLEAN
Definition ObTypes.h:1711
@ OB_FILTER_CONFIG_VALUE_TYPE_INVALID
Definition ObTypes.h:1708
void(* ob_frameset_callback)(ob_frame *frameset, void *user_data)
Callback for frameset.
Definition ObTypes.h:2116
OB_COORDINATE_SYSTEM_TYPE
Enumeration of point cloud coordinate system types.
Definition ObTypes.h:1436
@ OB_RIGHT_HAND_COORDINATE_SYSTEM
Definition ObTypes.h:1438
@ OB_LEFT_HAND_COORDINATE_SYSTEM
Definition ObTypes.h:1437
struct OBMGCFilterConfig ob_mgc_filter_config
struct OBCameraIntrinsic ob_camera_intrinsic
The rect of the region of interest.
Definition ObTypes.h:1700
int16_t y0_top
Definition ObTypes.h:1702
int16_t x1_right
Definition ObTypes.h:1703
int16_t y1_bottom
Definition ObTypes.h:1704
int16_t x0_left
Definition ObTypes.h:1701
Baseline calibration parameters.
Definition ObTypes.h:1666
float zpd
Calibration distance.
Definition ObTypes.h:1674
float baseline
Baseline length.
Definition ObTypes.h:1670
HDR Configuration.
Definition ObTypes.h:1680
uint32_t gain_1
Gain 1.
Definition ObTypes.h:1692
uint32_t exposure_1
Exposure time 1.
Definition ObTypes.h:1691
uint32_t exposure_2
Exposure time 2.
Definition ObTypes.h:1693
uint8_t enable
Enable/disable HDR, after enabling HDR, the exposure_1 and gain_1 will be used as the first exposure ...
Definition ObTypes.h:1689
uint8_t sequence_name
Sequence name.
Definition ObTypes.h:1690
uint32_t gain_2
Gain 2.
Definition ObTypes.h:1694
Structure for accelerometer intrinsic parameters.
Definition ObTypes.h:467
double gravity[3]
gravity direction for x, y, z axis
Definition ObTypes.h:472
double bias[3]
bias for x, y, z axis
Definition ObTypes.h:471
double scaleMisalignment[9]
scale factor and three-axis non-orthogonal error
Definition ObTypes.h:473
double randomWalk
random walk
Definition ObTypes.h:469
double noiseDensity
In-run bias instability.
Definition ObTypes.h:468
double referenceTemp
reference temperature
Definition ObTypes.h:470
double tempSlope[9]
linear temperature drift coefficient
Definition ObTypes.h:474
Data structures for accelerometers and gyroscopes.
Definition ObTypes.h:705
float z
Z-direction component.
Definition ObTypes.h:708
float x
X-direction component.
Definition ObTypes.h:706
float y
Y-direction component.
Definition ObTypes.h:707
Structure for boolean range.
Definition ObTypes.h:432
bool def
Default value.
Definition ObTypes.h:437
bool min
Minimum value.
Definition ObTypes.h:435
bool cur
Current value.
Definition ObTypes.h:433
bool max
Maximum value.
Definition ObTypes.h:434
bool step
Step value.
Definition ObTypes.h:436
calibration parameters
Definition ObTypes.h:534
OBCameraDistortion distortion[OB_SENSOR_TYPE_COUNT]
Sensor distortion.
Definition ObTypes.h:536
OBExtrinsic extrinsics[OB_SENSOR_TYPE_COUNT][OB_SENSOR_TYPE_COUNT]
Definition ObTypes.h:538
OBCameraIntrinsic intrinsics[OB_SENSOR_TYPE_COUNT]
Sensor internal parameters.
Definition ObTypes.h:535
Structure for distortion parameters.
Definition ObTypes.h:492
float p1
Tangential distortion factor 1.
Definition ObTypes.h:499
float k6
Radial distortion factor 6.
Definition ObTypes.h:498
float k3
Radial distortion factor 3.
Definition ObTypes.h:495
float k1
Radial distortion factor 1.
Definition ObTypes.h:493
float k5
Radial distortion factor 5.
Definition ObTypes.h:497
OBCameraDistortionModel model
Definition ObTypes.h:501
float k4
Radial distortion factor 4.
Definition ObTypes.h:496
float p2
Tangential distortion factor 2.
Definition ObTypes.h:500
float k2
Radial distortion factor 2.
Definition ObTypes.h:494
Structure for camera intrinsic parameters.
Definition ObTypes.h:455
float fx
Focal length in x direction.
Definition ObTypes.h:456
float cx
Optical center abscissa.
Definition ObTypes.h:458
int16_t height
Image height.
Definition ObTypes.h:461
float cy
Optical center ordinate.
Definition ObTypes.h:459
int16_t width
Image width.
Definition ObTypes.h:460
float fy
Focal length in y direction.
Definition ObTypes.h:457
Structure for camera parameters.
Definition ObTypes.h:515
OBCameraDistortion rgbDistortion
Color camera distortion parameters.
Definition ObTypes.h:519
bool isMirrored
Whether the image frame corresponding to this group of parameters is mirrored.
Definition ObTypes.h:521
OBCameraIntrinsic rgbIntrinsic
Color camera internal parameters.
Definition ObTypes.h:517
OBCameraIntrinsic depthIntrinsic
Depth camera internal parameters.
Definition ObTypes.h:516
OBCameraDistortion depthDistortion
Depth camera distortion parameters.
Definition ObTypes.h:518
OBD2CTransform transform
Rotation/transformation matrix.
Definition ObTypes.h:520
3D point structure with color information
Definition ObTypes.h:907
float z
Z coordinate.
Definition ObTypes.h:910
float g
Green channel component.
Definition ObTypes.h:912
float b
Blue channel component.
Definition ObTypes.h:913
float x
X coordinate.
Definition ObTypes.h:908
float y
Y coordinate.
Definition ObTypes.h:909
float r
Red channel component.
Definition ObTypes.h:911
Structure for rotation/transformation.
Definition ObTypes.h:507
float trans[3]
Transformation matrix in millimeters.
Definition ObTypes.h:509
float rot[9]
Rotation matrix.
Definition ObTypes.h:508
Structure for transmitting data blocks.
Definition ObTypes.h:378
uint8_t * data
Pointer to current block data.
Definition ObTypes.h:379
uint32_t offset
Offset of current data block relative to complete data.
Definition ObTypes.h:381
uint32_t fullDataSize
Size of full data.
Definition ObTypes.h:382
uint32_t size
Length of current block data.
Definition ObTypes.h:380
Depth work mode.
Definition ObTypes.h:1124
OBDepthWorkModeTag tag
Preset tag.
Definition ObTypes.h:1137
uint8_t checksum[16]
Checksum of work mode.
Definition ObTypes.h:1128
char name[32]
Name of work mode.
Definition ObTypes.h:1133
struct of serial number
Definition ObTypes.h:1730
Device synchronization configuration.
Definition ObTypes.h:1058
uint16_t rgbTriggerSignalInDelay
RGB trigger signal input delay is used to configure the delay from the time when an RGB Sensor receiv...
Definition ObTypes.h:1078
OBSyncMode syncMode
Device synchronize mode.
Definition ObTypes.h:1062
uint16_t deviceTriggerSignalOutPolarity
The device trigger signal output polarity is used to control the polarity configuration of the trigge...
Definition ObTypes.h:1095
uint16_t deviceId
Device number. Users can mark the device with this number.
Definition ObTypes.h:1108
uint16_t irTriggerSignalInDelay
IR Trigger signal input delay: Used to configure the delay between the IR/Depth/TOF Sensor receiving ...
Definition ObTypes.h:1070
uint16_t deviceTriggerSignalOutDelay
Device trigger signal output delay, used to control the delay configuration of the host device to out...
Definition ObTypes.h:1086
uint16_t mcuTriggerFrequency
MCU trigger frequency, used to configure the output frequency of MCU trigger signal in MCU master mod...
Definition ObTypes.h:1103
Temperature parameters of the device (unit: Celsius)
Definition ObTypes.h:767
float tecTemp
TEC temperature.
Definition ObTypes.h:772
float irRightTemp
Right IR temperature.
Definition ObTypes.h:776
float imuTemp
IMU temperature.
Definition ObTypes.h:773
float mainBoardTemp
Motherboard temperature.
Definition ObTypes.h:771
float irTemp
IR temperature.
Definition ObTypes.h:769
float chipBottomTemp
MX6600 bottom temperature.
Definition ObTypes.h:778
float irLeftTemp
Left IR temperature.
Definition ObTypes.h:775
float ldmTemp
Laser temperature.
Definition ObTypes.h:770
float rgbTemp
RGB temperature.
Definition ObTypes.h:774
float chipTopTemp
MX6600 top temperature.
Definition ObTypes.h:777
float cpuTemp
CPU temperature.
Definition ObTypes.h:768
Disparity offset interleaving configuration.
Definition ObTypes.h:1737
disparity parameters for disparity based camera
Definition ObTypes.h:855
float minDisparity
Definition ObTypes.h:862
uint8_t bitSize
Definition ObTypes.h:860
int32_t invalidDisp
Definition ObTypes.h:865
uint8_t packMode
Definition ObTypes.h:863
uint8_t isDualCamera
Definition ObTypes.h:867
int32_t dispIntPlace
Definition ObTypes.h:866
int limit_y_th
Maximum vertical threshold.
Definition ObTypes.h:1203
int margin_x_th
Horizontal threshold settings.
Definition ObTypes.h:1200
uint32_t height
Image height.
Definition ObTypes.h:1205
uint32_t width
Image width.
Definition ObTypes.h:1204
bool enable_direction
Set to true for horizontal and vertical, false for horizontal only.
Definition ObTypes.h:1206
int limit_x_th
Maximum horizontal threshold.
Definition ObTypes.h:1202
int margin_y_th
Vertical threshold settings.
Definition ObTypes.h:1201
Configuration Item for the filter.
Definition ObTypes.h:1717
double min
Minimum value casted to double.
Definition ObTypes.h:1720
OBFilterConfigValueType type
Value type of the configuration item.
Definition ObTypes.h:1719
double max
Maximum value casted to double.
Definition ObTypes.h:1721
const char * name
Name of the configuration item.
Definition ObTypes.h:1718
double def
Default value casted to double.
Definition ObTypes.h:1723
double step
Step value casted to double.
Definition ObTypes.h:1722
const char * desc
Description of the configuration item.
Definition ObTypes.h:1724
Structure for float range.
Definition ObTypes.h:399
float cur
Current value.
Definition ObTypes.h:400
float min
Minimum value.
Definition ObTypes.h:402
float max
Maximum value.
Definition ObTypes.h:401
float def
Default value.
Definition ObTypes.h:404
float step
Step value.
Definition ObTypes.h:403
Structure for gyroscope intrinsic parameters.
Definition ObTypes.h:480
double randomWalk
random walk
Definition ObTypes.h:482
double scaleMisalignment[9]
scale factor and three-axis non-orthogonal error
Definition ObTypes.h:485
double bias[3]
bias for x, y, z axis
Definition ObTypes.h:484
double noiseDensity
In-run bias instability.
Definition ObTypes.h:481
double tempSlope[9]
linear temperature drift coefficient
Definition ObTypes.h:486
double referenceTemp
reference temperature
Definition ObTypes.h:483
uint32_t factor
Decimation factor.
Definition ObTypes.h:1750
uint32_t originHeight
Origin height.
Definition ObTypes.h:1749
uint32_t originWidth
Origin width.
Definition ObTypes.h:1748
Structure for integer range.
Definition ObTypes.h:388
int32_t step
Step value.
Definition ObTypes.h:392
int32_t def
Default value.
Definition ObTypes.h:393
int32_t max
Maximum value.
Definition ObTypes.h:390
int32_t min
Minimum value.
Definition ObTypes.h:391
int32_t cur
Current value.
Definition ObTypes.h:389
3D point structure with LiDAR information
Definition ObTypes.h:928
float z
Z coordinate, unit mm.
Definition ObTypes.h:931
uint8_t tag
point state
Definition ObTypes.h:933
float y
Y coordinate, unit mm.
Definition ObTypes.h:930
float x
X coordinate, unit mm.
Definition ObTypes.h:929
uint8_t reflectivity
reflectivity
Definition ObTypes.h:932
3D point structure with LiDAR information
Definition ObTypes.h:919
float angle
angle, unit: degrees
Definition ObTypes.h:920
uint16_t intensity
intensity, 0~2000
Definition ObTypes.h:922
float distance
distance, unit: mm
Definition ObTypes.h:921
3D point structure with LiDAR information
Definition ObTypes.h:939
uint8_t tag
tag
Definition ObTypes.h:944
float distance
distance, unit: mm
Definition ObTypes.h:940
float phi
zenith angle, unit: degrees
Definition ObTypes.h:942
float theta
azimuth angle, unit: degrees
Definition ObTypes.h:941
uint8_t reflectivity
reflectivity
Definition ObTypes.h:943
Configuration parameters for the LUT noise removal filter.
Definition ObTypes.h:1227
uint32_t width
Depth map width the above parameters correspond to.
Definition ObTypes.h:1230
uint32_t height
Depth map height the above parameters correspond to.
Definition ObTypes.h:1231
uint16_t max_lut[16]
LUT max size of noise pixels (4x4 LUT, 16 entries total)
Definition ObTypes.h:1228
uint16_t min_diff
Difference threshold between neighbor pixels.
Definition ObTypes.h:1229
Configuration for mgc filter.
Definition ObTypes.h:558
uint32_t width
Definition ObTypes.h:559
uint32_t height
Definition ObTypes.h:560
Configuration parameters for the MGC noise removal filter.
Definition ObTypes.h:1212
int limit_y_th
Maximum vertical threshold.
Definition ObTypes.h:1219
int limit_x_th
Maximum horizontal threshold.
Definition ObTypes.h:1218
int max_radius
Chamfer radius threshold settings.
Definition ObTypes.h:1215
int max_width_right
Right chamfer threshold settings.
Definition ObTypes.h:1214
int margin_y_th
Vertical threshold settings.
Definition ObTypes.h:1217
uint32_t height
Depth map height the above parameters correspond to.
Definition ObTypes.h:1221
uint32_t width
Depth map width the above parameters correspond to.
Definition ObTypes.h:1220
int max_width_left
Left chamfer threshold settings.
Definition ObTypes.h:1213
int margin_x_th
Horizontal threshold settings.
Definition ObTypes.h:1216
IP address configuration for network devices (IPv4), used with property OB_STRUCT_DEVICE_IP_ADDR_CONF...
Definition ObTypes.h:1291
uint8_t gateway[4]
Gateway (big endian)
Definition ObTypes.h:1312
uint16_t dhcp
DHCP status.
Definition ObTypes.h:1297
uint8_t mask[4]
Subnet mask (big endian)
Definition ObTypes.h:1307
uint8_t address[4]
IP address (IPv4, big endian: 192.168.1.10, address[0] = 192, address[1] = 168, address[2] = 1,...
Definition ObTypes.h:1302
IP address configuration v2 for network devices (IPv4), used with property OB_STRUCT_DEVICE_IP_ADDR_C...
Definition ObTypes.h:1340
uint8_t address[4]
IP address (IPv4, big-endian, e.g. 192.168.1.1 -> address[0]=192)
Definition ObTypes.h:1345
uint8_t mask[4]
Subnet mask (big-endian)
Definition ObTypes.h:1346
uint16_t flags
Definition ObTypes.h:1341
uint8_t gateway[4]
Gateway (big-endian)
Definition ObTypes.h:1347
OBDDONoiseRemovalType type
Definition ObTypes.h:1196
Pipeline status observed during streaming.
Definition ObTypes.h:756
uint64_t reserved[3]
Definition ObTypes.h:761
uint64_t sdkStatus
Definition ObTypes.h:758
uint64_t drvStatus
Definition ObTypes.h:760
uint64_t devStatus
Definition ObTypes.h:759
OBPipelineIssue issue
Definition ObTypes.h:757
2D point structure in the SDK
Definition ObTypes.h:892
float x
X coordinate.
Definition ObTypes.h:893
float y
Y coordinate.
Definition ObTypes.h:894
3D point structure in the SDK
Definition ObTypes.h:883
float y
Y coordinate.
Definition ObTypes.h:885
float z
Z coordinate.
Definition ObTypes.h:886
float x
X coordinate.
Definition ObTypes.h:884
int depthDecimationFactor
depth decimation factor
Definition ObTypes.h:528
int irDecimationFactor
ir decimation factor
Definition ObTypes.h:527
int16_t height
height
Definition ObTypes.h:526
Control command protocol version number.
Definition ObTypes.h:1237
uint8_t major
Major version number.
Definition ObTypes.h:1241
uint8_t minor
Minor version number.
Definition ObTypes.h:1246
uint8_t patch
Patch version number.
Definition ObTypes.h:1251
Rectangle.
Definition ObTypes.h:592
uint32_t height
Rectangle height.
Definition ObTypes.h:596
uint32_t y
Origin coordinate y.
Definition ObTypes.h:594
uint32_t x
Origin coordinate x.
Definition ObTypes.h:593
uint32_t width
Rectangle width.
Definition ObTypes.h:595
SequenceId fliter list item.
Definition ObTypes.h:1144
TOF Exposure Threshold.
Definition ObTypes.h:969
int32_t lower
Lower threshold, unit: ms.
Definition ObTypes.h:971
int32_t upper
Upper threshold, unit: ms.
Definition ObTypes.h:970
Structure for float range.
Definition ObTypes.h:410
uint16_t min
Minimum value.
Definition ObTypes.h:413
uint16_t cur
Current value.
Definition ObTypes.h:411
uint16_t step
Step value.
Definition ObTypes.h:414
uint16_t max
Maximum value.
Definition ObTypes.h:412
uint16_t def
Default value.
Definition ObTypes.h:415
Structure for float range.
Definition ObTypes.h:421
uint8_t min
Minimum value.
Definition ObTypes.h:424
uint8_t def
Default value.
Definition ObTypes.h:426
uint8_t cur
Current value.
Definition ObTypes.h:422
uint8_t step
Step value.
Definition ObTypes.h:425
uint8_t max
Maximum value.
Definition ObTypes.h:423
int width
width of x and y tables
Definition ObTypes.h:900
float * xTable
table used to compute X coordinate
Definition ObTypes.h:898
int height
height of x and y tables
Definition ObTypes.h:901
float * yTable
table used to compute Y coordinate
Definition ObTypes.h:899
The timestamp reset configuration of the device.
Definition ObTypes.h:1639
int timestamp_reset_delay_us
The delay time of executing the timestamp reset function after receiving the command or signal in mic...
Definition ObTypes.h:1653
bool enable
Whether to enable the timestamp reset function.
Definition ObTypes.h:1648
bool timestamp_reset_signal_output_enable
the timestamp reset signal output enable flag.
Definition ObTypes.h:1660
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition ObTypes.h:159
char function[256]
Describe the name of the function where the error occurred.
Definition ObTypes.h:162
char args[256]
Describes the parameters passed to the function when an error occurs. Used to check whether the param...
Definition ObTypes.h:163
char message[256]
Describe the detailed error log.
Definition ObTypes.h:161
ob_exception_type exception_type
The description is the specific error type of the SDK.
Definition ObTypes.h:164
ob_status status
Describe the status code of the error, as compatible with previous customer status code requirements.
Definition ObTypes.h:160
Configuration for depth margin filter.
Definition ObTypes.h:545
bool enable_direction
Set to true for horizontal and vertical, false for horizontal only.
Definition ObTypes.h:552
int limit_y_th
Maximum vertical threshold.
Definition ObTypes.h:549
int limit_x_th
Maximum horizontal threshold.
Definition ObTypes.h:548
uint32_t height
Image height.
Definition ObTypes.h:551
int margin_y_th
Vertical threshold settings.
Definition ObTypes.h:547
uint32_t width
Image width.
Definition ObTypes.h:550
int margin_x_th
Horizontal threshold settings.
Definition ObTypes.h:546
The synchronization configuration of the device.
Definition ObTypes.h:1575
int depthDelayUs
The delay time of the depth image capture after receiving the capture command or trigger signal in mi...
Definition ObTypes.h:1586
int framesPerTrigger
The frame number of each stream after each trigger in triggering mode.
Definition ObTypes.h:1632
int trigger2ImageDelayUs
The delay time of the image capture after receiving the capture command or trigger signal in microsec...
Definition ObTypes.h:1603
OBMultiDeviceSyncMode syncMode
The sync mode of the device.
Definition ObTypes.h:1579
int triggerOutDelayUs
The delay time of the trigger signal output after receiving the capture command or trigger signal in ...
Definition ObTypes.h:1622
int colorDelayUs
The delay time of the color image capture after receiving the capture command or trigger signal in mi...
Definition ObTypes.h:1593
bool triggerOutEnable
Trigger signal output enable flag.
Definition ObTypes.h:1614