From 58d12c5095cbcaeded1b678b87e5fae2c623c768 Mon Sep 17 00:00:00 2001 From: zhonghong Date: Sat, 11 May 2024 21:44:10 +0800 Subject: [PATCH] update Orbbec API Doc --- doc/api/English/Context_8hpp_source.html | 163 ++ doc/api/English/Device_8hpp_source.html | 447 ++++ doc/api/English/Error_8hpp_source.html | 124 ++ doc/api/English/ObSensor_8hpp_source.html | 114 ++ doc/api/English/ObTypes_8h_source.html | 1795 +++++++++++++++++ .../English/RecordPlayback_8hpp_source.html | 165 ++ .../English/StreamProfile_8hpp_source.html | 275 +++ doc/api/English/Types_8hpp_source.html | 122 ++ doc/api/English/Utils_8hpp_source.html | 141 ++ 9 files changed, 3346 insertions(+) create mode 100644 doc/api/English/Context_8hpp_source.html create mode 100644 doc/api/English/Device_8hpp_source.html create mode 100644 doc/api/English/Error_8hpp_source.html create mode 100644 doc/api/English/ObSensor_8hpp_source.html create mode 100644 doc/api/English/ObTypes_8h_source.html create mode 100644 doc/api/English/RecordPlayback_8hpp_source.html create mode 100644 doc/api/English/StreamProfile_8hpp_source.html create mode 100644 doc/api/English/Types_8hpp_source.html create mode 100644 doc/api/English/Utils_8hpp_source.html diff --git a/doc/api/English/Context_8hpp_source.html b/doc/api/English/Context_8hpp_source.html new file mode 100644 index 00000000..268c0f7a --- /dev/null +++ b/doc/api/English/Context_8hpp_source.html @@ -0,0 +1,163 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Context.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Context.hpp
+
+
+Go to the documentation of this file.
1
+
7#pragma once
+
8
+
9#include "Types.hpp"
+
10
+
11#include <functional>
+
12#include <memory>
+
13
+
14struct ContextImpl;
+
15
+
16namespace ob {
+
17class Device;
+
18class DeviceInfo;
+
19class DeviceList;
+
20
+
21class OB_EXTENSION_API Context {
+
22private:
+
23 std::unique_ptr<ContextImpl> impl_;
+
24
+
25public:
+
31 Context(const char *configPath = "");
+
32 virtual ~Context() noexcept;
+
33
+
39 std::shared_ptr<DeviceList> queryDeviceList();
+
40
+
50 void enableNetDeviceEnumeration(bool enable);
+
51
+
59 std::shared_ptr<Device> createNetDevice(const char *address, uint16_t port);
+
60
+
67 void changeNetDeviceIpConfig(const char *deviceUid, const OBNetIpConfig &config);
+
68
+
69 using DeviceChangedCallback = std::function<void(std::shared_ptr<DeviceList> removedList, std::shared_ptr<DeviceList> addedList)>;
+
70
+
76 void setDeviceChangedCallback(DeviceChangedCallback callback);
+
77
+
83 void enableDeviceClockSync(uint64_t repeatInterval);
+
84#define enableMultiDeviceSync enableDeviceClockSync
+
85
+
89 void freeIdleMemory();
+
90
+
96 static void setLoggerSeverity(OBLogSeverity severity);
+
97
+
105 static void setLoggerToFile(OBLogSeverity severity, const char *directory);
+
106
+
112 static void setLoggerToConsole(OBLogSeverity severity);
+
113
+
120 using LogCallback = std::function<void(OBLogSeverity severity, const char *logMsg)>;
+
121
+
128 static void setLoggerToCallback(OBLogSeverity severity, LogCallback callback);
+
129
+
136 static void loadLicense(const char *filePath, const char *key = OB_DEFAULT_DECRYPT_KEY);
+
137
+
145 static void loadLicenseFromData(const char *data, uint32_t dataLen, const char *key = OB_DEFAULT_DECRYPT_KEY);
+
146};
+
147} // namespace ob
+
OB_DEFAULT_DECRYPT_KEY
#define OB_DEFAULT_DECRYPT_KEY
The default Decrypt Key.
Definition ObTypes.h:1763
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition ObTypes.h:28
+
OBLogSeverity
OBLogSeverity
log level, the higher the level, the stronger the log filter
Definition ObTypes.h:115
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+ +
ob::Context::setLoggerSeverity
static void setLoggerSeverity(OBLogSeverity severity)
Set the level of the global log, which affects both the log level output to the terminal and output t...
+
ob::Context::setLoggerToConsole
static void setLoggerToConsole(OBLogSeverity severity)
Set log output to the terminal.
+
ob::Context::~Context
virtual ~Context() noexcept
+
ob::Context::loadLicense
static void loadLicense(const char *filePath, const char *key=OB_DEFAULT_DECRYPT_KEY)
Loads a license file.
+
ob::Context::setLoggerToCallback
static void setLoggerToCallback(OBLogSeverity severity, LogCallback callback)
Set the logger to callback.
+
ob::Context::DeviceChangedCallback
std::function< void(std::shared_ptr< DeviceList > removedList, std::shared_ptr< DeviceList > addedList)> DeviceChangedCallback
Definition Context.hpp:69
+
ob::Context::LogCallback
std::function< void(OBLogSeverity severity, const char *logMsg)> LogCallback
Log output callback function.
Definition Context.hpp:120
+
ob::Context::freeIdleMemory
void freeIdleMemory()
Frees idle memory from the internal frame memory pool.
+
ob::Context::Context
Context(const char *configPath="")
The Context class is a management class that describes the runtime of the SDK. It is responsible for ...
+
ob::Context::loadLicenseFromData
static void loadLicenseFromData(const char *data, uint32_t dataLen, const char *key=OB_DEFAULT_DECRYPT_KEY)
Loads a license from data.
+
ob::Context::setLoggerToFile
static void setLoggerToFile(OBLogSeverity severity, const char *directory)
Set log output to a file.
+
ob::DeviceInfo
A class describing device information, representing the name, id, serial number and other basic infor...
Definition Device.hpp:633
+
ob::DeviceList
Class representing a list of devices.
Definition Device.hpp:750
+ +
ob
Definition Context.hpp:16
+
OBNetIpConfig
IP address configuration for network devices (IPv4)
Definition ObTypes.h:1087
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/Device_8hpp_source.html b/doc/api/English/Device_8hpp_source.html new file mode 100644 index 00000000..6974952d --- /dev/null +++ b/doc/api/English/Device_8hpp_source.html @@ -0,0 +1,447 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Device.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Device.hpp
+
+
+Go to the documentation of this file.
1
+
6#pragma once
+
7#include "Types.hpp"
+
8
+
9#include "libobsensor/h/Property.h"
+
10#include "libobsensor/hpp/Filter.hpp"
+
11#include <memory>
+
12#include <string>
+
13#include <vector>
+
14
+
15struct DeviceImpl;
+
16struct DeviceInfoImpl;
+
17struct DeviceListImpl;
+
18struct CameraParamListImpl;
+
19
+
20namespace ob {
+
21class SensorList;
+
22class Context;
+
23class DeviceInfo;
+
24class Sensor;
+
25class CameraParamList;
+
26class OBDepthWorkModeList;
+
27class DevicePresetList;
+
28
+
29class OB_EXTENSION_API Device {
+
30protected:
+
31 std::unique_ptr<DeviceImpl> impl_;
+
32
+
33 Device(Device &&device);
+
34
+
35public:
+
39 Device(std::unique_ptr<DeviceImpl> impl);
+
40 virtual ~Device() noexcept;
+
41
+
47 std::shared_ptr<DeviceInfo> getDeviceInfo();
+
48
+
54 std::shared_ptr<SensorList> getSensorList();
+
55
+
62 std::shared_ptr<Sensor> getSensor(OBSensorType type);
+
63
+
70 void setIntProperty(OBPropertyID propertyId, int32_t property);
+
71
+
78 void setFloatProperty(OBPropertyID propertyId, float property);
+
79
+
86 void setBoolProperty(OBPropertyID propertyId, bool property);
+
87
+
94 int32_t getIntProperty(OBPropertyID propertyId);
+
95
+
102 float getFloatProperty(OBPropertyID propertyId);
+
103
+
110 bool getBoolProperty(OBPropertyID propertyId);
+
111
+
118 OBIntPropertyRange getIntPropertyRange(OBPropertyID propertyId);
+
119
+
126 OBFloatPropertyRange getFloatPropertyRange(OBPropertyID propertyId);
+
127
+
134 OBBoolPropertyRange getBoolPropertyRange(OBPropertyID propertyId);
+
135
+
143 void writeAHB(uint32_t reg, uint32_t mask, uint32_t value);
+
144
+
152 void readAHB(uint32_t reg, uint32_t mask, uint32_t *value);
+
153
+
162 void writeI2C(uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t value);
+
163
+
172 void readI2C(uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t *value);
+
173
+
183 void writeFlash(uint32_t offset, const void *data, uint32_t dataSize, SetDataCallback callback, bool async = false);
+
184
+
193 void readFlash(uint32_t offset, uint32_t dataSize, GetDataCallback callback, bool async = false);
+
194
+
201 void writeCustomerData(const void *data, uint32_t dataSize);
+
202
+
209 void readCustomerData(void *data, uint32_t *dataSize);
+
210
+
220 void setRawData(OBPropertyID propertyId, const void *data, uint32_t dataSize, SetDataCallback callback, bool async = false);
+
221
+
229 void getRawData(OBPropertyID propertyId, GetDataCallback callback, bool async = false);
+
230
+
238 void setStructuredData(OBPropertyID propertyId, const void *data, uint32_t dataSize);
+
239
+
247 void getStructuredData(OBPropertyID propertyId, void *data, uint32_t *dataSize);
+
248
+
256 void setStructuredDataExt(OBPropertyID propertyId, std::shared_ptr<OBDataBundle> dataBundle, SetDataCallback callback);
+
257
+
264 std::shared_ptr<OBDataBundle> getStructuredDataExt(OBPropertyID propertyId);
+
265
+
271 OBProtocolVersion getProtocolVersion();
+
272
+
279 OBCmdVersion getCmdVersion(OBPropertyID propertyId);
+
280
+
286 uint32_t getSupportedPropertyCount();
+
287
+
294 OBPropertyItem getSupportedProperty(uint32_t index);
+
295
+
303 bool isPropertySupported(OBPropertyID propertyId, OBPermissionType permission);
+
304
+
310 bool isGlobalTimestampSupported();
+
311
+
319 void deviceUpgrade(const char *filePath, DeviceUpgradeCallback callback, bool async = true);
+
320
+
330 void deviceUpgradeFromData(const char *fileData, uint32_t fileSize, DeviceUpgradeCallback callback, bool async = true);
+
331
+
340 void sendFile(const char *filePath, const char *dstPath, SendFileCallback callback, bool async = true);
+
341
+
346 OBDeviceState getDeviceState();
+
347
+
354 void setDeviceStateChangedCallback(DeviceStateChangedCallback callback);
+
355
+
362 bool activateAuthorization(const char *authCode);
+
363
+
368 void writeAuthorizationCode(const char *authCodeStr);
+
369
+
379 std::shared_ptr<CameraParamList> getCalibrationCameraParamList();
+
380
+
386 OBDepthWorkMode getCurrentDepthWorkMode();
+
387
+
393 OBStatus switchDepthWorkMode(const OBDepthWorkMode &workMode);
+
394
+
400 OBStatus switchDepthWorkMode(const char *modeName);
+
401
+
406 std::shared_ptr<OBDepthWorkModeList> getDepthWorkModeList();
+
407
+
413 void reboot();
+
414
+
423 void reboot(uint32_t delayMs);
+
424
+
430 DEPRECATED uint64_t syncDeviceTime();
+
431
+
441 DEPRECATED OBDeviceSyncConfig getSyncConfig();
+
442
+
454 DEPRECATED void setSyncConfig(const OBDeviceSyncConfig &deviceSyncConfig);
+
455
+
471 uint16_t getSupportedMultiDeviceSyncModeBitmap();
+
472
+
478 void setMultiDeviceSyncConfig(const OBMultiDeviceSyncConfig &config);
+
479
+
485 OBMultiDeviceSyncConfig getMultiDeviceSyncConfig();
+
486
+
498 void triggerCapture();
+
499
+
503 void setTimestampResetConfig(const OBDeviceTimestampResetConfig &config);
+
504
+
510 OBDeviceTimestampResetConfig getTimestampResetConfig();
+
511
+
523 void timestampReset();
+
524
+
528#define timerReset timestampReset
+
529
+
541 void timerSyncWithHost();
+
542
+
547 void loadDepthFilterConfig(const char *filePath);
+
548
+
552 void resetDefaultDepthFilterConfig();
+
553
+
559 const char *getCurrentPresetName();
+
560
+
567 void loadPreset(const char *presetName);
+
568
+
576 std::shared_ptr<DevicePresetList> getAvailablePresetList();
+
577
+
588 void loadPresetFromJsonFile(const char *filePath);
+
589
+
601 void loadPresetFromJsonData(const char *presetName, const uint8_t *data, uint32_t size);
+
602
+
610 void exportSettingsAsPresetJsonFile(const char *filePath);
+
611
+
623 void exportSettingsAsPresetJsonData(const char *presetName, const uint8_t **data, uint32_t *dataSize);
+
624
+
625 friend class Pipeline;
+
626 friend class Recorder;
+
627 friend class CoordinateTransformHelper;
+
628};
+
629
+
633class OB_EXTENSION_API DeviceInfo {
+
634private:
+
635 std::unique_ptr<DeviceInfoImpl> impl_;
+
636
+
637public:
+
638 DeviceInfo(std::unique_ptr<DeviceInfoImpl> impl);
+
639 virtual ~DeviceInfo() noexcept;
+
640
+
646 const char *name();
+
647
+
653 int pid();
+
654
+
660 int vid();
+
661
+
667 const char *uid();
+
668
+
674 const char *serialNumber();
+
675
+
681 const char *firmwareVersion();
+
682
+
688 DEPRECATED const char *usbType();
+
689
+
696 const char *connectionType();
+
697
+
705 const char *ipAddress();
+
706
+
712 const char *hardwareVersion();
+
713
+
719 const char *supportedMinSdkVersion();
+
720
+
726 const char *extensionInfo();
+
727
+
733 const char *asicName();
+
734
+
740 OBDeviceType deviceType();
+
741
+
742 friend class Context;
+
743 friend class DeviceList;
+
744 friend class Pipeline;
+
745};
+
746
+
750class OB_EXTENSION_API DeviceList {
+
751private:
+
752 std::unique_ptr<DeviceListImpl> impl_;
+
753
+
754public:
+
755 DeviceList(std::unique_ptr<DeviceListImpl> impl);
+
756 ~DeviceList() noexcept;
+
757
+
763 uint32_t deviceCount();
+
764
+
771 DEPRECATED const char *name(uint32_t index);
+
772
+
779 int pid(uint32_t index);
+
780
+
787 int vid(uint32_t index);
+
788
+
795 const char *uid(uint32_t index);
+
796
+
803 const char *serialNumber(uint32_t index);
+
804
+
811 const char *connectionType(uint32_t index);
+
812
+
821 const char *ipAddress(uint32_t index);
+
822
+
831 std::shared_ptr<Device> getDevice(uint32_t index);
+
832
+
841 std::shared_ptr<Device> getDeviceBySN(const char *serialNumber);
+
842
+
854 std::shared_ptr<Device> getDeviceByUid(const char *uid);
+
855};
+
856
+
860class OB_EXTENSION_API CameraParamList {
+
861private:
+
862 std::unique_ptr<CameraParamListImpl> impl_;
+
863
+
864public:
+
865 CameraParamList(std::unique_ptr<CameraParamListImpl> impl);
+
866 ~CameraParamList() noexcept;
+
867
+
873 uint32_t count();
+
874
+
881 OBCameraParam getCameraParam(uint32_t index);
+
882};
+
883
+
887class OB_EXTENSION_API OBDepthWorkModeList {
+
888private:
+
889 std::unique_ptr<OBDepthWorkModeListImpl> impl_;
+
890
+
891public:
+
892 OBDepthWorkModeList(std::unique_ptr<OBDepthWorkModeListImpl> impl_);
+
893 ~OBDepthWorkModeList();
+
894
+
900 uint32_t count();
+
901
+
908 OBDepthWorkMode getOBDepthWorkMode(uint32_t index);
+
909
+
916 const char *getName(uint32_t index);
+
917
+
924 OBDepthWorkMode operator[](uint32_t index);
+
925};
+
926
+
931class OB_EXTENSION_API DevicePresetList {
+
932private:
+
933 std::unique_ptr<DevicePresetListImpl> impl_;
+
934
+
935public:
+
936 DevicePresetList(std::unique_ptr<DevicePresetListImpl> impl);
+
937 ~DevicePresetList() noexcept;
+
938
+
944 uint32_t count();
+
945
+
952 const char *getName(uint32_t index);
+
953
+
959 bool hasPreset(const char *name);
+
960};
+
961
+
962} // namespace ob
+
Filter.hpp
This file contains the Filter class, which is the processing unit of the SDK that can perform point c...
+
OBSensorType
OBSensorType
Enumeration value describing the sensor type.
Definition ObTypes.h:157
+
OBStatus
OBStatus
error code
Definition ObTypes.h:106
+
OBDeviceState
uint64_t OBDeviceState
Device state.
Definition ObTypes.h:635
+
OBDeviceType
OBDeviceType
Enumeration for device types.
Definition ObTypes.h:667
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition ObTypes.h:28
+
OBPermissionType
OBPermissionType
the permission type of api or property
Definition ObTypes.h:94
+
OBCmdVersion
enum OB_CMD_VERSION OBCmdVersion
+
DEPRECATED
#define DEPRECATED
Definition ObTypes.h:42
+
Property.h
Control command property list maintenance.
+
OBPropertyID
OBPropertyID
Enumeration value describing all attribute control commands of the device.
Definition Property.h:24
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+
DeviceStateChangedCallback
std::function< void(OBDeviceState state, const char *message)> DeviceStateChangedCallback
Callback function for device status updates.
Definition Types.hpp:40
+
SetDataCallback
std::function< void(OBDataTranState state, uint8_t percent)> SetDataCallback
Callback function for setting the raw data property when progress callbacks are made.
Definition Types.hpp:56
+
DeviceUpgradeCallback
std::function< void(OBUpgradeState state, const char *message, uint8_t percent)> DeviceUpgradeCallback
Callback function for device upgrade status updates.
Definition Types.hpp:32
+
GetDataCallback
std::function< void(OBDataTranState state, OBDataChunk *dataChunk)> GetDataCallback
Callback function for getting raw data property data when data and progress callbacks are made.
Definition Types.hpp:48
+
SendFileCallback
std::function< void(OBFileTranState state, const char *message, uint8_t percent)> SendFileCallback
Callback function for file transfer status updates.
Definition Types.hpp:23
+
ob::CameraParamList
Class representing a list of camera parameters.
Definition Device.hpp:860
+
ob::CameraParamList::~CameraParamList
~CameraParamList() noexcept
+
ob::CameraParamList::CameraParamList
CameraParamList(std::unique_ptr< CameraParamListImpl > impl)
+ + +
ob::DeviceInfo
A class describing device information, representing the name, id, serial number and other basic infor...
Definition Device.hpp:633
+
ob::DeviceInfo::DeviceInfo
DeviceInfo(std::unique_ptr< DeviceInfoImpl > impl)
+
ob::DeviceInfo::~DeviceInfo
virtual ~DeviceInfo() noexcept
+
ob::DeviceList
Class representing a list of devices.
Definition Device.hpp:750
+
ob::DeviceList::DeviceList
DeviceList(std::unique_ptr< DeviceListImpl > impl)
+
ob::DeviceList::~DeviceList
~DeviceList() noexcept
+
ob::DevicePresetList
Class representing a list of device presets @breif A device preset is a set of parameters or configur...
Definition Device.hpp:931
+
ob::DevicePresetList::DevicePresetList
DevicePresetList(std::unique_ptr< DevicePresetListImpl > impl)
+
ob::DevicePresetList::~DevicePresetList
~DevicePresetList() noexcept
+ +
ob::Device::Device
Device(Device &&device)
+
ob::Device::timerSyncWithHost
void timerSyncWithHost()
synchronize the timer of the device with the host.
+
ob::Device::loadPresetFromJsonData
void loadPresetFromJsonData(const char *presetName, const uint8_t *data, uint32_t size)
Load custom preset from data.
+
ob::Device::exportSettingsAsPresetJsonFile
void exportSettingsAsPresetJsonFile(const char *filePath)
Export current device settings as a preset json file.
+
ob::Device::Device
Device(std::unique_ptr< DeviceImpl > impl)
Describe the entity of the RGBD camera, representing a specific model of RGBD camera.
+
ob::Device::resetDefaultDepthFilterConfig
void resetDefaultDepthFilterConfig()
Reset depth filter config to device default define.
+
ob::Device::getCurrentPresetName
const char * getCurrentPresetName()
Get current preset name.
+
ob::Device::loadPresetFromJsonFile
void loadPresetFromJsonFile(const char *filePath)
Load custom preset from file.
+
ob::Device::loadPreset
void loadPreset(const char *presetName)
load the preset according to the preset name.
+
ob::Device::~Device
virtual ~Device() noexcept
+
ob::Device::exportSettingsAsPresetJsonData
void exportSettingsAsPresetJsonData(const char *presetName, const uint8_t **data, uint32_t *dataSize)
Export current device settings as a preset json data.
+
ob::Device::loadDepthFilterConfig
void loadDepthFilterConfig(const char *filePath)
Load depth filter config from file.
+
ob::Device::getAvailablePresetList
std::shared_ptr< DevicePresetList > getAvailablePresetList()
Get available preset list.
+
ob::Device::impl_
std::unique_ptr< DeviceImpl > impl_
Definition Device.hpp:31
+
ob::OBDepthWorkModeList
Class representing a list of OBDepthWorkMode.
Definition Device.hpp:887
+
ob::OBDepthWorkModeList::count
uint32_t count()
Get the number of OBDepthWorkMode objects in the list.
+
ob::OBDepthWorkModeList::getName
const char * getName(uint32_t index)
Get the name of the depth work mode at the specified index.
+
ob::OBDepthWorkModeList::OBDepthWorkModeList
OBDepthWorkModeList(std::unique_ptr< OBDepthWorkModeListImpl > impl_)
+ +
ob::OBDepthWorkModeList::getOBDepthWorkMode
OBDepthWorkMode getOBDepthWorkMode(uint32_t index)
Get the OBDepthWorkMode object at the specified index.
+
ob::OBDepthWorkModeList::operator[]
OBDepthWorkMode operator[](uint32_t index)
Get the OBDepthWorkMode object at the specified index.
+ + + + +
ob
Definition Context.hpp:16
+
OBBoolPropertyRange
Structure for boolean range.
Definition ObTypes.h:363
+
OBCameraParam
Structure for camera parameters.
Definition ObTypes.h:456
+
OBDataBundle
Internal API for future publication.
Definition ObTypes.h:1049
+
OBDepthWorkMode
Depth work mode.
Definition ObTypes.h:931
+
OBDeviceSyncConfig
Device synchronization configuration.
Definition ObTypes.h:875
+
OBFloatPropertyRange
Structure for float range.
Definition ObTypes.h:330
+
OBIntPropertyRange
Structure for integer range.
Definition ObTypes.h:319
+
OBPropertyItem
Used to describe the characteristics of each property.
Definition Property.h:723
+
OBProtocolVersion
Control command protocol version number.
Definition ObTypes.h:1003
+
ob_device_timestamp_reset_config
The timestamp reset configuration of the device.
Definition ObTypes.h:1368
+
ob_multi_device_sync_config
The synchronization configuration of the device.
Definition ObTypes.h:1304
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/Error_8hpp_source.html b/doc/api/English/Error_8hpp_source.html new file mode 100644 index 00000000..858d845c --- /dev/null +++ b/doc/api/English/Error_8hpp_source.html @@ -0,0 +1,124 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Error.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Error.hpp
+
+
+Go to the documentation of this file.
1
+
6#pragma once
+
7
+
8#include "Types.hpp"
+
9#include <memory>
+
10
+
11struct ErrorImpl;
+
12
+
13namespace ob {
+
14class OB_EXTENSION_API Error {
+
15private:
+
16 std::unique_ptr<ErrorImpl> impl_;
+
17
+
18public:
+
19 Error(std::unique_ptr<ErrorImpl> impl) noexcept;
+
20
+
21 Error(const Error &error) noexcept;
+
22
+
23 ~Error() noexcept;
+
24
+
29 const char *getMessage() const noexcept;
+
30
+
35 OBExceptionType getExceptionType() const noexcept;
+
36
+
41 const char *getName() const noexcept;
+
42
+
47 const char *getArgs() const noexcept;
+
48};
+
49} // namespace ob
+
OBExceptionType
OBExceptionType
The exception types in the SDK, through the exception type, you can easily determine the specific typ...
Definition ObTypes.h:129
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition ObTypes.h:28
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+ +
ob::Error::Error
Error(const Error &error) noexcept
+
ob::Error::Error
Error(std::unique_ptr< ErrorImpl > impl) noexcept
+
ob::Error::~Error
~Error() noexcept
+
ob
Definition Context.hpp:16
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/ObSensor_8hpp_source.html b/doc/api/English/ObSensor_8hpp_source.html new file mode 100644 index 00000000..a3bc71d3 --- /dev/null +++ b/doc/api/English/ObSensor_8hpp_source.html @@ -0,0 +1,114 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/ObSensor.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ObSensor.hpp
+
+
+Go to the documentation of this file.
1/* License: Apache 2.0. See LICENSE file in root directory.
+
2 Copyright(c) 2020 Orbbec Corporation. All Rights Reserved. */
+
3
+
9#pragma once
+
10
+
11#include <libobsensor/hpp/Context.hpp>
+
12#include <libobsensor/hpp/Device.hpp>
+
13#include <libobsensor/hpp/Error.hpp>
+
14#include <libobsensor/hpp/Filter.hpp>
+
15#include <libobsensor/hpp/Frame.hpp>
+
16#include <libobsensor/hpp/Pipeline.hpp>
+
17#include <libobsensor/hpp/RecordPlayback.hpp>
+
18#include <libobsensor/hpp/Sensor.hpp>
+
19#include <libobsensor/hpp/StreamProfile.hpp>
+
20#include <libobsensor/hpp/Types.hpp>
+
21#include <libobsensor/hpp/Version.hpp>
+
Context.hpp
The SDK context class, which serves as the entry point to the underlying SDK. It is used to query dev...
+
Device.hpp
Device related types, including operations such as getting and creating a device, setting and obtaini...
+
Error.hpp
This file defines the Error class, which describes abnormal errors within the SDK....
+
Filter.hpp
This file contains the Filter class, which is the processing unit of the SDK that can perform point c...
+
Frame.hpp
Frame related type, which is mainly used to obtain frame data and frame information.
+
Pipeline.hpp
The SDK's advanced API type can quickly implement switching streaming and frame synchronization opera...
+
RecordPlayback.hpp
Header file for recording and playback functions.
+
Sensor.hpp
Defines types related to sensors, which are used to obtain stream configurations, open and close stre...
+
StreamProfile.hpp
The stream profile related type is used to get information such as the width, height,...
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+
Version.hpp
Provides functions to retrieve version information of the SDK.
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/ObTypes_8h_source.html b/doc/api/English/ObTypes_8h_source.html new file mode 100644 index 00000000..0f93d61b --- /dev/null +++ b/doc/api/English/ObTypes_8h_source.html @@ -0,0 +1,1795 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/h/ObTypes.h Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ObTypes.h
+
+
+Go to the documentation of this file.
1// License: Apache 2.0. See LICENSE file in root directory.
+
2// Copyright(c) 2020 Orbbec Corporation. All Rights Reserved.
+
3
+
9#pragma once
+
10#if(defined(WIN32) || defined(_WIN32) || defined(WINCE))
+
11#ifdef OB_EXPORTS
+
12#define OB_EXTENSION_API __declspec(dllexport)
+
13#define OB_EXTENSION_INTERNAL_API __declspec(dllexport)
+
14#elif defined(OB2_EXPORTS)
+
15#define OB_EXTENSION_API __declspec(dllexport)
+
16#define OB_EXTENSION_INTERNAL_API
+
17#else
+
18#ifndef OB_STATIC
+
19#define OB_EXTENSION_API __declspec(dllimport)
+
20#define OB_EXTENSION_INTERNAL_API __declspec(dllimport)
+
21#else
+
22#define OB_EXTENSION_API
+
23#define OB_EXTENSION_INTERNAL_API
+
24#endif
+
25#endif
+
26#else
+
27#ifndef OB_STATIC
+
28#define OB_EXTENSION_API __attribute__((visibility("default")))
+
29#define OB_EXTENSION_INTERNAL_API __attribute__((visibility("default")))
+
30#else
+
31#define OB_EXTENSION_API
+
32#define OB_EXTENSION_INTERNAL_API
+
33#endif
+
34#endif
+
35
+
36#if defined(__GNUC__) || defined(__clang__)
+
37#define DEPRECATED __attribute__((deprecated))
+
38#elif defined(_MSC_VER)
+
39#define DEPRECATED __declspec(deprecated)
+
40#else
+
41#pragma message("WARNING: You need to implement DEPRECATED for this compiler")
+
42#define DEPRECATED
+
43#endif
+
44
+
45#pragma pack(push, 1) // struct 1-byte align
+
46
+
47#ifdef __cplusplus
+
48extern "C" {
+
49#endif
+
50
+
51#include <stdbool.h>
+
52#include <stdint.h>
+
53
+
54typedef struct ContextImpl ob_context;
+
55typedef struct DeviceImpl ob_device;
+
56typedef struct DeviceInfoImpl ob_device_info;
+
57typedef struct DeviceListImpl ob_device_list;
+
58typedef struct CameraParamListImpl ob_camera_param_list;
+
59typedef struct SensorImpl ob_sensor;
+
60typedef struct SensorListImpl ob_sensor_list;
+
61typedef struct StreamProfileImpl ob_stream_profile;
+
62typedef struct StreamProfileListImpl ob_stream_profile_list;
+
63typedef struct CFrameImpl ob_frame;
+
64typedef struct FilterImpl ob_filter;
+
65typedef struct PipelineImpl ob_pipeline;
+
66typedef struct ConfigImpl ob_config;
+
67typedef struct RecorderImpl ob_recorder;
+
68typedef struct PlaybackImpl ob_playback;
+
69typedef struct OBDepthWorkModeListImpl ob_depth_work_mode_list;
+
70typedef struct FilterListImpl ob_filter_list;
+
71typedef struct OBFilterListImpl ob_filters;
+
72typedef struct DevicePresetListImpl ob_device_preset_list;
+
73
+
74#define OB_WIDTH_ANY 0
+
75#define OB_HEIGHT_ANY 0
+
76#define OB_FPS_ANY 0
+
77#define OB_FORMAT_ANY OB_FORMAT_UNKNOWN
+
78#define OB_PROFILE_DEFAULT 0
+
79
+
83typedef enum {
+
84 HP_STATUS_OK = 0,
+
85 HP_STATUS_NO_DEVICE_FOUND = 1,
+
86 HP_STATUS_CONTROL_TRANSFER_FAILED = 2,
+
87 HP_STATUS_UNKNOWN_ERROR = 0xffff,
+
88} OBHPStatusCode,
+
89 ob_hp_status_code;
+
90
+
94typedef enum {
+
95 OB_PERMISSION_DENY = 0,
+
96 OB_PERMISSION_READ = 1,
+
97 OB_PERMISSION_WRITE = 2,
+
98 OB_PERMISSION_READ_WRITE = 3,
+
99 OB_PERMISSION_ANY = 255,
+
100} OBPermissionType,
+
101 ob_permission_type;
+
102
+
106typedef enum {
+
107 OB_STATUS_OK = 0,
+
108 OB_STATUS_ERROR = 1,
+
109} OBStatus,
+
110 ob_status;
+
111
+
115typedef enum {
+
116 OB_LOG_SEVERITY_DEBUG,
+
117 OB_LOG_SEVERITY_INFO,
+
118 OB_LOG_SEVERITY_WARN,
+
119 OB_LOG_SEVERITY_ERROR,
+
120 OB_LOG_SEVERITY_FATAL,
+
121 OB_LOG_SEVERITY_OFF
+
122} OBLogSeverity,
+
123 ob_log_severity, DEVICE_LOG_SEVERITY_LEVEL, OBDeviceLogSeverityLevel, ob_device_log_severity_level;
+
124#define OB_LOG_SEVERITY_NONE OB_LOG_SEVERITY_OFF
+
129typedef enum {
+
130 OB_EXCEPTION_TYPE_UNKNOWN,
+
131 OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED,
+
132 OB_EXCEPTION_TYPE_PLATFORM,
+
134 OB_EXCEPTION_TYPE_INVALID_VALUE,
+
135 OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE,
+
136 OB_EXCEPTION_TYPE_NOT_IMPLEMENTED,
+
137 OB_EXCEPTION_TYPE_IO,
+
138 OB_EXCEPTION_TYPE_MEMORY,
+
139 OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION,
+
140} OBExceptionType,
+
141 ob_exception_type;
+
142
+
146typedef struct ob_error {
+
147 ob_status status;
+
148 char message[256];
+
149 char function[256];
+
150 char args[256];
+
151 ob_exception_type exception_type;
+
152} ob_error;
+
153
+
157typedef enum {
+
158 OB_SENSOR_UNKNOWN = 0,
+
159 OB_SENSOR_IR = 1,
+
160 OB_SENSOR_COLOR = 2,
+
161 OB_SENSOR_DEPTH = 3,
+
162 OB_SENSOR_ACCEL = 4,
+
163 OB_SENSOR_GYRO = 5,
+
164 OB_SENSOR_IR_LEFT = 6,
+
165 OB_SENSOR_IR_RIGHT = 7,
+
166 OB_SENSOR_RAW_PHASE = 8,
+
167 OB_SENSOR_COUNT,
+
168} OBSensorType,
+
169 ob_sensor_type;
+
170
+
174typedef enum {
+
175 OB_STREAM_UNKNOWN = -1,
+
176 OB_STREAM_VIDEO = 0,
+
177 OB_STREAM_IR = 1,
+
178 OB_STREAM_COLOR = 2,
+
179 OB_STREAM_DEPTH = 3,
+
180 OB_STREAM_ACCEL = 4,
+
181 OB_STREAM_GYRO = 5,
+
182 OB_STREAM_IR_LEFT = 6,
+
183 OB_STREAM_IR_RIGHT = 7,
+
184 OB_STREAM_RAW_PHASE = 8,
+
185} OBStreamType,
+
186 ob_stream_type;
+
187
+
191typedef enum {
+
192 OB_FRAME_UNKNOWN = -1,
+
193 OB_FRAME_VIDEO = 0,
+
194 OB_FRAME_IR = 1,
+
195 OB_FRAME_COLOR = 2,
+
196 OB_FRAME_DEPTH = 3,
+
197 OB_FRAME_ACCEL = 4,
+
198 OB_FRAME_SET = 5,
+
199 OB_FRAME_POINTS = 6,
+
200 OB_FRAME_GYRO = 7,
+
201 OB_FRAME_IR_LEFT = 8,
+
202 OB_FRAME_IR_RIGHT = 9,
+
203 OB_FRAME_RAW_PHASE = 10,
+
204} OBFrameType,
+
205 ob_frame_type;
+
206
+
210typedef enum {
+
211 OB_FORMAT_YUYV = 0,
+
212 OB_FORMAT_YUY2 = 1,
+
213 OB_FORMAT_UYVY = 2,
+
214 OB_FORMAT_NV12 = 3,
+
215 OB_FORMAT_NV21 = 4,
+
216 OB_FORMAT_MJPG = 5,
+
217 OB_FORMAT_H264 = 6,
+
218 OB_FORMAT_H265 = 7,
+
219 OB_FORMAT_Y16 = 8,
+
220 OB_FORMAT_Y8 = 9,
+
221 OB_FORMAT_Y10 = 10,
+
222 OB_FORMAT_Y11 = 11,
+
223 OB_FORMAT_Y12 = 12,
+
224 OB_FORMAT_GRAY = 13,
+
225 OB_FORMAT_HEVC = 14,
+
226 OB_FORMAT_I420 = 15,
+
227 OB_FORMAT_ACCEL = 16,
+
228 OB_FORMAT_GYRO = 17,
+
229 OB_FORMAT_POINT = 19,
+
230 OB_FORMAT_RGB_POINT = 20,
+
231 OB_FORMAT_RLE = 21,
+
232 OB_FORMAT_RGB = 22,
+
233 OB_FORMAT_BGR = 23,
+
234 OB_FORMAT_Y14 = 24,
+
235 OB_FORMAT_BGRA = 25,
+
236 OB_FORMAT_COMPRESSED = 26,
+
237 OB_FORMAT_RVL = 27,
+
238 OB_FORMAT_Z16 = 28,
+
239 OB_FORMAT_YV12 = 29,
+
240 OB_FORMAT_BA81 = 30,
+
241 OB_FORMAT_RGBA = 31,
+
242 OB_FORMAT_BYR2 = 32,
+
243 OB_FORMAT_RW16 = 33,
+
244 OB_FORMAT_DISP16 = 34,
+
245 OB_FORMAT_UNKNOWN = 0xff,
+
246} OBFormat,
+
247 ob_format;
+
248
+
249#define OB_FORMAT_RGB888 OB_FORMAT_RGB // Alias of OB_FORMAT_RGB for compatibility
+
250#define OB_FORMAT_MJPEG OB_FORMAT_MJPG // Alias of OB_FORMAT_MJPG for compatibility
+
251
+
255typedef enum {
+
256 STAT_VERIFY_SUCCESS = 5,
+
257 STAT_FILE_TRANSFER = 4,
+
258 STAT_DONE = 3,
+
259 STAT_IN_PROGRESS = 2,
+
260 STAT_START = 1,
+
261 STAT_VERIFY_IMAGE = 0,
+
262 ERR_VERIFY = -1,
+
263 ERR_PROGRAM = -2,
+
264 ERR_ERASE = -3,
+
265 ERR_FLASH_TYPE = -4,
+
266 ERR_IMAGE_SIZE = -5,
+
267 ERR_OTHER = -6,
+
268 ERR_DDR = -7,
+
269 ERR_TIMEOUT = -8
+
270} OBUpgradeState,
+
271 ob_upgrade_state;
+
272
+
276typedef enum {
+
277 FILE_TRAN_STAT_TRANSFER = 2,
+
278 FILE_TRAN_STAT_DONE = 1,
+
279 FILE_TRAN_STAT_PREPAR = 0,
+
280 FILE_TRAN_ERR_DDR = -1,
+
281 FILE_TRAN_ERR_NOT_ENOUGH_SPACE = -2,
+
282 FILE_TRAN_ERR_PATH_NOT_WRITABLE = -3,
+
283 FILE_TRAN_ERR_MD5_ERROR = -4,
+
284 FILE_TRAN_ERR_WRITE_FLASH_ERROR = -5,
+
285 FILE_TRAN_ERR_TIMEOUT = -6
+
286} OBFileTranState,
+
287 ob_file_tran_state;
+
288
+
292typedef enum {
+
293 DATA_TRAN_STAT_VERIFY_DONE = 4,
+
294 DATA_TRAN_STAT_STOPPED = 3,
+
295 DATA_TRAN_STAT_DONE = 2,
+
296 DATA_TRAN_STAT_VERIFYING = 1,
+
297 DATA_TRAN_STAT_TRANSFERRING = 0,
+
298 DATA_TRAN_ERR_BUSY = -1,
+
299 DATA_TRAN_ERR_UNSUPPORTED = -2,
+
300 DATA_TRAN_ERR_TRAN_FAILED = -3,
+
301 DATA_TRAN_ERR_VERIFY_FAILED = -4,
+
302 DATA_TRAN_ERR_OTHER = -5
+
303} OBDataTranState,
+
304 ob_data_tran_state;
+
305
+
309typedef struct {
+
310 uint8_t *data;
+
311 uint32_t size;
+
312 uint32_t offset;
+
313 uint32_t fullDataSize;
+
314} OBDataChunk, ob_data_chunk;
+
315
+
319typedef struct {
+
320 int32_t cur;
+
321 int32_t max;
+
322 int32_t min;
+
323 int32_t step;
+
324 int32_t def;
+
325} OBIntPropertyRange, ob_int_property_range;
+
326
+
330typedef struct {
+
331 float cur;
+
332 float max;
+
333 float min;
+
334 float step;
+
335 float def;
+
336} OBFloatPropertyRange, ob_float_property_range;
+
337
+
341typedef struct {
+
342 uint16_t cur;
+
343 uint16_t max;
+
344 uint16_t min;
+
345 uint16_t step;
+
346 uint16_t def;
+
347} OBUint16PropertyRange, ob_uint16_property_range;
+
348
+
352typedef struct {
+
353 uint8_t cur;
+
354 uint8_t max;
+
355 uint8_t min;
+
356 uint8_t step;
+
357 uint8_t def;
+
358} OBUint8PropertyRange, ob_uint8_property_range;
+
359
+
363typedef struct {
+
364 bool cur;
+
365 bool max;
+
366 bool min;
+
367 bool step;
+
368 bool def;
+
369} OBBoolPropertyRange, ob_bool_property_range;
+
370
+
374typedef struct {
+
375 float fx;
+
376 float fy;
+
377 float cx;
+
378 float cy;
+
379 int16_t width;
+
380 int16_t height;
+
381} OBCameraIntrinsic, ob_camera_intrinsic;
+
382
+
386typedef struct {
+
387 double noiseDensity;
+
388 double randomWalk;
+
389 double referenceTemp;
+
390 double bias[3];
+
391 double gravity[3];
+
392 double scaleMisalignment[9];
+
393 double tempSlope[9];
+
394} OBAccelIntrinsic, ob_accel_intrinsic;
+
395
+
399typedef struct {
+
400 double noiseDensity;
+
401 double randomWalk;
+
402 double referenceTemp;
+
403 double bias[3];
+
404 double scaleMisalignment[9];
+
405 double tempSlope[9];
+
406} OBGyroIntrinsic, ob_gyro_intrinsic;
+
407
+
411typedef struct {
+
412 float k1;
+
413 float k2;
+
414 float k3;
+
415 float k4;
+
416 float k5;
+
417 float k6;
+
418 float p1;
+
419 float p2;
+
420} OBCameraDistortion, ob_camera_distortion;
+
421
+
423typedef enum {
+
424 OB_DISTORTION_NONE,
+
425 OB_DISTORTION_MODIFIED_BROWN_CONRADY,
+
427 OB_DISTORTION_INVERSE_BROWN_CONRADY,
+
428 OB_DISTORTION_BROWN_CONRADY,
+
429} OBCameraDistortionModel,
+
430 ob_camera_distortion_model;
+
431
+
433typedef struct {
+
434 int width;
+
435 int height;
+
436 float ppx;
+
437 float ppy;
+
438 float fx;
+
439 float fy;
+
440 OBCameraDistortionModel model;
+
441 float coeffs[5];
+
443} OBCameraAlignIntrinsic, ob_camera_align_intrinsic;
+
444
+
448typedef struct {
+
449 float rot[9];
+
450 float trans[3];
+
451} OBD2CTransform, ob_d2c_transform, OBTransform, ob_transform, OBExtrinsic, ob_extrinsic;
+
452
+
456typedef struct {
+
457 OBCameraIntrinsic depthIntrinsic;
+
458 OBCameraIntrinsic rgbIntrinsic;
+
459 OBCameraDistortion depthDistortion;
+
460 OBCameraDistortion rgbDistortion;
+
461 OBD2CTransform transform;
+
462 bool isMirrored;
+
463} OBCameraParam, ob_camera_param;
+
464
+
468typedef struct {
+
469 OBCameraIntrinsic depthIntrinsic;
+
470 OBCameraIntrinsic rgbIntrinsic;
+
471 OBCameraDistortion depthDistortion;
+
472
+
473 OBCameraDistortion rgbDistortion;
+
474 OBD2CTransform transform;
+
475} OBCameraParam_V0, ob_camera_param_v0;
+
476
+
480typedef struct {
+
481 OBCameraIntrinsic intrinsics[OB_SENSOR_COUNT];
+
482 OBCameraDistortion distortion[OB_SENSOR_COUNT];
+
483 OBExtrinsic extrinsics[OB_SENSOR_COUNT][OB_SENSOR_COUNT];
+
485} OBCalibrationParam, ob_calibration_param;
+
486
+
490typedef struct {
+
491 int margin_x_th;
+
492 int margin_y_th;
+
493 int limit_x_th;
+
494 int limit_y_th;
+
495 uint32_t width;
+
496 uint32_t height;
+
497 bool enable_direction;
+
498} ob_margin_filter_config, OBMarginFilterConfig;
+
499
+
503typedef struct {
+
504 uint32_t width;
+
505 uint32_t height;
+
506 int max_width_left;
+
507 int max_width_right;
+
508 int max_radius;
+
509 int margin_x_th;
+
510 int margin_y_th;
+
511 int limit_x_th;
+
512 int limit_y_th;
+
513} OBMGCFilterConfig, ob_mgc_filter_config;
+
514
+
518typedef enum {
+
519 ALIGN_DISABLE,
+
520 ALIGN_D2C_HW_MODE,
+
521 ALIGN_D2C_SW_MODE,
+
522} OBAlignMode,
+
523 ob_align_mode;
+
524
+
528typedef struct {
+
529 uint32_t x;
+
530 uint32_t y;
+
531 uint32_t width;
+
532 uint32_t height;
+
533} OBRect, ob_rect;
+
534
+
538typedef enum {
+
539 FORMAT_YUYV_TO_RGB = 0,
+
540 FORMAT_I420_TO_RGB,
+
541 FORMAT_NV21_TO_RGB,
+
542 FORMAT_NV12_TO_RGB,
+
543 FORMAT_MJPG_TO_I420,
+
544 FORMAT_RGB_TO_BGR,
+
545 FORMAT_MJPG_TO_NV21,
+
546 FORMAT_MJPG_TO_RGB,
+
547 FORMAT_MJPG_TO_BGR,
+
548 FORMAT_MJPG_TO_BGRA,
+
549 FORMAT_UYVY_TO_RGB,
+
550 FORMAT_BGR_TO_RGB,
+
551 FORMAT_MJPG_TO_NV12,
+
552 FORMAT_YUYV_TO_BGR,
+
553 FORMAT_YUYV_TO_RGBA,
+
554 FORMAT_YUYV_TO_BGRA,
+
555 FORMAT_YUYV_TO_Y16,
+
556 FORMAT_YUYV_TO_Y8,
+
557} OBConvertFormat,
+
558 ob_convert_format;
+
559
+
560// DEPRECATED: Only used for old version program compatibility, will be completely deleted in subsequent iterative versions
+
561#define FORMAT_MJPEG_TO_I420 FORMAT_MJPG_TO_I420
+
562#define FORMAT_MJPEG_TO_NV21 FORMAT_MJPG_TO_NV21
+
563#define FORMAT_MJPEG_TO_BGRA FORMAT_MJPG_TO_BGRA
+
564#define FORMAT_YUYV_TO_RGB888 FORMAT_YUYV_TO_RGB
+
565#define FORMAT_I420_TO_RGB888 FORMAT_I420_TO_RGB
+
566#define FORMAT_NV21_TO_RGB888 FORMAT_NV21_TO_RGB
+
567#define FORMAT_NV12_TO_RGB888 FORMAT_NV12_TO_RGB
+
568#define FORMAT_UYVY_TO_RGB888 FORMAT_UYVY_TO_RGB
+
569#define FORMAT_MJPG_TO_RGB888 FORMAT_MJPG_TO_RGB
+
570#define FORMAT_MJPG_TO_BGR888 FORMAT_MJPG_TO_BGR
+
571#define FORMAT_MJPEG_TO_RGB888 FORMAT_MJPG_TO_RGB
+
572#define FORMAT_MJPEG_TO_BGR888 FORMAT_MJPG_TO_BGR
+
573#define FORMAT_RGB888_TO_BGR FORMAT_RGB_TO_BGR
+
574
+
578typedef enum {
+
579 OB_SAMPLE_RATE_1_5625_HZ = 1,
+
580 OB_SAMPLE_RATE_3_125_HZ,
+
581 OB_SAMPLE_RATE_6_25_HZ,
+
582 OB_SAMPLE_RATE_12_5_HZ,
+
583 OB_SAMPLE_RATE_25_HZ,
+
584 OB_SAMPLE_RATE_50_HZ,
+
585 OB_SAMPLE_RATE_100_HZ,
+
586 OB_SAMPLE_RATE_200_HZ,
+
587 OB_SAMPLE_RATE_500_HZ,
+
588 OB_SAMPLE_RATE_1_KHZ,
+
589 OB_SAMPLE_RATE_2_KHZ,
+
590 OB_SAMPLE_RATE_4_KHZ,
+
591 OB_SAMPLE_RATE_8_KHZ,
+
592 OB_SAMPLE_RATE_16_KHZ,
+
593 OB_SAMPLE_RATE_32_KHZ,
+
594} OBGyroSampleRate,
+
595 ob_gyro_sample_rate, OBAccelSampleRate, ob_accel_sample_rate, OB_SAMPLE_RATE;
+
596
+
600typedef enum {
+
601 OB_GYRO_FS_16dps = 1,
+
602 OB_GYRO_FS_31dps,
+
603 OB_GYRO_FS_62dps,
+
604 OB_GYRO_FS_125dps,
+
605 OB_GYRO_FS_250dps,
+
606 OB_GYRO_FS_500dps,
+
607 OB_GYRO_FS_1000dps,
+
608 OB_GYRO_FS_2000dps,
+
609} OBGyroFullScaleRange,
+
610 ob_gyro_full_scale_range, OB_GYRO_FULL_SCALE_RANGE;
+
611
+
615typedef enum {
+
616 OB_ACCEL_FS_2g = 1,
+
617 OB_ACCEL_FS_4g,
+
618 OB_ACCEL_FS_8g,
+
619 OB_ACCEL_FS_16g,
+
620} OBAccelFullScaleRange,
+
621 ob_accel_full_scale_range, OB_ACCEL_FULL_SCALE_RANGE;
+
622
+
626typedef struct {
+
627 float x;
+
628 float y;
+
629 float z;
+
630} OBAccelValue, OBGyroValue, ob_accel_value, ob_gyro_value;
+
631
+
635typedef uint64_t OBDeviceState, ob_device_state;
+
636
+
640typedef struct {
+
641 float cpuTemp;
+
642 float irTemp;
+
643 float ldmTemp;
+
644 float mainBoardTemp;
+
645 float tecTemp;
+
646 float imuTemp;
+
647 float rgbTemp;
+
648 float irLeftTemp;
+
649 float irRightTemp;
+
650 float chipTopTemp;
+
651 float chipBottomTemp;
+
652} OBDeviceTemperature, ob_device_temperature, DEVICE_TEMPERATURE;
+
653
+
657typedef enum {
+
658 DEPTH_CROPPING_MODE_AUTO = 0,
+
659 DEPTH_CROPPING_MODE_CLOSE = 1,
+
660 DEPTH_CROPPING_MODE_OPEN = 2,
+
661} OBDepthCroppingMode,
+
662 ob_depth_cropping_mode, OB_DEPTH_CROPPING_MODE;
+
663
+
667typedef enum {
+
668 OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA = 0,
+
669 OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA = 1,
+
670 OB_TOF_CAMERA = 2,
+
671} OBDeviceType,
+
672 ob_device_type, OB_DEVICE_TYPE;
+
673
+
677typedef enum {
+
678 OB_MEDIA_COLOR_STREAM = 1,
+
679 OB_MEDIA_DEPTH_STREAM = 2,
+
680 OB_MEDIA_IR_STREAM = 4,
+
681 OB_MEDIA_GYRO_STREAM = 8,
+
682 OB_MEDIA_ACCEL_STREAM = 16,
+
683 OB_MEDIA_CAMERA_PARAM = 32,
+
684 OB_MEDIA_DEVICE_INFO = 64,
+
685 OB_MEDIA_STREAM_INFO = 128,
+
686 OB_MEDIA_IR_LEFT_STREAM = 256,
+
687 OB_MEDIA_IR_RIGHT_STREAM = 512,
+
689 OB_MEDIA_ALL = OB_MEDIA_COLOR_STREAM | OB_MEDIA_DEPTH_STREAM | OB_MEDIA_IR_STREAM | OB_MEDIA_GYRO_STREAM | OB_MEDIA_ACCEL_STREAM | OB_MEDIA_CAMERA_PARAM
+
690 | OB_MEDIA_DEVICE_INFO | OB_MEDIA_STREAM_INFO | OB_MEDIA_IR_LEFT_STREAM | OB_MEDIA_IR_RIGHT_STREAM,
+
691} OBMediaType,
+
692 ob_media_type, OB_MEDIA_TYPE;
+
693
+
697typedef enum {
+
698 OB_MEDIA_BEGIN = 0,
+
699 OB_MEDIA_PAUSE,
+
700 OB_MEDIA_RESUME,
+
701 OB_MEDIA_END,
+
702} OBMediaState,
+
703 ob_media_state, OB_MEDIA_STATE_EM;
+
704
+
710typedef enum {
+
711 OB_PRECISION_1MM,
+
712 OB_PRECISION_0MM8,
+
713 OB_PRECISION_0MM4,
+
714 OB_PRECISION_0MM1,
+
715 OB_PRECISION_0MM2,
+
716 OB_PRECISION_0MM5,
+
717 OB_PRECISION_0MM05,
+
718 OB_PRECISION_UNKNOWN,
+
719 OB_PRECISION_COUNT,
+
720} OBDepthPrecisionLevel,
+
721 ob_depth_precision_level, OB_DEPTH_PRECISION_LEVEL;
+
722
+
726typedef enum {
+
727 OB_TOF_FILTER_RANGE_CLOSE = 0,
+
728 OB_TOF_FILTER_RANGE_MIDDLE = 1,
+
729 OB_TOF_FILTER_RANGE_LONG = 2,
+
730 OB_TOF_FILTER_RANGE_DEBUG = 100,
+
731} OBTofFilterRange,
+
732 ob_tof_filter_range, TOF_FILTER_RANGE;
+
736typedef struct {
+
737 float x;
+
738 float y;
+
739 float z;
+
740} OBPoint, ob_point, OBPoint3f, ob_point3f;
+
741
+
745typedef struct {
+
746 float x;
+
747 float y;
+
748} OBPoint2f, ob_point2f;
+
749
+
750typedef struct {
+
751 float *xTable;
+
752 float *yTable;
+
753 int width;
+
754 int height;
+
755} OBXYTables, ob_xy_tables;
+
756
+
760typedef struct {
+
761 float x;
+
762 float y;
+
763 float z;
+
764 float r;
+
765 float g;
+
766 float b;
+
767} OBColorPoint, ob_color_point;
+
768
+
772typedef enum {
+
773 OB_COMPRESSION_LOSSLESS = 0,
+
774 OB_COMPRESSION_LOSSY = 1,
+
775} OBCompressionMode,
+
776 ob_compression_mode, OB_COMPRESSION_MODE;
+
777
+
781typedef struct {
+
785 int threshold;
+
786} OBCompressionParams, ob_compression_params, OB_COMPRESSION_PARAMS;
+
787
+
791typedef struct {
+
792 int32_t upper;
+
793 int32_t lower;
+
794} OBTofExposureThresholdControl, ob_tof_exposure_threshold_control, TOF_EXPOSURE_THRESHOLD_CONTROL;
+
795
+
800typedef enum {
+
806 OB_SYNC_MODE_CLOSE = 0x00,
+
807
+
813 OB_SYNC_MODE_STANDALONE = 0x01,
+
814
+
820 OB_SYNC_MODE_PRIMARY = 0x02,
+
821
+
830 OB_SYNC_MODE_SECONDARY = 0x03,
+
831
+
837 OB_SYNC_MODE_PRIMARY_MCU_TRIGGER = 0x04,
+
838
+
844 OB_SYNC_MODE_PRIMARY_IR_TRIGGER = 0x05,
+
845
+
853 OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER = 0x06,
+
854
+
861 OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER = 0x07,
+
862
+
866 OB_SYNC_MODE_UNKNOWN = 0xff,
+
867
+
868} OBSyncMode,
+
869 ob_sync_mode, OB_SYNC_MODE;
+
870
+
875typedef struct {
+
879 OBSyncMode syncMode;
+
880
+
887 uint16_t irTriggerSignalInDelay;
+
888
+
895 uint16_t rgbTriggerSignalInDelay;
+
896
+
903 uint16_t deviceTriggerSignalOutDelay;
+
904
+
912 uint16_t deviceTriggerSignalOutPolarity;
+
913
+
920 uint16_t mcuTriggerFrequency;
+
921
+
925 uint16_t deviceId;
+
926
+
927} OBDeviceSyncConfig, ob_device_sync_config, OB_DEVICE_SYNC_CONFIG;
+
931typedef struct {
+
935 uint8_t checksum[16];
+
936
+
940 char name[32];
+
941} OBDepthWorkMode, ob_depth_work_mode;
+
942
+
946typedef struct {
+
947 int sequenceSelectId;
+
948 char name[8];
+
949} OBSequenceIdItem, ob_sequence_id_item;
+
950
+
954typedef enum {
+
955 OB_HOLE_FILL_TOP = 0,
+
956 OB_HOLE_FILL_NEAREST = 1, // "max" means farest for depth, and nearest for disparity; FILL_NEAREST
+
957 OB_HOLE_FILL_FAREST = 2, // FILL_FAREST
+
958} OBHoleFillingMode,
+
959 ob_hole_filling_mode;
+
960
+
961typedef struct {
+
962 uint8_t magnitude; // magnitude
+
963 float alpha; // smooth_alpha
+
964 uint16_t disp_diff; // smooth_delta
+
965 uint16_t radius; // hole_fill
+
966} OBSpatialAdvancedFilterParams, ob_spatial_advanced_filter_params;
+
967
+
968typedef enum OB_EDGE_NOISE_REMOVAL_TYPE {
+
969 OB_MG_FILTER = 0,
+
970 OB_MGH_FILTER = 1, // horizontal MG
+
971 OB_MGA_FILTER = 2, // asym MG
+
972 OB_MGC_FILTER = 3,
+
973} OBEdgeNoiseRemovalType,
+
974 ob_edge_noise_removal_type;
+
975
+
976typedef struct {
+
977 OBEdgeNoiseRemovalType type;
+
978 uint16_t marginLeftTh;
+
979 uint16_t marginRightTh;
+
980 uint16_t marginTopTh;
+
981 uint16_t marginBottomTh;
+
982} OBEdgeNoiseRemovalFilterParams, ob_edge_noise_removal_filter_params;
+
983
+
987typedef enum OB_DDO_NOISE_REMOVAL_TYPE {
+
988 OB_NR_LUT = 0, // SPLIT
+
989 OB_NR_OVERALL = 1, // NON_SPLIT
+
990} OBDDONoiseRemovalType,
+
991 ob_ddo_noise_removal_type;
+
992
+
993typedef struct {
+
994 uint16_t max_size;
+
995 uint16_t disp_diff;
+
996 OBDDONoiseRemovalType type;
+
997} OBNoiseRemovalFilterParams, ob_noise_removal_filter_params;
+
998;
+
999
+
1003typedef struct {
+
1007 uint8_t major;
+
1008
+
1012 uint8_t minor;
+
1013
+
1017 uint8_t patch;
+
1018} OBProtocolVersion, ob_protocol_version;
+
1019
+
1023typedef enum {
+
1024 OB_CMD_VERSION_V0 = (uint16_t)0,
+
1025 OB_CMD_VERSION_V1 = (uint16_t)1,
+
1026 OB_CMD_VERSION_V2 = (uint16_t)2,
+
1027 OB_CMD_VERSION_V3 = (uint16_t)3,
+
1028
+
1029 OB_CMD_VERSION_NOVERSION = (uint16_t)0xfffe,
+
1030 OB_CMD_VERSION_INVALID = (uint16_t)0xffff,
+
1031} OB_CMD_VERSION,
+
1032 OBCmdVersion, ob_cmd_version;
+
1033
+
1049typedef struct OBDataBundle {
+
1053 OBCmdVersion cmdVersion;
+
1054
+
1060 void *data;
+
1061
+
1067 uint32_t dataSize;
+
1068
+
1074 uint32_t itemTypeSize;
+
1075
+
1081 uint32_t itemCount;
+
1082} OBDataBundle, ob_data_bundle;
+
1083
+
1087typedef struct {
+
1093 uint16_t dhcp;
+
1094
+
1098 uint8_t address[4];
+
1099
+
1103 uint8_t mask[4];
+
1104
+
1108 uint8_t gateway[4];
+
1109} OBNetIpConfig, ob_net_ip_config, DEVICE_IP_ADDR_CONFIG;
+
1110
+
1111#define OBDeviceIpAddrConfig OBNetIpConfig
+
1112#define ob_device_ip_addr_config OBNetIpConfig
+
1113
+
1117typedef enum {
+
1118 OB_COMM_USB = 0x00,
+
1119 OB_COMM_NET = 0x01,
+
1120} OBCommunicationType,
+
1121 ob_communication_type, OB_COMMUNICATION_TYPE;
+
1122
+
1126typedef enum {
+
1127 OB_USB_POWER_NO_PLUGIN = 0,
+
1128 OB_USB_POWER_5V_0A9 = 1,
+
1129 OB_USB_POWER_5V_1A5 = 2,
+
1130 OB_USB_POWER_5V_3A0 = 3,
+
1131} OBUSBPowerState,
+
1132 ob_usb_power_state;
+
1133
+
1137typedef enum {
+
1138 OB_DC_POWER_NO_PLUGIN = 0,
+
1139 OB_DC_POWER_PLUGIN = 1,
+
1140} OBDCPowerState,
+
1141 ob_dc_power_state;
+
1142
+
1146typedef enum {
+
1147 OB_ROTATE_DEGREE_0 = 0,
+
1148 OB_ROTATE_DEGREE_90 = 90,
+
1149 OB_ROTATE_DEGREE_180 = 180,
+
1150 OB_ROTATE_DEGREE_270 = 270,
+
1151} ob_rotate_degree_type,
+
1152 OBRotateDegreeType;
+
1153
+
1157typedef enum {
+
1158 OB_POWER_LINE_FREQ_MODE_CLOSE = 0,
+
1159 OB_POWER_LINE_FREQ_MODE_50HZ = 1,
+
1160 OB_POWER_LINE_FREQ_MODE_60HZ = 2,
+
1161} ob_power_line_freq_mode,
+
1162 OBPowerLineFreqMode;
+
1163
+
1167typedef enum {
+
1171 OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE = 0,
+
1172
+
1179 OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE,
+
1180
+
1186 OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION,
+
1187} OB_FRAME_AGGREGATE_OUTPUT_MODE,
+
1188 OBFrameAggregateOutputMode, ob_frame_aggregate_output_mode;
+
1189
+
1193typedef enum {
+
1194 OB_LEFT_HAND_COORDINATE_SYSTEM = 0,
+
1195 OB_RIGHT_HAND_COORDINATE_SYSTEM = 1,
+
1196} OB_COORDINATE_SYSTEM_TYPE,
+
1197 OBCoordinateSystemType, ob_coordinate_system_type;
+
1198
+
1202typedef enum {
+
1206 OB_USER_MODE = 0,
+
1207
+
1211 OB_DEVELOPER_MODE = 1,
+
1212} OB_DEVICE_DEVELOPMENT_MODE,
+
1213 OBDeviceDevelopmentMode, ob_device_development_mode;
+
1214
+
1218typedef enum {
+
1219
+
1225 OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN = 1 << 0,
+
1226
+
1232 OB_MULTI_DEVICE_SYNC_MODE_STANDALONE = 1 << 1,
+
1233
+
1241 OB_MULTI_DEVICE_SYNC_MODE_PRIMARY = 1 << 2,
+
1242
+
1254 OB_MULTI_DEVICE_SYNC_MODE_SECONDARY = 1 << 3,
+
1255
+
1267 OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED = 1 << 4,
+
1268
+
1280 OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING = 1 << 5,
+
1281
+
1296 OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING = 1 << 6,
+
1297
+
1298} ob_multi_device_sync_mode,
+
1299 OBMultiDeviceSyncMode;
+
1300
+
1304typedef struct {
+
1308 ob_multi_device_sync_mode syncMode;
+
1309
+
1315 int depthDelayUs;
+
1316
+
1322 int colorDelayUs;
+
1323
+
1332 int trigger2ImageDelayUs;
+
1333
+
1343 bool triggerOutEnable;
+
1344
+
1351 int triggerOutDelayUs;
+
1352
+
1361 int framesPerTrigger;
+
1362} ob_multi_device_sync_config, OBMultiDeviceSyncConfig;
+
1363
+
1368typedef struct {
+
1377 bool enable;
+
1378
+
1382 int timestamp_reset_delay_us;
+
1383
+
1389 bool timestamp_reset_signal_output_enable;
+
1390} ob_device_timestamp_reset_config, OBDeviceTimestampResetConfig;
+
1391
+
1395typedef struct {
+
1399 float baseline;
+
1403 float zpd;
+
1404} BASELINE_CALIBRATION_PARAM, ob_baseline_calibration_param, OBBaselineCalibrationParam;
+
1405
+
1409typedef struct {
+
1410
+
1418 uint8_t enable;
+
1419 uint8_t sequence_name;
+
1420 uint32_t exposure_1;
+
1421 uint32_t gain_1;
+
1422 uint32_t exposure_2;
+
1423 uint32_t gain_2;
+
1424} HDR_CONFIG, ob_hdr_config, OBHdrConfig;
+
1425
+
1429typedef struct {
+
1430 int16_t x0_left;
+
1431 int16_t y0_top;
+
1432 int16_t x1_right;
+
1433 int16_t y1_bottom;
+
1434} AE_ROI, ob_region_of_interest, OBRegionOfInterest;
+
1435
+
1440typedef enum {
+
1446 OB_FRAME_METADATA_TYPE_TIMESTAMP = 0,
+
1447
+
1454 OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP = 1,
+
1455
+
1459 OB_FRAME_METADATA_TYPE_FRAME_NUMBER = 2,
+
1460
+
1465 OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE = 3,
+
1466
+
1472 OB_FRAME_METADATA_TYPE_EXPOSURE = 4,
+
1473
+
1479 OB_FRAME_METADATA_TYPE_GAIN = 5,
+
1480
+
1485 OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE = 6,
+
1486
+
1490 OB_FRAME_METADATA_TYPE_WHITE_BALANCE = 7,
+
1491
+
1495 OB_FRAME_METADATA_TYPE_BRIGHTNESS = 8,
+
1496
+
1500 OB_FRAME_METADATA_TYPE_CONTRAST = 9,
+
1501
+
1505 OB_FRAME_METADATA_TYPE_SATURATION = 10,
+
1506
+
1510 OB_FRAME_METADATA_TYPE_SHARPNESS = 11,
+
1511
+
1515 OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION = 12,
+
1516
+
1520 OB_FRAME_METADATA_TYPE_HUE = 13,
+
1521
+
1525 OB_FRAME_METADATA_TYPE_GAMMA = 14,
+
1526
+
1531 OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY = 15,
+
1532
+
1538 OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION = 16,
+
1539
+
1543 OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE = 17,
+
1544
+
1549 OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE = 18,
+
1550
+
1554 OB_FRAME_METADATA_TYPE_FRAME_RATE = 19,
+
1555
+
1559 OB_FRAME_METADATA_TYPE_AE_ROI_LEFT = 20,
+
1560
+
1564 OB_FRAME_METADATA_TYPE_AE_ROI_TOP = 21,
+
1565
+
1569 OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT = 22,
+
1570
+
1574 OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM = 23,
+
1575
+
1579 OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY = 24,
+
1580
+
1584 OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME = 25,
+
1585
+
1589 OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE = 26,
+
1590
+
1594 OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX = 27,
+
1595
+
1601 OB_FRAME_METADATA_TYPE_LASER_POWER = 28,
+
1602
+
1606 OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL = 29,
+
1607
+
1612 OB_FRAME_METADATA_TYPE_LASER_STATUS = 30,
+
1613
+
1617 OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA = 31,
+
1618
+
1623 OB_FRAME_METADATA_TYPE_COUNT,
+
1624} ob_frame_metadata_type,
+
1625 OBFrameMetadataType;
+
1626
+
1627// For compatibility
+
1628#define OB_FRAME_METADATA_TYPE_LASER_POWER_MODE OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL
+
1629#define OB_FRAME_METADATA_TYPE_EMITTER_MODE OB_FRAME_METADATA_TYPE_LASER_STATUS
+
1630
+
1639typedef void (*ob_file_send_callback)(ob_file_tran_state state, const char *message, uint8_t percent, void *user_data);
+
1640
+
1649typedef void (*ob_device_upgrade_callback)(ob_upgrade_state state, const char *message, uint8_t percent, void *user_data);
+
1650
+
1658typedef void (*ob_device_state_callback)(ob_device_state state, const char *message, void *user_data);
+
1659
+
1667typedef void (*ob_set_data_callback)(ob_data_tran_state state, uint8_t percent, void *user_data);
+
1668
+
1676typedef void (*ob_get_data_callback)(ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data);
+
1677
+
1684typedef void (*ob_media_state_callback)(ob_media_state state, void *user_data);
+
1685
+
1693typedef void (*ob_device_changed_callback)(ob_device_list *removed, ob_device_list *added, void *user_data);
+
1694
+
1695// typedef void (*ob_net_device_added_callback)(const char *added, void *user_data);
+
1696// typedef void (*ob_net_device_removed_callback)(const char *removed, void *user_data);
+
1697
+
1704typedef void (*ob_frame_callback)(ob_frame *frame, void *user_data);
+
1705#define ob_filter_callback ob_frame_callback
+
1706#define ob_playback_callback ob_frame_callback
+
1707
+
1714typedef void (*ob_frameset_callback)(ob_frame *frameset, void *user_data);
+
1715
+
1722typedef void(ob_frame_destroy_callback)(void *buffer, void *user_data);
+
1723
+
1731typedef void(ob_log_callback)(ob_log_severity severity, const char *message, void *user_data);
+
1732
+
1739#define is_ir_sensor(sensor_type) (sensor_type == OB_SENSOR_IR || sensor_type == OB_SENSOR_IR_LEFT || sensor_type == OB_SENSOR_IR_RIGHT)
+
1740#define isIRSensor is_ir_sensor
+
1741
+
1748#define is_ir_stream(stream_type) (stream_type == OB_STREAM_IR || stream_type == OB_STREAM_IR_LEFT || stream_type == OB_STREAM_IR_RIGHT)
+
1749#define isIRStream is_ir_stream
+
1750
+
1757#define is_ir_frame(frame_type) (frame_type == OB_FRAME_IR || frame_type == OB_FRAME_IR_LEFT || frame_type == OB_FRAME_IR_RIGHT)
+
1758#define isIRFrame is_ir_frame
+
1759
+
1763#define OB_DEFAULT_DECRYPT_KEY (nullptr)
+
1764
+
1765#ifdef __cplusplus
+
1766}
+
1767#endif
+
1768
+
1769#pragma pack(pop)
+
OBGyroValue
struct OBAccelValue OBGyroValue
+
ob_d2c_transform
struct OBD2CTransform ob_d2c_transform
+
ob_format
enum OBFormat ob_format
+
ob_media_type
enum OBMediaType ob_media_type
+
ob_get_data_callback
void(* ob_get_data_callback)(ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data)
Callback for reading data.
Definition ObTypes.h:1676
+
OBPowerLineFreqMode
enum ob_power_line_freq_mode OBPowerLineFreqMode
+
ob_point2f
struct OBPoint2f ob_point2f
+
ob_camera_param
struct OBCameraParam ob_camera_param
+
OBSensorType
OBSensorType
Enumeration value describing the sensor type.
Definition ObTypes.h:157
+
OB_SENSOR_IR_RIGHT
@ OB_SENSOR_IR_RIGHT
Definition ObTypes.h:165
+
OB_SENSOR_GYRO
@ OB_SENSOR_GYRO
Definition ObTypes.h:163
+
OB_SENSOR_COLOR
@ OB_SENSOR_COLOR
Definition ObTypes.h:160
+
OB_SENSOR_UNKNOWN
@ OB_SENSOR_UNKNOWN
Definition ObTypes.h:158
+
OB_SENSOR_IR
@ OB_SENSOR_IR
Definition ObTypes.h:159
+
OB_SENSOR_DEPTH
@ OB_SENSOR_DEPTH
Definition ObTypes.h:161
+
OB_SENSOR_COUNT
@ OB_SENSOR_COUNT
Definition ObTypes.h:167
+
OB_SENSOR_IR_LEFT
@ OB_SENSOR_IR_LEFT
Definition ObTypes.h:164
+
OB_SENSOR_ACCEL
@ OB_SENSOR_ACCEL
Definition ObTypes.h:162
+
OB_SENSOR_RAW_PHASE
@ OB_SENSOR_RAW_PHASE
Definition ObTypes.h:166
+
ob_sync_mode
enum OBSyncMode ob_sync_mode
+
ob_upgrade_state
enum OBUpgradeState ob_upgrade_state
+
ob_device_changed_callback
void(* ob_device_changed_callback)(ob_device_list *removed, ob_device_list *added, void *user_data)
Callback for device change.
Definition ObTypes.h:1693
+
ob_sequence_id_item
struct OBSequenceIdItem ob_sequence_id_item
+
ob_pipeline
struct PipelineImpl ob_pipeline
Definition ObTypes.h:65
+
ob_dc_power_state
enum OBDCPowerState ob_dc_power_state
+
ob_color_point
struct OBColorPoint ob_color_point
+
OB_DEVICE_SYNC_CONFIG
struct OBDeviceSyncConfig OB_DEVICE_SYNC_CONFIG
+
OBPoint3f
struct OBPoint OBPoint3f
+
OBStatus
OBStatus
error code
Definition ObTypes.h:106
+
OB_STATUS_OK
@ OB_STATUS_OK
Definition ObTypes.h:107
+
OB_STATUS_ERROR
@ OB_STATUS_ERROR
Definition ObTypes.h:108
+
ob_filter_list
struct FilterListImpl ob_filter_list
Definition ObTypes.h:70
+
ob_ddo_noise_removal_type
enum OB_DDO_NOISE_REMOVAL_TYPE ob_ddo_noise_removal_type
+
OBGyroFullScaleRange
OBGyroFullScaleRange
Enumeration of gyroscope ranges.
Definition ObTypes.h:600
+
OB_GYRO_FS_500dps
@ OB_GYRO_FS_500dps
Definition ObTypes.h:606
+
OB_GYRO_FS_250dps
@ OB_GYRO_FS_250dps
Definition ObTypes.h:605
+
OB_GYRO_FS_62dps
@ OB_GYRO_FS_62dps
Definition ObTypes.h:603
+
OB_GYRO_FS_16dps
@ OB_GYRO_FS_16dps
Definition ObTypes.h:601
+
OB_GYRO_FS_125dps
@ OB_GYRO_FS_125dps
Definition ObTypes.h:604
+
OB_GYRO_FS_1000dps
@ OB_GYRO_FS_1000dps
Definition ObTypes.h:607
+
OB_GYRO_FS_31dps
@ OB_GYRO_FS_31dps
Definition ObTypes.h:602
+
OB_GYRO_FS_2000dps
@ OB_GYRO_FS_2000dps
Definition ObTypes.h:608
+
ob_baseline_calibration_param
struct BASELINE_CALIBRATION_PARAM ob_baseline_calibration_param
+
OBEdgeNoiseRemovalType
enum OB_EDGE_NOISE_REMOVAL_TYPE OBEdgeNoiseRemovalType
+
OBDeviceLogSeverityLevel
enum OBLogSeverity OBDeviceLogSeverityLevel
+
ob_xy_tables
struct OBXYTables ob_xy_tables
+
OBDeviceState
uint64_t OBDeviceState
Device state.
Definition ObTypes.h:635
+
ob_playback
struct PlaybackImpl ob_playback
Definition ObTypes.h:68
+
DEVICE_TEMPERATURE
struct OBDeviceTemperature DEVICE_TEMPERATURE
+
ob_exception_type
enum OBExceptionType ob_exception_type
+
ob_frame_aggregate_output_mode
enum OB_FRAME_AGGREGATE_OUTPUT_MODE ob_frame_aggregate_output_mode
+
ob_gyro_sample_rate
enum OBGyroSampleRate ob_gyro_sample_rate
+
ob_power_line_freq_mode
ob_power_line_freq_mode
Power line frequency mode, for color camera anti-flicker configuration.
Definition ObTypes.h:1157
+
OB_POWER_LINE_FREQ_MODE_60HZ
@ OB_POWER_LINE_FREQ_MODE_60HZ
60Hz
Definition ObTypes.h:1160
+
OB_POWER_LINE_FREQ_MODE_50HZ
@ OB_POWER_LINE_FREQ_MODE_50HZ
50Hz
Definition ObTypes.h:1159
+
OB_POWER_LINE_FREQ_MODE_CLOSE
@ OB_POWER_LINE_FREQ_MODE_CLOSE
Close.
Definition ObTypes.h:1158
+
ob_frame
struct CFrameImpl ob_frame
Definition ObTypes.h:63
+
OBMediaState
OBMediaState
Enumeration for record playback status.
Definition ObTypes.h:697
+
OB_MEDIA_BEGIN
@ OB_MEDIA_BEGIN
Definition ObTypes.h:698
+
OB_MEDIA_RESUME
@ OB_MEDIA_RESUME
Definition ObTypes.h:700
+
OB_MEDIA_END
@ OB_MEDIA_END
Definition ObTypes.h:701
+
OB_MEDIA_PAUSE
@ OB_MEDIA_PAUSE
Definition ObTypes.h:699
+
OBFormat
OBFormat
Enumeration value describing the pixel format.
Definition ObTypes.h:210
+
OB_FORMAT_YUYV
@ OB_FORMAT_YUYV
Definition ObTypes.h:211
+
OB_FORMAT_Y11
@ OB_FORMAT_Y11
Definition ObTypes.h:222
+
OB_FORMAT_ACCEL
@ OB_FORMAT_ACCEL
Definition ObTypes.h:227
+
OB_FORMAT_Y16
@ OB_FORMAT_Y16
Definition ObTypes.h:219
+
OB_FORMAT_RGB_POINT
@ OB_FORMAT_RGB_POINT
Definition ObTypes.h:230
+
OB_FORMAT_BA81
@ OB_FORMAT_BA81
Definition ObTypes.h:240
+
OB_FORMAT_YV12
@ OB_FORMAT_YV12
Definition ObTypes.h:239
+
OB_FORMAT_RGBA
@ OB_FORMAT_RGBA
Definition ObTypes.h:241
+
OB_FORMAT_BGR
@ OB_FORMAT_BGR
Definition ObTypes.h:233
+
OB_FORMAT_Z16
@ OB_FORMAT_Z16
Definition ObTypes.h:238
+
OB_FORMAT_Y12
@ OB_FORMAT_Y12
Definition ObTypes.h:223
+
OB_FORMAT_BGRA
@ OB_FORMAT_BGRA
Definition ObTypes.h:235
+
OB_FORMAT_NV21
@ OB_FORMAT_NV21
Definition ObTypes.h:215
+
OB_FORMAT_RGB
@ OB_FORMAT_RGB
Definition ObTypes.h:232
+
OB_FORMAT_UNKNOWN
@ OB_FORMAT_UNKNOWN
Definition ObTypes.h:245
+
OB_FORMAT_Y10
@ OB_FORMAT_Y10
Definition ObTypes.h:221
+
OB_FORMAT_H265
@ OB_FORMAT_H265
Definition ObTypes.h:218
+
OB_FORMAT_DISP16
@ OB_FORMAT_DISP16
Definition ObTypes.h:244
+
OB_FORMAT_UYVY
@ OB_FORMAT_UYVY
Definition ObTypes.h:213
+
OB_FORMAT_Y14
@ OB_FORMAT_Y14
Definition ObTypes.h:234
+
OB_FORMAT_I420
@ OB_FORMAT_I420
Definition ObTypes.h:226
+
OB_FORMAT_YUY2
@ OB_FORMAT_YUY2
Definition ObTypes.h:212
+
OB_FORMAT_BYR2
@ OB_FORMAT_BYR2
Definition ObTypes.h:242
+
OB_FORMAT_RLE
@ OB_FORMAT_RLE
Definition ObTypes.h:231
+
OB_FORMAT_MJPG
@ OB_FORMAT_MJPG
Definition ObTypes.h:216
+
OB_FORMAT_COMPRESSED
@ OB_FORMAT_COMPRESSED
Definition ObTypes.h:236
+
OB_FORMAT_GRAY
@ OB_FORMAT_GRAY
Definition ObTypes.h:224
+
OB_FORMAT_H264
@ OB_FORMAT_H264
Definition ObTypes.h:217
+
OB_FORMAT_POINT
@ OB_FORMAT_POINT
Definition ObTypes.h:229
+
OB_FORMAT_RVL
@ OB_FORMAT_RVL
Definition ObTypes.h:237
+
OB_FORMAT_RW16
@ OB_FORMAT_RW16
Definition ObTypes.h:243
+
OB_FORMAT_GYRO
@ OB_FORMAT_GYRO
Definition ObTypes.h:228
+
OB_FORMAT_Y8
@ OB_FORMAT_Y8
Definition ObTypes.h:220
+
OB_FORMAT_NV12
@ OB_FORMAT_NV12
Definition ObTypes.h:214
+
OB_FORMAT_HEVC
@ OB_FORMAT_HEVC
Definition ObTypes.h:225
+
OBHPStatusCode
OBHPStatusCode
send data or receive data return status type
Definition ObTypes.h:83
+
HP_STATUS_OK
@ HP_STATUS_OK
Definition ObTypes.h:84
+
HP_STATUS_CONTROL_TRANSFER_FAILED
@ HP_STATUS_CONTROL_TRANSFER_FAILED
Definition ObTypes.h:86
+
HP_STATUS_NO_DEVICE_FOUND
@ HP_STATUS_NO_DEVICE_FOUND
Definition ObTypes.h:85
+
HP_STATUS_UNKNOWN_ERROR
@ HP_STATUS_UNKNOWN_ERROR
Definition ObTypes.h:87
+
ob_rect
struct OBRect ob_rect
+
OBAccelSampleRate
enum OBGyroSampleRate OBAccelSampleRate
+
OBCameraDistortionModel
OBCameraDistortionModel
Distortion model: defines how pixel coordinates should be mapped to sensor coordinates.
Definition ObTypes.h:423
+
OB_DISTORTION_INVERSE_BROWN_CONRADY
@ OB_DISTORTION_INVERSE_BROWN_CONRADY
Definition ObTypes.h:427
+
OB_DISTORTION_BROWN_CONRADY
@ OB_DISTORTION_BROWN_CONRADY
Definition ObTypes.h:428
+
OB_DISTORTION_MODIFIED_BROWN_CONRADY
@ OB_DISTORTION_MODIFIED_BROWN_CONRADY
Definition ObTypes.h:425
+
OB_DISTORTION_NONE
@ OB_DISTORTION_NONE
Definition ObTypes.h:424
+
ob_noise_removal_filter_params
struct OBNoiseRemovalFilterParams ob_noise_removal_filter_params
+
ob_gyro_full_scale_range
enum OBGyroFullScaleRange ob_gyro_full_scale_range
+
ob_data_bundle
struct OBDataBundle ob_data_bundle
+
OBDataTranState
OBDataTranState
Enumeration value describing the data transfer status.
Definition ObTypes.h:292
+
DATA_TRAN_ERR_TRAN_FAILED
@ DATA_TRAN_ERR_TRAN_FAILED
Definition ObTypes.h:300
+
DATA_TRAN_STAT_VERIFYING
@ DATA_TRAN_STAT_VERIFYING
Definition ObTypes.h:296
+
DATA_TRAN_STAT_TRANSFERRING
@ DATA_TRAN_STAT_TRANSFERRING
Definition ObTypes.h:297
+
DATA_TRAN_ERR_OTHER
@ DATA_TRAN_ERR_OTHER
Definition ObTypes.h:302
+
DATA_TRAN_ERR_VERIFY_FAILED
@ DATA_TRAN_ERR_VERIFY_FAILED
Definition ObTypes.h:301
+
DATA_TRAN_ERR_UNSUPPORTED
@ DATA_TRAN_ERR_UNSUPPORTED
Definition ObTypes.h:299
+
DATA_TRAN_STAT_DONE
@ DATA_TRAN_STAT_DONE
Definition ObTypes.h:295
+
DATA_TRAN_ERR_BUSY
@ DATA_TRAN_ERR_BUSY
Definition ObTypes.h:298
+
DATA_TRAN_STAT_VERIFY_DONE
@ DATA_TRAN_STAT_VERIFY_DONE
Definition ObTypes.h:293
+
DATA_TRAN_STAT_STOPPED
@ DATA_TRAN_STAT_STOPPED
Definition ObTypes.h:294
+
OBGyroSampleRate
OBGyroSampleRate
Enumeration of IMU sample rate values (gyroscope or accelerometer)
Definition ObTypes.h:578
+
OB_SAMPLE_RATE_100_HZ
@ OB_SAMPLE_RATE_100_HZ
Definition ObTypes.h:585
+
OB_SAMPLE_RATE_4_KHZ
@ OB_SAMPLE_RATE_4_KHZ
Definition ObTypes.h:590
+
OB_SAMPLE_RATE_3_125_HZ
@ OB_SAMPLE_RATE_3_125_HZ
Definition ObTypes.h:580
+
OB_SAMPLE_RATE_6_25_HZ
@ OB_SAMPLE_RATE_6_25_HZ
Definition ObTypes.h:581
+
OB_SAMPLE_RATE_500_HZ
@ OB_SAMPLE_RATE_500_HZ
Definition ObTypes.h:587
+
OB_SAMPLE_RATE_32_KHZ
@ OB_SAMPLE_RATE_32_KHZ
Definition ObTypes.h:593
+
OB_SAMPLE_RATE_50_HZ
@ OB_SAMPLE_RATE_50_HZ
Definition ObTypes.h:584
+
OB_SAMPLE_RATE_1_5625_HZ
@ OB_SAMPLE_RATE_1_5625_HZ
Definition ObTypes.h:579
+
OB_SAMPLE_RATE_12_5_HZ
@ OB_SAMPLE_RATE_12_5_HZ
Definition ObTypes.h:582
+
OB_SAMPLE_RATE_1_KHZ
@ OB_SAMPLE_RATE_1_KHZ
Definition ObTypes.h:588
+
OB_SAMPLE_RATE_200_HZ
@ OB_SAMPLE_RATE_200_HZ
Definition ObTypes.h:586
+
OB_SAMPLE_RATE_2_KHZ
@ OB_SAMPLE_RATE_2_KHZ
Definition ObTypes.h:589
+
OB_SAMPLE_RATE_25_HZ
@ OB_SAMPLE_RATE_25_HZ
Definition ObTypes.h:583
+
OB_SAMPLE_RATE_16_KHZ
@ OB_SAMPLE_RATE_16_KHZ
Definition ObTypes.h:592
+
OB_SAMPLE_RATE_8_KHZ
@ OB_SAMPLE_RATE_8_KHZ
Definition ObTypes.h:591
+
OBHdrConfig
struct HDR_CONFIG OBHdrConfig
+
OB_DEPTH_CROPPING_MODE
enum OBDepthCroppingMode OB_DEPTH_CROPPING_MODE
+
ob_accel_intrinsic
struct OBAccelIntrinsic ob_accel_intrinsic
+
ob_device
struct DeviceImpl ob_device
Definition ObTypes.h:55
+
OBTofFilterRange
OBTofFilterRange
Enumeration for TOF filter scene ranges.
Definition ObTypes.h:726
+
OB_TOF_FILTER_RANGE_LONG
@ OB_TOF_FILTER_RANGE_LONG
Definition ObTypes.h:729
+
OB_TOF_FILTER_RANGE_CLOSE
@ OB_TOF_FILTER_RANGE_CLOSE
Definition ObTypes.h:727
+
OB_TOF_FILTER_RANGE_MIDDLE
@ OB_TOF_FILTER_RANGE_MIDDLE
Definition ObTypes.h:728
+
OB_TOF_FILTER_RANGE_DEBUG
@ OB_TOF_FILTER_RANGE_DEBUG
Definition ObTypes.h:730
+
OBMultiDeviceSyncMode
enum ob_multi_device_sync_mode OBMultiDeviceSyncMode
+
OBFrameMetadataType
enum ob_frame_metadata_type OBFrameMetadataType
+
ob_device_info
struct DeviceInfoImpl ob_device_info
Definition ObTypes.h:56
+
OBFrameType
OBFrameType
Enumeration value describing the type of frame.
Definition ObTypes.h:191
+
OB_FRAME_IR_RIGHT
@ OB_FRAME_IR_RIGHT
Definition ObTypes.h:202
+
OB_FRAME_ACCEL
@ OB_FRAME_ACCEL
Definition ObTypes.h:197
+
OB_FRAME_GYRO
@ OB_FRAME_GYRO
Definition ObTypes.h:200
+
OB_FRAME_IR_LEFT
@ OB_FRAME_IR_LEFT
Definition ObTypes.h:201
+
OB_FRAME_VIDEO
@ OB_FRAME_VIDEO
Definition ObTypes.h:193
+
OB_FRAME_COLOR
@ OB_FRAME_COLOR
Definition ObTypes.h:195
+
OB_FRAME_UNKNOWN
@ OB_FRAME_UNKNOWN
Definition ObTypes.h:192
+
OB_FRAME_RAW_PHASE
@ OB_FRAME_RAW_PHASE
Definition ObTypes.h:203
+
OB_FRAME_SET
@ OB_FRAME_SET
Definition ObTypes.h:198
+
OB_FRAME_POINTS
@ OB_FRAME_POINTS
Definition ObTypes.h:199
+
OB_FRAME_IR
@ OB_FRAME_IR
Definition ObTypes.h:194
+
OB_FRAME_DEPTH
@ OB_FRAME_DEPTH
Definition ObTypes.h:196
+
OBStreamType
OBStreamType
Enumeration value describing the type of data stream.
Definition ObTypes.h:174
+
OB_STREAM_RAW_PHASE
@ OB_STREAM_RAW_PHASE
Definition ObTypes.h:184
+
OB_STREAM_GYRO
@ OB_STREAM_GYRO
Definition ObTypes.h:181
+
OB_STREAM_UNKNOWN
@ OB_STREAM_UNKNOWN
Definition ObTypes.h:175
+
OB_STREAM_IR
@ OB_STREAM_IR
Definition ObTypes.h:177
+
OB_STREAM_DEPTH
@ OB_STREAM_DEPTH
Definition ObTypes.h:179
+
OB_STREAM_IR_RIGHT
@ OB_STREAM_IR_RIGHT
Definition ObTypes.h:183
+
OB_STREAM_IR_LEFT
@ OB_STREAM_IR_LEFT
Definition ObTypes.h:182
+
OB_STREAM_VIDEO
@ OB_STREAM_VIDEO
Definition ObTypes.h:176
+
OB_STREAM_ACCEL
@ OB_STREAM_ACCEL
Definition ObTypes.h:180
+
OB_STREAM_COLOR
@ OB_STREAM_COLOR
Definition ObTypes.h:178
+
ob_compression_mode
enum OBCompressionMode ob_compression_mode
+
OBDeviceType
OBDeviceType
Enumeration for device types.
Definition ObTypes.h:667
+
OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA
@ OB_STRUCTURED_LIGHT_MONOCULAR_CAMERA
Definition ObTypes.h:668
+
OB_TOF_CAMERA
@ OB_TOF_CAMERA
Definition ObTypes.h:670
+
OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA
@ OB_STRUCTURED_LIGHT_BINOCULAR_CAMERA
Definition ObTypes.h:669
+
ob_device_type
enum OBDeviceType ob_device_type
+
ob_file_send_callback
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:1639
+
ob_device_development_mode
enum OB_DEVICE_DEVELOPMENT_MODE ob_device_development_mode
+
OBBaselineCalibrationParam
struct BASELINE_CALIBRATION_PARAM OBBaselineCalibrationParam
+
OB_COMPRESSION_PARAMS
struct OBCompressionParams OB_COMPRESSION_PARAMS
+
ob_cmd_version
enum OB_CMD_VERSION ob_cmd_version
+
ob_stream_profile_list
struct StreamProfileListImpl ob_stream_profile_list
Definition ObTypes.h:62
+
ob_sensor_list
struct SensorListImpl ob_sensor_list
Definition ObTypes.h:60
+
OB_ACCEL_FULL_SCALE_RANGE
enum OBAccelFullScaleRange OB_ACCEL_FULL_SCALE_RANGE
+
OB_DEPTH_PRECISION_LEVEL
enum OBDepthPrecisionLevel OB_DEPTH_PRECISION_LEVEL
+
ob_config
struct ConfigImpl ob_config
Definition ObTypes.h:66
+
ob_region_of_interest
struct AE_ROI ob_region_of_interest
+
OBDepthCroppingMode
OBDepthCroppingMode
Enumeration for depth crop modes.
Definition ObTypes.h:657
+
DEPTH_CROPPING_MODE_AUTO
@ DEPTH_CROPPING_MODE_AUTO
Definition ObTypes.h:658
+
DEPTH_CROPPING_MODE_OPEN
@ DEPTH_CROPPING_MODE_OPEN
Definition ObTypes.h:660
+
DEPTH_CROPPING_MODE_CLOSE
@ DEPTH_CROPPING_MODE_CLOSE
Definition ObTypes.h:659
+
ob_edge_noise_removal_filter_params
struct OBEdgeNoiseRemovalFilterParams ob_edge_noise_removal_filter_params
+
ob_camera_distortion
struct OBCameraDistortion ob_camera_distortion
+
ob_hole_filling_mode
enum OBHoleFillingMode ob_hole_filling_mode
+
OBDDONoiseRemovalType
enum OB_DDO_NOISE_REMOVAL_TYPE OBDDONoiseRemovalType
去噪方式
+
TOF_FILTER_RANGE
enum OBTofFilterRange TOF_FILTER_RANGE
+
ob_net_ip_config
struct OBNetIpConfig ob_net_ip_config
+
ob_log_severity
enum OBLogSeverity ob_log_severity
+
OBExceptionType
OBExceptionType
The exception types in the SDK, through the exception type, you can easily determine the specific typ...
Definition ObTypes.h:129
+
OB_EXCEPTION_TYPE_PLATFORM
@ OB_EXCEPTION_TYPE_PLATFORM
Definition ObTypes.h:132
+
OB_EXCEPTION_TYPE_UNKNOWN
@ OB_EXCEPTION_TYPE_UNKNOWN
Definition ObTypes.h:130
+
OB_EXCEPTION_TYPE_NOT_IMPLEMENTED
@ OB_EXCEPTION_TYPE_NOT_IMPLEMENTED
Definition ObTypes.h:136
+
OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE
@ OB_EXCEPTION_TYPE_WRONG_API_CALL_SEQUENCE
Definition ObTypes.h:135
+
OB_EXCEPTION_TYPE_INVALID_VALUE
@ OB_EXCEPTION_TYPE_INVALID_VALUE
Definition ObTypes.h:134
+
OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION
@ OB_EXCEPTION_TYPE_UNSUPPORTED_OPERATION
Definition ObTypes.h:139
+
OB_EXCEPTION_TYPE_IO
@ OB_EXCEPTION_TYPE_IO
Definition ObTypes.h:137
+
OB_EXCEPTION_TYPE_MEMORY
@ OB_EXCEPTION_TYPE_MEMORY
Definition ObTypes.h:138
+
OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED
@ OB_EXCEPTION_TYPE_CAMERA_DISCONNECTED
Definition ObTypes.h:131
+
ob_accel_value
struct OBAccelValue ob_accel_value
+
ob_compression_params
struct OBCompressionParams ob_compression_params
+
ob_align_mode
enum OBAlignMode ob_align_mode
+
OBAccelFullScaleRange
OBAccelFullScaleRange
Enumeration of accelerometer ranges.
Definition ObTypes.h:615
+
OB_ACCEL_FS_4g
@ OB_ACCEL_FS_4g
Definition ObTypes.h:617
+
OB_ACCEL_FS_16g
@ OB_ACCEL_FS_16g
Definition ObTypes.h:619
+
OB_ACCEL_FS_2g
@ OB_ACCEL_FS_2g
Definition ObTypes.h:616
+
OB_ACCEL_FS_8g
@ OB_ACCEL_FS_8g
Definition ObTypes.h:618
+
OBMarginFilterConfig
struct ob_margin_filter_config OBMarginFilterConfig
+
ob_coordinate_system_type
enum OB_COORDINATE_SYSTEM_TYPE ob_coordinate_system_type
+
ob_calibration_param
struct OBCalibrationParam ob_calibration_param
+
ob_device_upgrade_callback
void(* ob_device_upgrade_callback)(ob_upgrade_state state, const char *message, uint8_t percent, void *user_data)
Callback for firmware upgrade.
Definition ObTypes.h:1649
+
ob_log_callback
void() ob_log_callback(ob_log_severity severity, const char *message, void *user_data)
Callback for receiving log.
Definition ObTypes.h:1731
+
ob_device_log_severity_level
enum OBLogSeverity ob_device_log_severity_level
+
ob_file_tran_state
enum OBFileTranState ob_file_tran_state
+
OB_CMD_VERSION
OB_CMD_VERSION
Command version associated with property id.
Definition ObTypes.h:1023
+
OB_CMD_VERSION_NOVERSION
@ OB_CMD_VERSION_NOVERSION
Definition ObTypes.h:1029
+
OB_CMD_VERSION_V0
@ OB_CMD_VERSION_V0
Version 1.0.
Definition ObTypes.h:1024
+
OB_CMD_VERSION_V1
@ OB_CMD_VERSION_V1
Version 2.0.
Definition ObTypes.h:1025
+
OB_CMD_VERSION_INVALID
@ OB_CMD_VERSION_INVALID
Invalid version.
Definition ObTypes.h:1030
+
OB_CMD_VERSION_V3
@ OB_CMD_VERSION_V3
Version 4.0.
Definition ObTypes.h:1027
+
OB_CMD_VERSION_V2
@ OB_CMD_VERSION_V2
Version 3.0.
Definition ObTypes.h:1026
+
ob_device_preset_list
struct DevicePresetListImpl ob_device_preset_list
Definition ObTypes.h:72
+
ob_frame_destroy_callback
void() ob_frame_destroy_callback(void *buffer, void *user_data)
Customize the delete callback.
Definition ObTypes.h:1722
+
ob_communication_type
enum OBCommunicationType ob_communication_type
+
OBFileTranState
OBFileTranState
Enumeration value describing the file transfer status.
Definition ObTypes.h:276
+
FILE_TRAN_ERR_DDR
@ FILE_TRAN_ERR_DDR
Definition ObTypes.h:280
+
FILE_TRAN_STAT_DONE
@ FILE_TRAN_STAT_DONE
Definition ObTypes.h:278
+
FILE_TRAN_ERR_MD5_ERROR
@ FILE_TRAN_ERR_MD5_ERROR
Definition ObTypes.h:283
+
FILE_TRAN_ERR_NOT_ENOUGH_SPACE
@ FILE_TRAN_ERR_NOT_ENOUGH_SPACE
Definition ObTypes.h:281
+
FILE_TRAN_ERR_WRITE_FLASH_ERROR
@ FILE_TRAN_ERR_WRITE_FLASH_ERROR
Definition ObTypes.h:284
+
FILE_TRAN_ERR_PATH_NOT_WRITABLE
@ FILE_TRAN_ERR_PATH_NOT_WRITABLE
Definition ObTypes.h:282
+
FILE_TRAN_ERR_TIMEOUT
@ FILE_TRAN_ERR_TIMEOUT
Definition ObTypes.h:285
+
FILE_TRAN_STAT_PREPAR
@ FILE_TRAN_STAT_PREPAR
Definition ObTypes.h:279
+
FILE_TRAN_STAT_TRANSFER
@ FILE_TRAN_STAT_TRANSFER
Definition ObTypes.h:277
+
OBCommunicationType
OBCommunicationType
Device communication mode.
Definition ObTypes.h:1117
+
OB_COMM_NET
@ OB_COMM_NET
Ethernet.
Definition ObTypes.h:1119
+
OB_COMM_USB
@ OB_COMM_USB
USB.
Definition ObTypes.h:1118
+
ob_usb_power_state
enum OBUSBPowerState ob_usb_power_state
+
ob_tof_filter_range
enum OBTofFilterRange ob_tof_filter_range
+
ob_device_temperature
struct OBDeviceTemperature ob_device_temperature
+
ob_data_chunk
struct OBDataChunk ob_data_chunk
+
ob_uint8_property_range
struct OBUint8PropertyRange ob_uint8_property_range
+
ob_device_list
struct DeviceListImpl ob_device_list
Definition ObTypes.h:57
+
ob_sensor
struct SensorImpl ob_sensor
Definition ObTypes.h:59
+
ob_convert_format
enum OBConvertFormat ob_convert_format
+
ob_stream_type
enum OBStreamType ob_stream_type
+
ob_data_tran_state
enum OBDataTranState ob_data_tran_state
+
OBSyncMode
OBSyncMode
Sync mode.
Definition ObTypes.h:800
+
OB_SYNC_MODE_STANDALONE
@ OB_SYNC_MODE_STANDALONE
Standalone synchronize mode.
Definition ObTypes.h:813
+
OB_SYNC_MODE_CLOSE
@ OB_SYNC_MODE_CLOSE
Close synchronize mode.
Definition ObTypes.h:806
+
OB_SYNC_MODE_PRIMARY
@ OB_SYNC_MODE_PRIMARY
Primary synchronize mode.
Definition ObTypes.h:820
+
OB_SYNC_MODE_PRIMARY_MCU_TRIGGER
@ OB_SYNC_MODE_PRIMARY_MCU_TRIGGER
MCU Primary synchronize mode.
Definition ObTypes.h:837
+
OB_SYNC_MODE_SECONDARY
@ OB_SYNC_MODE_SECONDARY
Secondary synchronize mode.
Definition ObTypes.h:830
+
OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER
@ OB_SYNC_MODE_PRIMARY_SOFT_TRIGGER
Software trigger synchronize mode.
Definition ObTypes.h:853
+
OB_SYNC_MODE_PRIMARY_IR_TRIGGER
@ OB_SYNC_MODE_PRIMARY_IR_TRIGGER
IR Primary synchronize mode.
Definition ObTypes.h:844
+
OB_SYNC_MODE_UNKNOWN
@ OB_SYNC_MODE_UNKNOWN
Unknown type.
Definition ObTypes.h:866
+
OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER
@ OB_SYNC_MODE_SECONDARY_SOFT_TRIGGER
Software trigger synchronize mode as secondary device.
Definition ObTypes.h:861
+
ob_gyro_value
struct OBAccelValue ob_gyro_value
+
OBDeviceDevelopmentMode
enum OB_DEVICE_DEVELOPMENT_MODE OBDeviceDevelopmentMode
+
ob_point
struct OBPoint ob_point
+
ob_spatial_advanced_filter_params
struct OBSpatialAdvancedFilterParams ob_spatial_advanced_filter_params
+
ob_accel_sample_rate
enum OBGyroSampleRate ob_accel_sample_rate
+
ob_tof_exposure_threshold_control
struct OBTofExposureThresholdControl ob_tof_exposure_threshold_control
+
ob_recorder
struct RecorderImpl ob_recorder
Definition ObTypes.h:67
+
ob_depth_work_mode
struct OBDepthWorkMode ob_depth_work_mode
+
ob_hp_status_code
enum OBHPStatusCode ob_hp_status_code
+
OBDeviceTimestampResetConfig
struct ob_device_timestamp_reset_config OBDeviceTimestampResetConfig
+
OBCoordinateSystemType
enum OB_COORDINATE_SYSTEM_TYPE OBCoordinateSystemType
+
OB_COMPRESSION_MODE
enum OBCompressionMode OB_COMPRESSION_MODE
+
ob_hdr_config
struct HDR_CONFIG ob_hdr_config
+
OBExtrinsic
struct OBD2CTransform OBExtrinsic
+
OB_MEDIA_STATE_EM
enum OBMediaState OB_MEDIA_STATE_EM
+
ob_float_property_range
struct OBFloatPropertyRange ob_float_property_range
+
OBFrameAggregateOutputMode
enum OB_FRAME_AGGREGATE_OUTPUT_MODE OBFrameAggregateOutputMode
+
OB_FRAME_AGGREGATE_OUTPUT_MODE
OB_FRAME_AGGREGATE_OUTPUT_MODE
Frame aggregate output mode.
Definition ObTypes.h:1167
+
OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE
@ OB_FRAME_AGGREGATE_OUTPUT_COLOR_FRAME_REQUIRE
Color Frame Require output mode.
Definition ObTypes.h:1179
+
OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE
@ OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE
Only FrameSet that contains all types of data frames will be output.
Definition ObTypes.h:1171
+
OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION
@ OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION
FrameSet for any case will be output.
Definition ObTypes.h:1186
+
OB_EDGE_NOISE_REMOVAL_TYPE
OB_EDGE_NOISE_REMOVAL_TYPE
Definition ObTypes.h:968
+
OB_MGA_FILTER
@ OB_MGA_FILTER
Definition ObTypes.h:971
+
OB_MGC_FILTER
@ OB_MGC_FILTER
Definition ObTypes.h:972
+
OB_MGH_FILTER
@ OB_MGH_FILTER
Definition ObTypes.h:970
+
OB_MG_FILTER
@ OB_MG_FILTER
Definition ObTypes.h:969
+
ob_bool_property_range
struct OBBoolPropertyRange ob_bool_property_range
+
OB_DEVICE_DEVELOPMENT_MODE
OB_DEVICE_DEVELOPMENT_MODE
Enumeration of device development modes.
Definition ObTypes.h:1202
+
OB_USER_MODE
@ OB_USER_MODE
User mode (default mode), which provides full camera device functionality.
Definition ObTypes.h:1206
+
OB_DEVELOPER_MODE
@ OB_DEVELOPER_MODE
Developer mode, which allows developers to access the operating system and software/hardware resource...
Definition ObTypes.h:1211
+
ob_device_sync_config
struct OBDeviceSyncConfig ob_device_sync_config
+
OBMultiDeviceSyncConfig
struct ob_multi_device_sync_config OBMultiDeviceSyncConfig
+
ob_edge_noise_removal_type
enum OB_EDGE_NOISE_REMOVAL_TYPE ob_edge_noise_removal_type
+
ob_stream_profile
struct StreamProfileImpl ob_stream_profile
Definition ObTypes.h:61
+
OB_DDO_NOISE_REMOVAL_TYPE
OB_DDO_NOISE_REMOVAL_TYPE
去噪方式
Definition ObTypes.h:987
+
OB_NR_OVERALL
@ OB_NR_OVERALL
Definition ObTypes.h:989
+
OB_NR_LUT
@ OB_NR_LUT
Definition ObTypes.h:988
+
ob_filter
struct FilterImpl ob_filter
Definition ObTypes.h:64
+
ob_multi_device_sync_mode
ob_multi_device_sync_mode
The synchronization mode of the device.
Definition ObTypes.h:1218
+
OB_MULTI_DEVICE_SYNC_MODE_SECONDARY
@ OB_MULTI_DEVICE_SYNC_MODE_SECONDARY
secondary mode
Definition ObTypes.h:1254
+
OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING
@ OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING
software triggering mode
Definition ObTypes.h:1280
+
OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING
@ OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING
hardware triggering mode
Definition ObTypes.h:1296
+
OB_MULTI_DEVICE_SYNC_MODE_STANDALONE
@ OB_MULTI_DEVICE_SYNC_MODE_STANDALONE
standalone mode
Definition ObTypes.h:1232
+
OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED
@ OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED
secondary synced mode
Definition ObTypes.h:1267
+
OB_MULTI_DEVICE_SYNC_MODE_PRIMARY
@ OB_MULTI_DEVICE_SYNC_MODE_PRIMARY
primary mode
Definition ObTypes.h:1241
+
OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN
@ OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN
free run mode
Definition ObTypes.h:1225
+
OBPermissionType
OBPermissionType
the permission type of api or property
Definition ObTypes.h:94
+
OB_PERMISSION_DENY
@ OB_PERMISSION_DENY
Definition ObTypes.h:95
+
OB_PERMISSION_ANY
@ OB_PERMISSION_ANY
Definition ObTypes.h:99
+
OB_PERMISSION_READ
@ OB_PERMISSION_READ
Definition ObTypes.h:96
+
OB_PERMISSION_READ_WRITE
@ OB_PERMISSION_READ_WRITE
Definition ObTypes.h:98
+
OB_PERMISSION_WRITE
@ OB_PERMISSION_WRITE
Definition ObTypes.h:97
+
OBRegionOfInterest
struct AE_ROI OBRegionOfInterest
+
OBCompressionMode
OBCompressionMode
Compression mode.
Definition ObTypes.h:772
+
OB_COMPRESSION_LOSSY
@ OB_COMPRESSION_LOSSY
Definition ObTypes.h:774
+
OB_COMPRESSION_LOSSLESS
@ OB_COMPRESSION_LOSSLESS
Definition ObTypes.h:773
+
OBDCPowerState
OBDCPowerState
DC power status.
Definition ObTypes.h:1137
+
OB_DC_POWER_PLUGIN
@ OB_DC_POWER_PLUGIN
Plugin.
Definition ObTypes.h:1139
+
OB_DC_POWER_NO_PLUGIN
@ OB_DC_POWER_NO_PLUGIN
No plugin.
Definition ObTypes.h:1138
+
ob_camera_align_intrinsic
struct OBCameraAlignIntrinsic ob_camera_align_intrinsic
+
ob_accel_full_scale_range
enum OBAccelFullScaleRange ob_accel_full_scale_range
+
ob_camera_param_v0
struct OBCameraParam_V0 ob_camera_param_v0
+
ob_filters
struct OBFilterListImpl ob_filters
Definition ObTypes.h:71
+
DEVICE_IP_ADDR_CONFIG
struct OBNetIpConfig DEVICE_IP_ADDR_CONFIG
+
ob_int_property_range
struct OBIntPropertyRange ob_int_property_range
+
ob_context
struct ContextImpl ob_context
Definition ObTypes.h:54
+
ob_gyro_intrinsic
struct OBGyroIntrinsic ob_gyro_intrinsic
+
ob_transform
struct OBD2CTransform ob_transform
+
OBUpgradeState
OBUpgradeState
Enumeration value describing the firmware upgrade status.
Definition ObTypes.h:255
+
ERR_DDR
@ ERR_DDR
Definition ObTypes.h:268
+
STAT_DONE
@ STAT_DONE
Definition ObTypes.h:258
+
ERR_IMAGE_SIZE
@ ERR_IMAGE_SIZE
Definition ObTypes.h:266
+
STAT_IN_PROGRESS
@ STAT_IN_PROGRESS
Definition ObTypes.h:259
+
ERR_OTHER
@ ERR_OTHER
Definition ObTypes.h:267
+
STAT_VERIFY_IMAGE
@ STAT_VERIFY_IMAGE
Definition ObTypes.h:261
+
ERR_FLASH_TYPE
@ ERR_FLASH_TYPE
Definition ObTypes.h:265
+
ERR_VERIFY
@ ERR_VERIFY
Definition ObTypes.h:262
+
ERR_ERASE
@ ERR_ERASE
Definition ObTypes.h:264
+
STAT_VERIFY_SUCCESS
@ STAT_VERIFY_SUCCESS
Definition ObTypes.h:256
+
STAT_START
@ STAT_START
Definition ObTypes.h:260
+
ERR_TIMEOUT
@ ERR_TIMEOUT
Definition ObTypes.h:269
+
STAT_FILE_TRANSFER
@ STAT_FILE_TRANSFER
Definition ObTypes.h:257
+
ERR_PROGRAM
@ ERR_PROGRAM
Definition ObTypes.h:263
+
OBUSBPowerState
OBUSBPowerState
USB power status.
Definition ObTypes.h:1126
+
OB_USB_POWER_5V_1A5
@ OB_USB_POWER_5V_1A5
5V/1.5A
Definition ObTypes.h:1129
+
OB_USB_POWER_5V_3A0
@ OB_USB_POWER_5V_3A0
5V/3.0A
Definition ObTypes.h:1130
+
OB_USB_POWER_5V_0A9
@ OB_USB_POWER_5V_0A9
5V/0.9A
Definition ObTypes.h:1128
+
OB_USB_POWER_NO_PLUGIN
@ OB_USB_POWER_NO_PLUGIN
No plugin.
Definition ObTypes.h:1127
+
OBCmdVersion
enum OB_CMD_VERSION OBCmdVersion
+
OBTransform
struct OBD2CTransform OBTransform
+
OB_SYNC_MODE
enum OBSyncMode OB_SYNC_MODE
+
ob_frame_type
enum OBFrameType ob_frame_type
+
ob_camera_distortion_model
enum OBCameraDistortionModel ob_camera_distortion_model
+
OB_DEVICE_TYPE
enum OBDeviceType OB_DEVICE_TYPE
+
ob_device_state
uint64_t ob_device_state
Definition ObTypes.h:635
+
OBHoleFillingMode
OBHoleFillingMode
Hole fillig mode.
Definition ObTypes.h:954
+
OB_HOLE_FILL_FAREST
@ OB_HOLE_FILL_FAREST
Definition ObTypes.h:957
+
OB_HOLE_FILL_NEAREST
@ OB_HOLE_FILL_NEAREST
Definition ObTypes.h:956
+
OB_HOLE_FILL_TOP
@ OB_HOLE_FILL_TOP
Definition ObTypes.h:955
+
ob_sensor_type
enum OBSensorType ob_sensor_type
+
ob_depth_precision_level
enum OBDepthPrecisionLevel ob_depth_precision_level
+
ob_frame_callback
void(* ob_frame_callback)(ob_frame *frame, void *user_data)
Callback for frame.
Definition ObTypes.h:1704
+
OB_SAMPLE_RATE
enum OBGyroSampleRate OB_SAMPLE_RATE
+
ob_camera_param_list
struct CameraParamListImpl ob_camera_param_list
Definition ObTypes.h:58
+
ob_set_data_callback
void(* ob_set_data_callback)(ob_data_tran_state state, uint8_t percent, void *user_data)
Callback for writing data.
Definition ObTypes.h:1667
+
ob_extrinsic
struct OBD2CTransform ob_extrinsic
+
ob_protocol_version
struct OBProtocolVersion ob_protocol_version
+
OBRotateDegreeType
enum ob_rotate_degree_type OBRotateDegreeType
+
ob_media_state_callback
void(* ob_media_state_callback)(ob_media_state state, void *user_data)
Callback for media status (recording and playback)
Definition ObTypes.h:1684
+
OB_GYRO_FULL_SCALE_RANGE
enum OBGyroFullScaleRange OB_GYRO_FULL_SCALE_RANGE
+
ob_media_state
enum OBMediaState ob_media_state
+
OBAlignMode
OBAlignMode
Alignment mode.
Definition ObTypes.h:518
+
ALIGN_D2C_HW_MODE
@ ALIGN_D2C_HW_MODE
Definition ObTypes.h:520
+
ALIGN_DISABLE
@ ALIGN_DISABLE
Definition ObTypes.h:519
+
ALIGN_D2C_SW_MODE
@ ALIGN_D2C_SW_MODE
Definition ObTypes.h:521
+
OB_MEDIA_TYPE
enum OBMediaType OB_MEDIA_TYPE
+
TOF_EXPOSURE_THRESHOLD_CONTROL
struct OBTofExposureThresholdControl TOF_EXPOSURE_THRESHOLD_CONTROL
+
ob_point3f
struct OBPoint ob_point3f
+
ob_frame_metadata_type
ob_frame_metadata_type
Frame metadata types.
Definition ObTypes.h:1440
+
OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY
@ OB_FRAME_METADATA_TYPE_POWER_LINE_FREQUENCY
Power line frequency.
Definition ObTypes.h:1531
+
OB_FRAME_METADATA_TYPE_SATURATION
@ OB_FRAME_METADATA_TYPE_SATURATION
Saturation.
Definition ObTypes.h:1505
+
OB_FRAME_METADATA_TYPE_AE_ROI_TOP
@ OB_FRAME_METADATA_TYPE_AE_ROI_TOP
Top region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1564
+
OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE
@ OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_SIZE
HDR sequence size.
Definition ObTypes.h:1589
+
OB_FRAME_METADATA_TYPE_FRAME_NUMBER
@ OB_FRAME_METADATA_TYPE_FRAME_NUMBER
The number of current frame.
Definition ObTypes.h:1459
+
OB_FRAME_METADATA_TYPE_SHARPNESS
@ OB_FRAME_METADATA_TYPE_SHARPNESS
Sharpness.
Definition ObTypes.h:1510
+
OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE
@ OB_FRAME_METADATA_TYPE_MANUAL_WHITE_BALANCE
Manual white balance setting.
Definition ObTypes.h:1543
+
OB_FRAME_METADATA_TYPE_AE_ROI_LEFT
@ OB_FRAME_METADATA_TYPE_AE_ROI_LEFT
Left region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1559
+
OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP
@ OB_FRAME_METADATA_TYPE_SENSOR_TIMESTAMP
Timestamp in the middle of the capture.
Definition ObTypes.h:1454
+
OB_FRAME_METADATA_TYPE_COUNT
@ OB_FRAME_METADATA_TYPE_COUNT
The number of frame metadata types, using for types iterating.
Definition ObTypes.h:1623
+
OB_FRAME_METADATA_TYPE_BRIGHTNESS
@ OB_FRAME_METADATA_TYPE_BRIGHTNESS
Brightness.
Definition ObTypes.h:1495
+
OB_FRAME_METADATA_TYPE_CONTRAST
@ OB_FRAME_METADATA_TYPE_CONTRAST
Contrast.
Definition ObTypes.h:1500
+
OB_FRAME_METADATA_TYPE_HUE
@ OB_FRAME_METADATA_TYPE_HUE
Hue.
Definition ObTypes.h:1520
+
OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM
@ OB_FRAME_METADATA_TYPE_AE_ROI_BOTTOM
Bottom region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1574
+
OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX
@ OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_INDEX
HDR sequence index.
Definition ObTypes.h:1594
+
OB_FRAME_METADATA_TYPE_LASER_STATUS
@ OB_FRAME_METADATA_TYPE_LASER_STATUS
Laser status.
Definition ObTypes.h:1612
+
OB_FRAME_METADATA_TYPE_WHITE_BALANCE
@ OB_FRAME_METADATA_TYPE_WHITE_BALANCE
White balance.
Definition ObTypes.h:1490
+
OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT
@ OB_FRAME_METADATA_TYPE_AE_ROI_RIGHT
Right region of interest for the auto exposure Algorithm.
Definition ObTypes.h:1569
+
OB_FRAME_METADATA_TYPE_GAIN
@ OB_FRAME_METADATA_TYPE_GAIN
Gain.
Definition ObTypes.h:1479
+
OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL
@ OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL
Laser power level.
Definition ObTypes.h:1606
+
OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA
@ OB_FRAME_METADATA_TYPE_GPIO_INPUT_DATA
GPIO input data.
Definition ObTypes.h:1617
+
OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME
@ OB_FRAME_METADATA_TYPE_HDR_SEQUENCE_NAME
HDR sequence name.
Definition ObTypes.h:1584
+
OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY
@ OB_FRAME_METADATA_TYPE_EXPOSURE_PRIORITY
Exposure priority.
Definition ObTypes.h:1579
+
OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE
@ OB_FRAME_METADATA_TYPE_AUTO_WHITE_BALANCE
Auto white balance status.
Definition ObTypes.h:1485
+
OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION
@ OB_FRAME_METADATA_TYPE_BACKLIGHT_COMPENSATION
Backlight compensation.
Definition ObTypes.h:1515
+
OB_FRAME_METADATA_TYPE_TIMESTAMP
@ OB_FRAME_METADATA_TYPE_TIMESTAMP
Timestamp when the frame is captured.
Definition ObTypes.h:1446
+
OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE
@ OB_FRAME_METADATA_TYPE_ACTUAL_FRAME_RATE
Actual frame rate.
Definition ObTypes.h:1549
+
OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION
@ OB_FRAME_METADATA_TYPE_LOW_LIGHT_COMPENSATION
Low light compensation.
Definition ObTypes.h:1538
+
OB_FRAME_METADATA_TYPE_LASER_POWER
@ OB_FRAME_METADATA_TYPE_LASER_POWER
Laser power value in mW.
Definition ObTypes.h:1601
+
OB_FRAME_METADATA_TYPE_FRAME_RATE
@ OB_FRAME_METADATA_TYPE_FRAME_RATE
Frame rate.
Definition ObTypes.h:1554
+
OB_FRAME_METADATA_TYPE_EXPOSURE
@ OB_FRAME_METADATA_TYPE_EXPOSURE
Exposure time.
Definition ObTypes.h:1472
+
OB_FRAME_METADATA_TYPE_GAMMA
@ OB_FRAME_METADATA_TYPE_GAMMA
Gamma.
Definition ObTypes.h:1525
+
OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE
@ OB_FRAME_METADATA_TYPE_AUTO_EXPOSURE
Auto exposure status.
Definition ObTypes.h:1465
+
OBDepthPrecisionLevel
OBDepthPrecisionLevel
Enumeration for depth precision levels.
Definition ObTypes.h:710
+
OB_PRECISION_0MM05
@ OB_PRECISION_0MM05
Definition ObTypes.h:717
+
OB_PRECISION_UNKNOWN
@ OB_PRECISION_UNKNOWN
Definition ObTypes.h:718
+
OB_PRECISION_0MM8
@ OB_PRECISION_0MM8
Definition ObTypes.h:712
+
OB_PRECISION_0MM5
@ OB_PRECISION_0MM5
Definition ObTypes.h:716
+
OB_PRECISION_1MM
@ OB_PRECISION_1MM
Definition ObTypes.h:711
+
OB_PRECISION_COUNT
@ OB_PRECISION_COUNT
Definition ObTypes.h:719
+
OB_PRECISION_0MM4
@ OB_PRECISION_0MM4
Definition ObTypes.h:713
+
OB_PRECISION_0MM2
@ OB_PRECISION_0MM2
Definition ObTypes.h:715
+
OB_PRECISION_0MM1
@ OB_PRECISION_0MM1
Definition ObTypes.h:714
+
ob_rotate_degree_type
ob_rotate_degree_type
Rotate degree.
Definition ObTypes.h:1146
+
OB_ROTATE_DEGREE_0
@ OB_ROTATE_DEGREE_0
Rotate 0.
Definition ObTypes.h:1147
+
OB_ROTATE_DEGREE_90
@ OB_ROTATE_DEGREE_90
Rotate 90.
Definition ObTypes.h:1148
+
OB_ROTATE_DEGREE_180
@ OB_ROTATE_DEGREE_180
Rotate 180.
Definition ObTypes.h:1149
+
OB_ROTATE_DEGREE_270
@ OB_ROTATE_DEGREE_270
Rotate 270.
Definition ObTypes.h:1150
+
ob_status
enum OBStatus ob_status
+
ob_depth_work_mode_list
struct OBDepthWorkModeListImpl ob_depth_work_mode_list
Definition ObTypes.h:69
+
OBConvertFormat
OBConvertFormat
Enumeration of format conversion types.
Definition ObTypes.h:538
+
FORMAT_MJPG_TO_NV21
@ FORMAT_MJPG_TO_NV21
Definition ObTypes.h:545
+
FORMAT_NV12_TO_RGB
@ FORMAT_NV12_TO_RGB
Definition ObTypes.h:542
+
FORMAT_YUYV_TO_Y8
@ FORMAT_YUYV_TO_Y8
Definition ObTypes.h:556
+
FORMAT_YUYV_TO_RGBA
@ FORMAT_YUYV_TO_RGBA
Definition ObTypes.h:553
+
FORMAT_UYVY_TO_RGB
@ FORMAT_UYVY_TO_RGB
Definition ObTypes.h:549
+
FORMAT_MJPG_TO_BGR
@ FORMAT_MJPG_TO_BGR
Definition ObTypes.h:547
+
FORMAT_NV21_TO_RGB
@ FORMAT_NV21_TO_RGB
Definition ObTypes.h:541
+
FORMAT_RGB_TO_BGR
@ FORMAT_RGB_TO_BGR
Definition ObTypes.h:544
+
FORMAT_BGR_TO_RGB
@ FORMAT_BGR_TO_RGB
Definition ObTypes.h:550
+
FORMAT_MJPG_TO_BGRA
@ FORMAT_MJPG_TO_BGRA
Definition ObTypes.h:548
+
FORMAT_MJPG_TO_I420
@ FORMAT_MJPG_TO_I420
Definition ObTypes.h:543
+
FORMAT_YUYV_TO_RGB
@ FORMAT_YUYV_TO_RGB
Definition ObTypes.h:539
+
FORMAT_YUYV_TO_BGR
@ FORMAT_YUYV_TO_BGR
Definition ObTypes.h:552
+
FORMAT_MJPG_TO_NV12
@ FORMAT_MJPG_TO_NV12
Definition ObTypes.h:551
+
FORMAT_YUYV_TO_Y16
@ FORMAT_YUYV_TO_Y16
Definition ObTypes.h:555
+
FORMAT_I420_TO_RGB
@ FORMAT_I420_TO_RGB
Definition ObTypes.h:540
+
FORMAT_MJPG_TO_RGB
@ FORMAT_MJPG_TO_RGB
Definition ObTypes.h:546
+
FORMAT_YUYV_TO_BGRA
@ FORMAT_YUYV_TO_BGRA
Definition ObTypes.h:554
+
OB_COMMUNICATION_TYPE
enum OBCommunicationType OB_COMMUNICATION_TYPE
+
DEVICE_LOG_SEVERITY_LEVEL
enum OBLogSeverity DEVICE_LOG_SEVERITY_LEVEL
+
ob_uint16_property_range
struct OBUint16PropertyRange ob_uint16_property_range
+
ob_device_state_callback
void(* ob_device_state_callback)(ob_device_state state, const char *message, void *user_data)
Callback for device status.
Definition ObTypes.h:1658
+
OBMediaType
OBMediaType
Enumeration for types of media to record or playback.
Definition ObTypes.h:677
+
OB_MEDIA_STREAM_INFO
@ OB_MEDIA_STREAM_INFO
Definition ObTypes.h:685
+
OB_MEDIA_IR_LEFT_STREAM
@ OB_MEDIA_IR_LEFT_STREAM
Definition ObTypes.h:686
+
OB_MEDIA_ALL
@ OB_MEDIA_ALL
Definition ObTypes.h:689
+
OB_MEDIA_IR_RIGHT_STREAM
@ OB_MEDIA_IR_RIGHT_STREAM
Definition ObTypes.h:687
+
OB_MEDIA_DEPTH_STREAM
@ OB_MEDIA_DEPTH_STREAM
Definition ObTypes.h:679
+
OB_MEDIA_IR_STREAM
@ OB_MEDIA_IR_STREAM
Definition ObTypes.h:680
+
OB_MEDIA_CAMERA_PARAM
@ OB_MEDIA_CAMERA_PARAM
Definition ObTypes.h:683
+
OB_MEDIA_GYRO_STREAM
@ OB_MEDIA_GYRO_STREAM
Definition ObTypes.h:681
+
OB_MEDIA_DEVICE_INFO
@ OB_MEDIA_DEVICE_INFO
Definition ObTypes.h:684
+
OB_MEDIA_ACCEL_STREAM
@ OB_MEDIA_ACCEL_STREAM
Definition ObTypes.h:682
+
OB_MEDIA_COLOR_STREAM
@ OB_MEDIA_COLOR_STREAM
Definition ObTypes.h:678
+
ob_depth_cropping_mode
enum OBDepthCroppingMode ob_depth_cropping_mode
+
ob_permission_type
enum OBPermissionType ob_permission_type
+
OBLogSeverity
OBLogSeverity
log level, the higher the level, the stronger the log filter
Definition ObTypes.h:115
+
OB_LOG_SEVERITY_DEBUG
@ OB_LOG_SEVERITY_DEBUG
Definition ObTypes.h:116
+
OB_LOG_SEVERITY_ERROR
@ OB_LOG_SEVERITY_ERROR
Definition ObTypes.h:119
+
OB_LOG_SEVERITY_INFO
@ OB_LOG_SEVERITY_INFO
Definition ObTypes.h:117
+
OB_LOG_SEVERITY_OFF
@ OB_LOG_SEVERITY_OFF
Definition ObTypes.h:121
+
OB_LOG_SEVERITY_WARN
@ OB_LOG_SEVERITY_WARN
Definition ObTypes.h:118
+
OB_LOG_SEVERITY_FATAL
@ OB_LOG_SEVERITY_FATAL
Definition ObTypes.h:120
+
ob_frameset_callback
void(* ob_frameset_callback)(ob_frame *frameset, void *user_data)
Callback for frameset.
Definition ObTypes.h:1714
+
OB_COORDINATE_SYSTEM_TYPE
OB_COORDINATE_SYSTEM_TYPE
Enumeration of point cloud coordinate system types.
Definition ObTypes.h:1193
+
OB_RIGHT_HAND_COORDINATE_SYSTEM
@ OB_RIGHT_HAND_COORDINATE_SYSTEM
Definition ObTypes.h:1195
+
OB_LEFT_HAND_COORDINATE_SYSTEM
@ OB_LEFT_HAND_COORDINATE_SYSTEM
Definition ObTypes.h:1194
+
ob_mgc_filter_config
struct OBMGCFilterConfig ob_mgc_filter_config
+
ob_camera_intrinsic
struct OBCameraIntrinsic ob_camera_intrinsic
+
AE_ROI
The rect of the region of interest.
Definition ObTypes.h:1429
+
AE_ROI::y0_top
int16_t y0_top
Definition ObTypes.h:1431
+
AE_ROI::x1_right
int16_t x1_right
Definition ObTypes.h:1432
+
AE_ROI::y1_bottom
int16_t y1_bottom
Definition ObTypes.h:1433
+
AE_ROI::x0_left
int16_t x0_left
Definition ObTypes.h:1430
+
BASELINE_CALIBRATION_PARAM
Baseline calibration parameters.
Definition ObTypes.h:1395
+
BASELINE_CALIBRATION_PARAM::zpd
float zpd
Calibration distance.
Definition ObTypes.h:1403
+
BASELINE_CALIBRATION_PARAM::baseline
float baseline
Baseline length.
Definition ObTypes.h:1399
+
HDR_CONFIG
HDR Configuration.
Definition ObTypes.h:1409
+
HDR_CONFIG::gain_1
uint32_t gain_1
Gain 1.
Definition ObTypes.h:1421
+
HDR_CONFIG::exposure_1
uint32_t exposure_1
Exposure time 1.
Definition ObTypes.h:1420
+
HDR_CONFIG::exposure_2
uint32_t exposure_2
Exposure time 2.
Definition ObTypes.h:1422
+
HDR_CONFIG::enable
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:1418
+
HDR_CONFIG::sequence_name
uint8_t sequence_name
Sequence name.
Definition ObTypes.h:1419
+
HDR_CONFIG::gain_2
uint32_t gain_2
Gain 2.
Definition ObTypes.h:1423
+
OBAccelIntrinsic
Structure for accelerometer intrinsic parameters.
Definition ObTypes.h:386
+
OBAccelIntrinsic::randomWalk
double randomWalk
random walk
Definition ObTypes.h:388
+
OBAccelIntrinsic::noiseDensity
double noiseDensity
In-run bias instability.
Definition ObTypes.h:387
+
OBAccelIntrinsic::referenceTemp
double referenceTemp
reference temperature
Definition ObTypes.h:389
+
OBAccelValue
Data structures for accelerometers and gyroscopes.
Definition ObTypes.h:626
+
OBAccelValue::z
float z
Z-direction component.
Definition ObTypes.h:629
+
OBAccelValue::x
float x
X-direction component.
Definition ObTypes.h:627
+
OBAccelValue::y
float y
Y-direction component.
Definition ObTypes.h:628
+
OBBoolPropertyRange
Structure for boolean range.
Definition ObTypes.h:363
+
OBBoolPropertyRange::def
bool def
Default value.
Definition ObTypes.h:368
+
OBBoolPropertyRange::min
bool min
Minimum value.
Definition ObTypes.h:366
+
OBBoolPropertyRange::cur
bool cur
Current value.
Definition ObTypes.h:364
+
OBBoolPropertyRange::max
bool max
Maximum value.
Definition ObTypes.h:365
+
OBBoolPropertyRange::step
bool step
Step value.
Definition ObTypes.h:367
+
OBCalibrationParam
calibration parameters
Definition ObTypes.h:480
+
OBCameraAlignIntrinsic
Video stream intrinsics.
Definition ObTypes.h:433
+ + +
OBCameraAlignIntrinsic::model
OBCameraDistortionModel model
Definition ObTypes.h:440
+ + + + +
OBCameraDistortion
Structure for distortion parameters.
Definition ObTypes.h:411
+
OBCameraDistortion::p1
float p1
Tangential distortion factor 1.
Definition ObTypes.h:418
+
OBCameraDistortion::k6
float k6
Radial distortion factor 6.
Definition ObTypes.h:417
+
OBCameraDistortion::k3
float k3
Radial distortion factor 3.
Definition ObTypes.h:414
+
OBCameraDistortion::k1
float k1
Radial distortion factor 1.
Definition ObTypes.h:412
+
OBCameraDistortion::k5
float k5
Radial distortion factor 5.
Definition ObTypes.h:416
+
OBCameraDistortion::k4
float k4
Radial distortion factor 4.
Definition ObTypes.h:415
+
OBCameraDistortion::p2
float p2
Tangential distortion factor 2.
Definition ObTypes.h:419
+
OBCameraDistortion::k2
float k2
Radial distortion factor 2.
Definition ObTypes.h:413
+
OBCameraIntrinsic
Structure for camera intrinsic parameters.
Definition ObTypes.h:374
+
OBCameraIntrinsic::fx
float fx
Focal length in x direction.
Definition ObTypes.h:375
+
OBCameraIntrinsic::cx
float cx
Optical center abscissa.
Definition ObTypes.h:377
+
OBCameraIntrinsic::height
int16_t height
Image height.
Definition ObTypes.h:380
+
OBCameraIntrinsic::cy
float cy
Optical center ordinate.
Definition ObTypes.h:378
+
OBCameraIntrinsic::width
int16_t width
Image width.
Definition ObTypes.h:379
+
OBCameraIntrinsic::fy
float fy
Focal length in y direction.
Definition ObTypes.h:376
+
OBCameraParam_V0
Camera parameters.
Definition ObTypes.h:468
+
OBCameraParam_V0::transform
OBD2CTransform transform
Rotation/transformation matrix.
Definition ObTypes.h:474
+
OBCameraParam_V0::rgbDistortion
OBCameraDistortion rgbDistortion
Distortion parameters for color camera.
Definition ObTypes.h:473
+
OBCameraParam_V0::depthDistortion
OBCameraDistortion depthDistortion
Depth camera distortion parameters.
Definition ObTypes.h:471
+
OBCameraParam_V0::rgbIntrinsic
OBCameraIntrinsic rgbIntrinsic
Color camera internal parameters.
Definition ObTypes.h:470
+
OBCameraParam_V0::depthIntrinsic
OBCameraIntrinsic depthIntrinsic
Depth camera internal parameters.
Definition ObTypes.h:469
+
OBCameraParam
Structure for camera parameters.
Definition ObTypes.h:456
+
OBCameraParam::rgbDistortion
OBCameraDistortion rgbDistortion
Color camera distortion parameters.
Definition ObTypes.h:460
+
OBCameraParam::isMirrored
bool isMirrored
Whether the image frame corresponding to this group of parameters is mirrored.
Definition ObTypes.h:462
+
OBCameraParam::rgbIntrinsic
OBCameraIntrinsic rgbIntrinsic
Color camera internal parameters.
Definition ObTypes.h:458
+
OBCameraParam::depthIntrinsic
OBCameraIntrinsic depthIntrinsic
Depth camera internal parameters.
Definition ObTypes.h:457
+
OBCameraParam::depthDistortion
OBCameraDistortion depthDistortion
Depth camera distortion parameters.
Definition ObTypes.h:459
+
OBCameraParam::transform
OBD2CTransform transform
Rotation/transformation matrix.
Definition ObTypes.h:461
+
OBColorPoint
3D point structure with color information
Definition ObTypes.h:760
+
OBColorPoint::z
float z
Z coordinate.
Definition ObTypes.h:763
+
OBColorPoint::g
float g
Green channel component.
Definition ObTypes.h:765
+
OBColorPoint::b
float b
Blue channel component.
Definition ObTypes.h:766
+
OBColorPoint::x
float x
X coordinate.
Definition ObTypes.h:761
+
OBColorPoint::y
float y
Y coordinate.
Definition ObTypes.h:762
+
OBColorPoint::r
float r
Red channel component.
Definition ObTypes.h:764
+ + +
OBD2CTransform
Structure for rotation/transformation.
Definition ObTypes.h:448
+
OBDataBundle
Internal API for future publication.
Definition ObTypes.h:1049
+
OBDataBundle::itemCount
uint32_t itemCount
Count of data item.
Definition ObTypes.h:1081
+
OBDataBundle::cmdVersion
OBCmdVersion cmdVersion
OBCmdVersion of propertyId.
Definition ObTypes.h:1053
+
OBDataBundle::itemTypeSize
uint32_t itemTypeSize
Size of data item.
Definition ObTypes.h:1074
+
OBDataBundle::dataSize
uint32_t dataSize
Data size in bytes.
Definition ObTypes.h:1067
+
OBDataBundle::data
void * data
Data containing itemCount of elements.
Definition ObTypes.h:1060
+
OBDataChunk
Structure for transmitting data blocks.
Definition ObTypes.h:309
+
OBDataChunk::data
uint8_t * data
Pointer to current block data.
Definition ObTypes.h:310
+
OBDataChunk::offset
uint32_t offset
Offset of current data block relative to complete data.
Definition ObTypes.h:312
+
OBDataChunk::fullDataSize
uint32_t fullDataSize
Size of full data.
Definition ObTypes.h:313
+
OBDataChunk::size
uint32_t size
Length of current block data.
Definition ObTypes.h:311
+
OBDepthWorkMode
Depth work mode.
Definition ObTypes.h:931
+
OBDeviceSyncConfig
Device synchronization configuration.
Definition ObTypes.h:875
+
OBDeviceSyncConfig::rgbTriggerSignalInDelay
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:895
+
OBDeviceSyncConfig::syncMode
OBSyncMode syncMode
Device synchronize mode.
Definition ObTypes.h:879
+
OBDeviceSyncConfig::deviceTriggerSignalOutPolarity
uint16_t deviceTriggerSignalOutPolarity
The device trigger signal output polarity is used to control the polarity configuration of the trigge...
Definition ObTypes.h:912
+
OBDeviceSyncConfig::deviceId
uint16_t deviceId
Device number. Users can mark the device with this number.
Definition ObTypes.h:925
+
OBDeviceSyncConfig::irTriggerSignalInDelay
uint16_t irTriggerSignalInDelay
IR Trigger signal input delay: Used to configure the delay between the IR/Depth/TOF Sensor receiving ...
Definition ObTypes.h:887
+
OBDeviceSyncConfig::deviceTriggerSignalOutDelay
uint16_t deviceTriggerSignalOutDelay
Device trigger signal output delay, used to control the delay configuration of the host device to out...
Definition ObTypes.h:903
+
OBDeviceSyncConfig::mcuTriggerFrequency
uint16_t mcuTriggerFrequency
MCU trigger frequency, used to configure the output frequency of MCU trigger signal in MCU master mod...
Definition ObTypes.h:920
+
OBDeviceTemperature
Temperature parameters of the device (unit: Celsius)
Definition ObTypes.h:640
+
OBDeviceTemperature::tecTemp
float tecTemp
TEC temperature.
Definition ObTypes.h:645
+
OBDeviceTemperature::irRightTemp
float irRightTemp
Right IR temperature.
Definition ObTypes.h:649
+
OBDeviceTemperature::imuTemp
float imuTemp
IMU temperature.
Definition ObTypes.h:646
+
OBDeviceTemperature::mainBoardTemp
float mainBoardTemp
Motherboard temperature.
Definition ObTypes.h:644
+
OBDeviceTemperature::irTemp
float irTemp
IR temperature.
Definition ObTypes.h:642
+
OBDeviceTemperature::chipBottomTemp
float chipBottomTemp
MX6600 bottom temperature.
Definition ObTypes.h:651
+
OBDeviceTemperature::irLeftTemp
float irLeftTemp
Left IR temperature.
Definition ObTypes.h:648
+
OBDeviceTemperature::ldmTemp
float ldmTemp
Laser temperature.
Definition ObTypes.h:643
+
OBDeviceTemperature::rgbTemp
float rgbTemp
RGB temperature.
Definition ObTypes.h:647
+
OBDeviceTemperature::chipTopTemp
float chipTopTemp
MX6600 top temperature.
Definition ObTypes.h:650
+
OBDeviceTemperature::cpuTemp
float cpuTemp
CPU temperature.
Definition ObTypes.h:641
+ +
OBEdgeNoiseRemovalFilterParams::type
OBEdgeNoiseRemovalType type
Definition ObTypes.h:977
+ + + + +
OBFloatPropertyRange
Structure for float range.
Definition ObTypes.h:330
+
OBFloatPropertyRange::cur
float cur
Current value.
Definition ObTypes.h:331
+
OBFloatPropertyRange::min
float min
Minimum value.
Definition ObTypes.h:333
+
OBFloatPropertyRange::max
float max
Maximum value.
Definition ObTypes.h:332
+
OBFloatPropertyRange::def
float def
Default value.
Definition ObTypes.h:335
+
OBFloatPropertyRange::step
float step
Step value.
Definition ObTypes.h:334
+
OBGyroIntrinsic
Structure for gyroscope intrinsic parameters.
Definition ObTypes.h:399
+
OBGyroIntrinsic::randomWalk
double randomWalk
random walk
Definition ObTypes.h:401
+
OBGyroIntrinsic::noiseDensity
double noiseDensity
In-run bias instability.
Definition ObTypes.h:400
+
OBGyroIntrinsic::referenceTemp
double referenceTemp
reference temperature
Definition ObTypes.h:402
+
OBIntPropertyRange
Structure for integer range.
Definition ObTypes.h:319
+
OBIntPropertyRange::step
int32_t step
Step value.
Definition ObTypes.h:323
+
OBIntPropertyRange::def
int32_t def
Default value.
Definition ObTypes.h:324
+
OBIntPropertyRange::max
int32_t max
Maximum value.
Definition ObTypes.h:321
+
OBIntPropertyRange::min
int32_t min
Minimum value.
Definition ObTypes.h:322
+
OBIntPropertyRange::cur
int32_t cur
Current value.
Definition ObTypes.h:320
+
OBMGCFilterConfig
Configuration for mgc filter.
Definition ObTypes.h:503
+ + + +
OBMGCFilterConfig::width
uint32_t width
Definition ObTypes.h:504
+ + + + +
OBMGCFilterConfig::height
uint32_t height
Definition ObTypes.h:505
+
OBNetIpConfig
IP address configuration for network devices (IPv4)
Definition ObTypes.h:1087
+
OBNetIpConfig::dhcp
uint16_t dhcp
DHCP status.
Definition ObTypes.h:1093
+ + + +
OBNoiseRemovalFilterParams::type
OBDDONoiseRemovalType type
Definition ObTypes.h:996
+
OBPoint2f
2D point structure in the SDK
Definition ObTypes.h:745
+
OBPoint2f::x
float x
X coordinate.
Definition ObTypes.h:746
+
OBPoint2f::y
float y
Y coordinate.
Definition ObTypes.h:747
+
OBPoint
3D point structure in the SDK
Definition ObTypes.h:736
+
OBPoint::y
float y
Y coordinate.
Definition ObTypes.h:738
+
OBPoint::z
float z
Z coordinate.
Definition ObTypes.h:739
+
OBPoint::x
float x
X coordinate.
Definition ObTypes.h:737
+
OBProtocolVersion
Control command protocol version number.
Definition ObTypes.h:1003
+
OBProtocolVersion::major
uint8_t major
Major version number.
Definition ObTypes.h:1007
+
OBProtocolVersion::minor
uint8_t minor
Minor version number.
Definition ObTypes.h:1012
+
OBProtocolVersion::patch
uint8_t patch
Patch version number.
Definition ObTypes.h:1017
+
OBRect
Rectangle.
Definition ObTypes.h:528
+
OBRect::height
uint32_t height
Rectangle height.
Definition ObTypes.h:532
+
OBRect::y
uint32_t y
Origin coordinate y.
Definition ObTypes.h:530
+
OBRect::x
uint32_t x
Origin coordinate x.
Definition ObTypes.h:529
+
OBRect::width
uint32_t width
Rectangle width.
Definition ObTypes.h:531
+
OBSequenceIdItem
SequenceId fliter list item.
Definition ObTypes.h:946
+ + + + + + +
OBTofExposureThresholdControl
TOF Exposure Threshold.
Definition ObTypes.h:791
+
OBTofExposureThresholdControl::lower
int32_t lower
Lower threshold, unit: ms.
Definition ObTypes.h:793
+
OBTofExposureThresholdControl::upper
int32_t upper
Upper threshold, unit: ms.
Definition ObTypes.h:792
+
OBUint16PropertyRange
Structure for float range.
Definition ObTypes.h:341
+
OBUint16PropertyRange::min
uint16_t min
Minimum value.
Definition ObTypes.h:344
+
OBUint16PropertyRange::cur
uint16_t cur
Current value.
Definition ObTypes.h:342
+
OBUint16PropertyRange::step
uint16_t step
Step value.
Definition ObTypes.h:345
+
OBUint16PropertyRange::max
uint16_t max
Maximum value.
Definition ObTypes.h:343
+
OBUint16PropertyRange::def
uint16_t def
Default value.
Definition ObTypes.h:346
+
OBUint8PropertyRange
Structure for float range.
Definition ObTypes.h:352
+
OBUint8PropertyRange::min
uint8_t min
Minimum value.
Definition ObTypes.h:355
+
OBUint8PropertyRange::def
uint8_t def
Default value.
Definition ObTypes.h:357
+
OBUint8PropertyRange::cur
uint8_t cur
Current value.
Definition ObTypes.h:353
+
OBUint8PropertyRange::step
uint8_t step
Step value.
Definition ObTypes.h:356
+
OBUint8PropertyRange::max
uint8_t max
Maximum value.
Definition ObTypes.h:354
+ +
OBXYTables::width
int width
width of x and y tables
Definition ObTypes.h:753
+
OBXYTables::xTable
float * xTable
table used to compute X coordinate
Definition ObTypes.h:751
+
OBXYTables::height
int height
height of x and y tables
Definition ObTypes.h:754
+
OBXYTables::yTable
float * yTable
table used to compute Y coordinate
Definition ObTypes.h:752
+
ob_device_timestamp_reset_config
The timestamp reset configuration of the device.
Definition ObTypes.h:1368
+
ob_device_timestamp_reset_config::timestamp_reset_delay_us
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:1382
+
ob_device_timestamp_reset_config::enable
bool enable
Whether to enable the timestamp reset function.
Definition ObTypes.h:1377
+
ob_device_timestamp_reset_config::timestamp_reset_signal_output_enable
bool timestamp_reset_signal_output_enable
the timestamp reset signal output enable flag.
Definition ObTypes.h:1389
+
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition ObTypes.h:146
+
ob_error::function
char function[256]
Describe the name of the function where the error occurred.
Definition ObTypes.h:149
+
ob_error::args
char args[256]
Describes the parameters passed to the function when an error occurs. Used to check whether the param...
Definition ObTypes.h:150
+
ob_error::message
char message[256]
Describe the detailed error log.
Definition ObTypes.h:148
+
ob_error::exception_type
ob_exception_type exception_type
The description is the specific error type of the SDK.
Definition ObTypes.h:151
+
ob_error::status
ob_status status
Describe the status code of the error, as compatible with previous customer status code requirements.
Definition ObTypes.h:147
+
ob_margin_filter_config
Configuration for depth margin filter.
Definition ObTypes.h:490
+
ob_margin_filter_config::enable_direction
bool enable_direction
Set to true for horizontal and vertical, false for horizontal only.
Definition ObTypes.h:497
+
ob_margin_filter_config::limit_y_th
int limit_y_th
Maximum vertical threshold.
Definition ObTypes.h:494
+
ob_margin_filter_config::limit_x_th
int limit_x_th
Maximum horizontal threshold.
Definition ObTypes.h:493
+
ob_margin_filter_config::height
uint32_t height
Image height.
Definition ObTypes.h:496
+
ob_margin_filter_config::margin_y_th
int margin_y_th
Vertical threshold settings.
Definition ObTypes.h:492
+
ob_margin_filter_config::width
uint32_t width
Image width.
Definition ObTypes.h:495
+
ob_margin_filter_config::margin_x_th
int margin_x_th
Horizontal threshold settings.
Definition ObTypes.h:491
+
ob_multi_device_sync_config
The synchronization configuration of the device.
Definition ObTypes.h:1304
+
ob_multi_device_sync_config::depthDelayUs
int depthDelayUs
The delay time of the depth image capture after receiving the capture command or trigger signal in mi...
Definition ObTypes.h:1315
+
ob_multi_device_sync_config::framesPerTrigger
int framesPerTrigger
The frame number of each stream after each trigger in triggering mode.
Definition ObTypes.h:1361
+
ob_multi_device_sync_config::trigger2ImageDelayUs
int trigger2ImageDelayUs
The delay time of the image capture after receiving the capture command or trigger signal in microsec...
Definition ObTypes.h:1332
+
ob_multi_device_sync_config::triggerOutDelayUs
int triggerOutDelayUs
The delay time of the trigger signal output after receiving the capture command or trigger signal in ...
Definition ObTypes.h:1351
+
ob_multi_device_sync_config::syncMode
ob_multi_device_sync_mode syncMode
The sync mode of the device.
Definition ObTypes.h:1308
+
ob_multi_device_sync_config::colorDelayUs
int colorDelayUs
The delay time of the color image capture after receiving the capture command or trigger signal in mi...
Definition ObTypes.h:1322
+
ob_multi_device_sync_config::triggerOutEnable
bool triggerOutEnable
Trigger signal output enable flag.
Definition ObTypes.h:1343
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/RecordPlayback_8hpp_source.html b/doc/api/English/RecordPlayback_8hpp_source.html new file mode 100644 index 00000000..90c8d6c3 --- /dev/null +++ b/doc/api/English/RecordPlayback_8hpp_source.html @@ -0,0 +1,165 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/RecordPlayback.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
RecordPlayback.hpp
+
+
+Go to the documentation of this file.
1
+
6#pragma once
+
7
+
8#include "Types.hpp"
+
9#include <memory>
+
10
+
11struct RecorderImpl;
+
12struct PlaybackImpl;
+
13
+
14namespace ob {
+
15
+
16class Device;
+
17class Frame;
+
18class DeviceInfo;
+
19
+
20using PlaybackCallback = std::function<void(std::shared_ptr<Frame> frame)>;
+
21using MediaStateCallback = std::function<void(OBMediaState state)>;
+
22
+
23class OB_EXTENSION_API Recorder {
+
24private:
+
25 std::unique_ptr<RecorderImpl> impl_;
+
26
+
27public:
+
31 Recorder();
+
32 Recorder(std::unique_ptr<RecorderImpl> impl);
+
33
+
38 Recorder(std::shared_ptr<Device> device);
+
39
+
40 virtual ~Recorder() noexcept;
+
41
+
48 void start(const char *filename, bool async = false);
+
49
+
53 void stop();
+
54
+
60 void write(std::shared_ptr<Frame> frame);
+
61};
+
62
+
63class OB_EXTENSION_API Playback {
+
64private:
+
65 std::unique_ptr<PlaybackImpl> impl_;
+
66
+
67public:
+
72 Playback(const char *filename);
+
73 Playback(std::unique_ptr<PlaybackImpl> impl);
+
74 virtual ~Playback() noexcept;
+
75
+
81 void start(PlaybackCallback callback, OBMediaType type = OB_MEDIA_ALL);
+
82
+
86 void stop();
+
87
+
92 void setPlaybackStateCallback(MediaStateCallback state);
+
93
+
99 std::shared_ptr<DeviceInfo> getDeviceInfo();
+
100
+
106 OBCameraParam getCameraParam();
+
107};
+
108
+
109} // namespace ob
+
OBMediaState
OBMediaState
Enumeration for record playback status.
Definition ObTypes.h:697
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition ObTypes.h:28
+
OBMediaType
OBMediaType
Enumeration for types of media to record or playback.
Definition ObTypes.h:677
+
OB_MEDIA_ALL
@ OB_MEDIA_ALL
Definition ObTypes.h:689
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+
ob::DeviceInfo
A class describing device information, representing the name, id, serial number and other basic infor...
Definition Device.hpp:633
+ + +
ob::Playback::~Playback
virtual ~Playback() noexcept
+
ob::Playback::Playback
Playback(const char *filename)
Create a playback object.
+
ob::Playback::Playback
Playback(std::unique_ptr< PlaybackImpl > impl)
+ +
ob::Recorder::Recorder
Recorder()
Create a recorder for data recording.
+
ob::Recorder::~Recorder
virtual ~Recorder() noexcept
+
ob::Recorder::Recorder
Recorder(std::unique_ptr< RecorderImpl > impl)
+
ob::Recorder::Recorder
Recorder(std::shared_ptr< Device > device)
Create a recorder for data recording.
+
ob
Definition Context.hpp:16
+
ob::PlaybackCallback
std::function< void(std::shared_ptr< Frame > frame)> PlaybackCallback
Definition RecordPlayback.hpp:20
+
ob::MediaStateCallback
std::function< void(OBMediaState state)> MediaStateCallback
Definition RecordPlayback.hpp:21
+
OBCameraParam
Structure for camera parameters.
Definition ObTypes.h:456
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/StreamProfile_8hpp_source.html b/doc/api/English/StreamProfile_8hpp_source.html new file mode 100644 index 00000000..a56eddc0 --- /dev/null +++ b/doc/api/English/StreamProfile_8hpp_source.html @@ -0,0 +1,275 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/StreamProfile.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
StreamProfile.hpp
+
+
+Go to the documentation of this file.
1
+
5#pragma once
+
6
+
7#include "Types.hpp"
+
8
+
9#include <iostream>
+
10#include <memory>
+
11
+
12struct StreamProfileImpl;
+
13struct StreamProfileListImpl;
+
14
+
15namespace ob {
+
16
+
17class VideoStreamProfile;
+
18class GyroStreamProfile;
+
19class AccelStreamProfile;
+
20class Config;
+
21
+
22class OB_EXTENSION_API StreamProfile : public std::enable_shared_from_this<StreamProfile> {
+
23protected:
+
24 std::unique_ptr<StreamProfileImpl> impl_;
+
25
+
26public:
+
27 StreamProfile(std::unique_ptr<StreamProfileImpl> impl);
+
28 StreamProfile(StreamProfile &streamProfile);
+
29 virtual ~StreamProfile() noexcept;
+
30
+
36 OBFormat format() const;
+
37
+
43 OBStreamType type() const;
+
44
+
50 OBExtrinsic getExtrinsicTo(std::shared_ptr<StreamProfile> target);
+
51
+
58 template <typename T> bool is();
+
59
+
66 template <typename T> std::shared_ptr<T> as() {
+
67 if(!is<T>()) {
+
68 throw std::runtime_error("Unsupported operation. Object's type is not the required type.");
+
69 }
+
70
+
71 return std::static_pointer_cast<T>(std::const_pointer_cast<StreamProfile>(shared_from_this()));
+
72 }
+
73
+
74 friend class Sensor;
+
75 friend class Config;
+
76 friend class Pipeline;
+
77};
+
78
+
82class OB_EXTENSION_API VideoStreamProfile : public StreamProfile {
+
83public:
+
84 explicit VideoStreamProfile(StreamProfile &profile);
+
85
+
86 explicit VideoStreamProfile(std::unique_ptr<StreamProfileImpl> impl);
+
87
+
88 ~VideoStreamProfile() noexcept override;
+
89
+
95 uint32_t fps() const;
+
96
+
102 uint32_t width() const;
+
103
+
109 uint32_t height() const;
+
110
+
116 OBCameraIntrinsic getIntrinsic();
+
117
+
124 OBCameraDistortion getDistortion();
+
125};
+
126
+
130class OB_EXTENSION_API AccelStreamProfile : public StreamProfile {
+
131public:
+
132 explicit AccelStreamProfile(StreamProfile &profile);
+
133
+
134 explicit AccelStreamProfile(std::unique_ptr<StreamProfileImpl> impl);
+
135
+
136 ~AccelStreamProfile() noexcept override;
+
137
+
143 OBAccelFullScaleRange fullScaleRange() const;
+
144
+
150 OBAccelSampleRate sampleRate() const;
+
151
+
157 OBAccelIntrinsic getIntrinsic();
+
158};
+
159
+
163class OB_EXTENSION_API GyroStreamProfile : public StreamProfile {
+
164public:
+
165 explicit GyroStreamProfile(StreamProfile &profile);
+
166
+
167 explicit GyroStreamProfile(std::unique_ptr<StreamProfileImpl> impl);
+
168 ~GyroStreamProfile() noexcept override;
+
169
+
175 OBGyroFullScaleRange fullScaleRange() const;
+
176
+
182 OBGyroSampleRate sampleRate() const;
+
183
+
189 OBGyroIntrinsic getIntrinsic();
+
190};
+
191
+
192template <typename T> bool StreamProfile::is() {
+
193 switch(this->type()) {
+
194 case OB_STREAM_VIDEO:
+
195 case OB_STREAM_IR:
+
196 case OB_STREAM_IR_LEFT:
+
197 case OB_STREAM_IR_RIGHT:
+
198 case OB_STREAM_COLOR:
+
199 case OB_STREAM_DEPTH:
+
200 case OB_STREAM_RAW_PHASE:
+
201 return typeid(T) == typeid(VideoStreamProfile);
+
202 case OB_STREAM_ACCEL:
+
203 return typeid(T) == typeid(AccelStreamProfile);
+
204 case OB_STREAM_GYRO:
+
205 return typeid(T) == typeid(GyroStreamProfile);
+
206 default:
+
207 break;
+
208 }
+
209 return false;
+
210}
+
211
+
212class OB_EXTENSION_API StreamProfileList {
+
213protected:
+
214 std::unique_ptr<StreamProfileListImpl> impl_;
+
215
+
216public:
+
217 explicit StreamProfileList(std::unique_ptr<StreamProfileListImpl> impl);
+
218 ~StreamProfileList() noexcept;
+
219
+
225 uint32_t count() const;
+
226
+
233 const std::shared_ptr<StreamProfile> getProfile(uint32_t index);
+
234
+
245 const std::shared_ptr<VideoStreamProfile> getVideoStreamProfile(int width = OB_WIDTH_ANY, int height = OB_HEIGHT_ANY, OBFormat format = OB_FORMAT_ANY,
+
246 int fps = OB_FPS_ANY);
+
247
+
255 const std::shared_ptr<AccelStreamProfile> getAccelStreamProfile(OBAccelFullScaleRange fullScaleRange, OBAccelSampleRate sampleRate);
+
256
+
264 const std::shared_ptr<GyroStreamProfile> getGyroStreamProfile(OBGyroFullScaleRange fullScaleRange, OBGyroSampleRate sampleRate);
+
265};
+
266
+
267} // namespace ob
+
OBGyroFullScaleRange
OBGyroFullScaleRange
Enumeration of gyroscope ranges.
Definition ObTypes.h:600
+
OBFormat
OBFormat
Enumeration value describing the pixel format.
Definition ObTypes.h:210
+
OBAccelSampleRate
enum OBGyroSampleRate OBAccelSampleRate
+
OBGyroSampleRate
OBGyroSampleRate
Enumeration of IMU sample rate values (gyroscope or accelerometer)
Definition ObTypes.h:578
+
OBStreamType
OBStreamType
Enumeration value describing the type of data stream.
Definition ObTypes.h:174
+
OB_STREAM_RAW_PHASE
@ OB_STREAM_RAW_PHASE
Definition ObTypes.h:184
+
OB_STREAM_GYRO
@ OB_STREAM_GYRO
Definition ObTypes.h:181
+
OB_STREAM_IR
@ OB_STREAM_IR
Definition ObTypes.h:177
+
OB_STREAM_DEPTH
@ OB_STREAM_DEPTH
Definition ObTypes.h:179
+
OB_STREAM_IR_RIGHT
@ OB_STREAM_IR_RIGHT
Definition ObTypes.h:183
+
OB_STREAM_IR_LEFT
@ OB_STREAM_IR_LEFT
Definition ObTypes.h:182
+
OB_STREAM_VIDEO
@ OB_STREAM_VIDEO
Definition ObTypes.h:176
+
OB_STREAM_ACCEL
@ OB_STREAM_ACCEL
Definition ObTypes.h:180
+
OB_STREAM_COLOR
@ OB_STREAM_COLOR
Definition ObTypes.h:178
+
OBAccelFullScaleRange
OBAccelFullScaleRange
Enumeration of accelerometer ranges.
Definition ObTypes.h:615
+
OB_WIDTH_ANY
#define OB_WIDTH_ANY
Definition ObTypes.h:74
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition ObTypes.h:28
+
OB_FPS_ANY
#define OB_FPS_ANY
Definition ObTypes.h:76
+
OB_HEIGHT_ANY
#define OB_HEIGHT_ANY
Definition ObTypes.h:75
+
OB_FORMAT_ANY
#define OB_FORMAT_ANY
Definition ObTypes.h:77
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+
ob::AccelStreamProfile
Class representing an accelerometer stream profile.
Definition StreamProfile.hpp:130
+
ob::AccelStreamProfile::~AccelStreamProfile
~AccelStreamProfile() noexcept override
+
ob::AccelStreamProfile::AccelStreamProfile
AccelStreamProfile(std::unique_ptr< StreamProfileImpl > impl)
+
ob::AccelStreamProfile::AccelStreamProfile
AccelStreamProfile(StreamProfile &profile)
+
ob::Config
Config class for configuring pipeline parameters.
Definition Pipeline.hpp:201
+
ob::GyroStreamProfile
Class representing a gyroscope stream profile.
Definition StreamProfile.hpp:163
+
ob::GyroStreamProfile::GyroStreamProfile
GyroStreamProfile(StreamProfile &profile)
+
ob::GyroStreamProfile::GyroStreamProfile
GyroStreamProfile(std::unique_ptr< StreamProfileImpl > impl)
+
ob::GyroStreamProfile::~GyroStreamProfile
~GyroStreamProfile() noexcept override
+ + + +
ob::StreamProfileList::~StreamProfileList
~StreamProfileList() noexcept
+
ob::StreamProfileList::impl_
std::unique_ptr< StreamProfileListImpl > impl_
Definition StreamProfile.hpp:214
+
ob::StreamProfileList::StreamProfileList
StreamProfileList(std::unique_ptr< StreamProfileListImpl > impl)
+ +
ob::StreamProfile::~StreamProfile
virtual ~StreamProfile() noexcept
+
ob::StreamProfile::impl_
std::unique_ptr< StreamProfileImpl > impl_
Definition StreamProfile.hpp:24
+
ob::StreamProfile::StreamProfile
StreamProfile(StreamProfile &streamProfile)
+
ob::StreamProfile::StreamProfile
StreamProfile(std::unique_ptr< StreamProfileImpl > impl)
+
ob::VideoStreamProfile
Class representing a video stream profile.
Definition StreamProfile.hpp:82
+
ob::VideoStreamProfile::VideoStreamProfile
VideoStreamProfile(std::unique_ptr< StreamProfileImpl > impl)
+
ob::VideoStreamProfile::~VideoStreamProfile
~VideoStreamProfile() noexcept override
+
ob::VideoStreamProfile::VideoStreamProfile
VideoStreamProfile(StreamProfile &profile)
+
ob
Definition Context.hpp:16
+
OBAccelIntrinsic
Structure for accelerometer intrinsic parameters.
Definition ObTypes.h:386
+
OBCameraDistortion
Structure for distortion parameters.
Definition ObTypes.h:411
+
OBCameraIntrinsic
Structure for camera intrinsic parameters.
Definition ObTypes.h:374
+
OBD2CTransform
Structure for rotation/transformation.
Definition ObTypes.h:448
+
OBGyroIntrinsic
Structure for gyroscope intrinsic parameters.
Definition ObTypes.h:399
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/Types_8hpp_source.html b/doc/api/English/Types_8hpp_source.html new file mode 100644 index 00000000..033b88ce --- /dev/null +++ b/doc/api/English/Types_8hpp_source.html @@ -0,0 +1,122 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Types.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Types.hpp
+
+
+Go to the documentation of this file.
1
+
6#pragma once
+
7
+
8#include "libobsensor/h/ObTypes.h"
+
9
+
10#include <functional>
+
11
+
12#ifdef __cplusplus
+
13extern "C" {
+
14#endif
+
15
+
23using SendFileCallback = std::function<void(OBFileTranState state, const char *message, uint8_t percent)>;
+
24
+
32using DeviceUpgradeCallback = std::function<void(OBUpgradeState state, const char *message, uint8_t percent)>;
+
33
+
40using DeviceStateChangedCallback = std::function<void(OBDeviceState state, const char *message)>;
+
41
+
48using GetDataCallback = std::function<void(OBDataTranState state, OBDataChunk *dataChunk)>;
+
49
+
56using SetDataCallback = std::function<void(OBDataTranState state, uint8_t percent)>;
+
57
+
58#ifdef __cplusplus
+
59}
+
60#endif
+
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
+
OBDeviceState
uint64_t OBDeviceState
Device state.
Definition ObTypes.h:635
+
OBDataTranState
OBDataTranState
Enumeration value describing the data transfer status.
Definition ObTypes.h:292
+
OBFileTranState
OBFileTranState
Enumeration value describing the file transfer status.
Definition ObTypes.h:276
+
OBUpgradeState
OBUpgradeState
Enumeration value describing the firmware upgrade status.
Definition ObTypes.h:255
+
DeviceStateChangedCallback
std::function< void(OBDeviceState state, const char *message)> DeviceStateChangedCallback
Callback function for device status updates.
Definition Types.hpp:40
+
SetDataCallback
std::function< void(OBDataTranState state, uint8_t percent)> SetDataCallback
Callback function for setting the raw data property when progress callbacks are made.
Definition Types.hpp:56
+
DeviceUpgradeCallback
std::function< void(OBUpgradeState state, const char *message, uint8_t percent)> DeviceUpgradeCallback
Callback function for device upgrade status updates.
Definition Types.hpp:32
+
GetDataCallback
std::function< void(OBDataTranState state, OBDataChunk *dataChunk)> GetDataCallback
Callback function for getting raw data property data when data and progress callbacks are made.
Definition Types.hpp:48
+
SendFileCallback
std::function< void(OBFileTranState state, const char *message, uint8_t percent)> SendFileCallback
Callback function for file transfer status updates.
Definition Types.hpp:23
+
OBDataChunk
Structure for transmitting data blocks.
Definition ObTypes.h:309
+
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ + diff --git a/doc/api/English/Utils_8hpp_source.html b/doc/api/English/Utils_8hpp_source.html new file mode 100644 index 00000000..ec3ef42d --- /dev/null +++ b/doc/api/English/Utils_8hpp_source.html @@ -0,0 +1,141 @@ + + + + + + + +OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Utils.hpp Source File + + + + + + + + + +
+
+ + + + + + + +
+
OrbbecSDK 1.10.5 +
+
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Utils.hpp
+
+
+Go to the documentation of this file.
1
+
6#pragma once
+
7
+
8#include "Types.hpp"
+
9
+
10namespace ob {
+
11class Device;
+
12
+
13class OB_EXTENSION_API CoordinateTransformHelper {
+
14public:
+
26 static bool calibration3dTo3d(const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType,
+
27 const OBSensorType targetSensorType, OBPoint3f *targetPoint3f);
+
28
+
41 static bool calibration2dTo3d(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue,
+
42 const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f);
+
43
+
57 static bool calibration2dTo3dUndistortion(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue,
+
58 const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f);
+
59
+
71 static bool calibration3dTo2d(const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType,
+
72 const OBSensorType targetSensorType, OBPoint2f *targetPoint2f);
+
73
+
86 static bool calibration2dTo2d(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue,
+
87 const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f);
+
88
+
99 static std::shared_ptr<ob::Frame> transformationDepthFrameToColorCamera(std::shared_ptr<ob::Device> device, std::shared_ptr<ob::Frame> depthFrame,
+
100 uint32_t targetColorCameraWidth, uint32_t targetColorCameraHeight);
+
101
+
114 static bool transformationInitXYTables(const OBCalibrationParam calibrationParam, const OBSensorType sensorType, float *data, uint32_t *dataSize,
+
115 OBXYTables *xyTables);
+
116
+
125 static void transformationDepthToPointCloud(OBXYTables *xyTables, const void *depthImageData, void *pointCloudData);
+
126
+
136 static void transformationDepthToRGBDPointCloud(OBXYTables *xyTables, const void *depthImageData, const void *colorImageData, void *pointCloudData);
+
137};
+
138} // namespace ob
+
OBSensorType
OBSensorType
Enumeration value describing the sensor type.
Definition ObTypes.h:157
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition ObTypes.h:28
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes....
+ +
ob::CoordinateTransformHelper::calibration3dTo2d
static bool calibration3dTo2d(const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f)
Transform a 3d point of a source coordinate system into a 2d pixel coordinate of the target camera.
+
ob::CoordinateTransformHelper::calibration2dTo3dUndistortion
static bool calibration2dTo3dUndistortion(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f)
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point o...
+
ob::CoordinateTransformHelper::calibration2dTo2d
static bool calibration2dTo2d(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f)
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 2d pixel c...
+
ob::CoordinateTransformHelper::calibration3dTo3d
static bool calibration3dTo3d(const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f)
Transform a 3d point of a source coordinate system into a 3d point of the target coordinate system.
+
ob::CoordinateTransformHelper::transformationInitXYTables
static bool transformationInitXYTables(const OBCalibrationParam calibrationParam, const OBSensorType sensorType, float *data, uint32_t *dataSize, OBXYTables *xyTables)
Init transformation tables.
+
ob::CoordinateTransformHelper::transformationDepthFrameToColorCamera
static std::shared_ptr< ob::Frame > transformationDepthFrameToColorCamera(std::shared_ptr< ob::Device > device, std::shared_ptr< ob::Frame > depthFrame, uint32_t targetColorCameraWidth, uint32_t targetColorCameraHeight)
Transforms the depth frame into the geometry of the color camera.
+
ob::CoordinateTransformHelper::transformationDepthToPointCloud
static void transformationDepthToPointCloud(OBXYTables *xyTables, const void *depthImageData, void *pointCloudData)
Transform depth image to point cloud data.
+
ob::CoordinateTransformHelper::transformationDepthToRGBDPointCloud
static void transformationDepthToRGBDPointCloud(OBXYTables *xyTables, const void *depthImageData, const void *colorImageData, void *pointCloudData)
Transform depth image to RGBD point cloud data.
+
ob::CoordinateTransformHelper::calibration2dTo3d
static bool calibration2dTo3d(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f)
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point o...
+
ob
Definition Context.hpp:16
+
OBCalibrationParam
calibration parameters
Definition ObTypes.h:480
+
OBPoint2f
2D point structure in the SDK
Definition ObTypes.h:745
+
OBPoint
3D point structure in the SDK
Definition ObTypes.h:736
+ +
+ +
+Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +
+ +