diff --git a/CMakeLists.txt b/CMakeLists.txt index 4a3f0e46..eddef8b0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.1.15) -project(OrbbecSDK VERSION 1.10.5 LANGUAGES C CXX) +project(OrbbecSDK VERSION 1.10.8 LANGUAGES C CXX) # Determine host platform include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/DetermineHostPlatform.cmake) diff --git a/README.md b/README.md index b750e8f2..34648857 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Orbbec SDK -![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.10.5-green) +![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.10.8-green) The Orbbec 3D camera product software development kit fully supports UVC, enabling driver-free plug-and-play. It provides both low-level and high-level APIs that are simple and easy to use, allowing developers to use it flexibly in different scenarios. @@ -157,7 +157,6 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) * OrbbecSDK C++ API user guide：[doc/tutorial/English/OrbbecSDK_C++_API_user_guide-v1.0.pdf](https://orbbec.github.io/OrbbecSDK/doc/tutorial/English/OrbbecSDK_C++_API_user_guide-v1.0.pdf) * Environment Configuration：[doc/tutorial/English/Environment_Configuration.md](doc/tutorial/English/Environment_Configuration.md) * examples: [examples/README.md](examples/README.md) -* example description: [doc/tutorial/English/Code_Sample_Description/Sample_Description(C_C++).md](doc/tutorial/English/Code_Sample_Description/Sample_Description(C_C++).md) ## Related links diff --git a/README_CN.md b/README_CN.md index c71614e2..cd7d1aa0 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,6 +1,6 @@ # OrbbecSDK -![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.10.5-green) +![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.10.8-green) Orbbec 3D 相机产品软件开发套件，全面支持 UVC，实现免驱动即插即用，提供低层和高层简单易用的 API，帮助开发者在不同场景下灵活使用。 @@ -142,7 +142,7 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) * OrbbecSDK C++ API user guide：[doc/tutorial/Chinese/OrbbecSDK_C++_API_user_guide-v1.0.pdf](https://orbbec.github.io/OrbbecSDK/doc/tutorial/Chinese/OrbbecSDK_C++_API_user_guide-v1.0.pdf) * Environment Configuration：[doc/tutorial/Chinese/Environment_Configuration.md](doc/tutorial/Chinese/Environment_Configuration.md) * 示例说明: [examples/README.md](examples/README_CN.md) -* 示例描述: [doc/tutorial/Chinese/Code_Sample_Description/Sample_Description(C_C++).md](doc/tutorial/Chinese/Code_Sample_Description/Sample_Description(C_C++).md) + ## 相关链接 diff --git a/cmake/InstallTargets.cmake b/cmake/InstallTargets.cmake index 4a3dc9c0..24e26b39 100644 --- a/cmake/InstallTargets.cmake +++ b/cmake/InstallTargets.cmake @@ -13,6 +13,8 @@ if (UNIX) DESTINATION lib FILES_MATCHING PATTERN "libOrbbecSDK.so" PATTERN "libOrbbecSDK.so.*" + PATTERN "libdepthengine.so" + PATTERN "libdepthengine.so.*" PATTERN "libOrbbecSDK.dylib" PATTERN "libOrbbecSDK.*.dylib" ) @@ -34,12 +36,15 @@ elseif (WIN32) install(DIRECTORY ${OrbbecSDK_LIBS_DIR}/ DESTINATION bin - FILES_MATCHING PATTERN "OrbbecSDK.dll" + FILES_MATCHING PATTERN "*.dll" + PATTERN ".lib" ) install(DIRECTORY ${OrbbecSDK_LIBS_DIR}/ DESTINATION lib - FILES_MATCHING PATTERN "OrbbecSDK*" + FILES_MATCHING + PATTERN "*.dll" + PATTERN ".lib" ) endif () diff --git a/doc/api/English/Context_8h.html b/doc/api/English/Context_8h.html index 5d5373e6..ca3f96ac 100644 --- a/doc/api/English/Context_8h.html +++ b/doc/api/English/Context_8h.html @@ -1,17 +1,19 @@ - - + + - - - -OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/h/Context.h File Reference + + +OrbbecSDK: /root/libobsensor/include/libobsensor/h/Context.h File Reference + @@ -19,10 +21,11 @@
- + - @@ -31,23 +34,41 @@
-
OrbbecSDK 1.10.5 +
+
OrbbecSDK +  1.10.8
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
- + - - - - + +
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
+
@@ -88,67 +103,65 @@

Go to the source code of this file.

-

+

Macros

#define ob_enable_multi_device_sync   ob_enable_device_clock_sync
 
- - - - - - - + + + + + + - + - - - + + + - + - - - + + + - + - + - + - - + + - - + + - - + + - - + + - + - +

+

Functions

ob_context * ob_create_context (ob_error **error)
 Create a context object.
 
ob_context * ob_create_context_with_config (const char *config_path, ob_error **error)
 Create a context object with a specified configuration file.
 
ob_context * ob_create_context (ob_error **error)
 Create a context object. More...
 
ob_context * ob_create_context_with_config (const char *config_path, ob_error **error)
 Create a context object with a specified configuration file. More...
 
void ob_delete_context (ob_context *context, ob_error **error)
 Delete a context object.
 Delete a context object. More...
 
ob_device_list * ob_query_device_list (ob_context *context, ob_error **error)
 Get a list of enumerated devices.
 
ob_device_list * ob_query_device_list (ob_context *context, ob_error **error)
 Get a list of enumerated devices. More...
 
void ob_enable_net_device_enumeration (ob_context *context, bool enable, ob_error **error)
 Enable or disable network device enumeration.
 Enable or disable network device enumeration. More...
 
ob_device * ob_create_net_device (ob_context *context, const char *address, uint16_t port, ob_error **error)
 Create a network device object.
 
ob_device * ob_create_net_device (ob_context *context, const char *address, uint16_t port, ob_error **error)
 Create a network device object. More...
 
void ob_set_device_changed_callback (ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error)
 Set a device plug-in callback function.
 Set a device plug-in callback function. More...
 
void ob_enable_device_clock_sync (ob_context *context, uint64_t repeatInterval, ob_error **error)
 Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported).
 Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported). More...
 
void ob_free_idle_memory (ob_context *context, ob_error **error)
 Free idle memory from the internal frame memory pool.
 Free idle memory from the internal frame memory pool. More...
 
void ob_set_logger_severity (ob_log_severity severity, ob_error **error)
 Set the global log level.
void ob_set_logger_severity (ob_log_severity severity, ob_error **error)
 Set the global log level. More...
 
void ob_set_logger_to_file (ob_log_severity severity, const char *directory, ob_error **error)
 Set the log output to a file.
void ob_set_logger_to_file (ob_log_severity severity, const char *directory, ob_error **error)
 Set the log output to a file. More...
 
void ob_set_logger_callback (ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error)
 Set the log callback function.
void ob_set_logger_callback (ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error)
 Set the log callback function. More...
 
void ob_set_logger_to_console (ob_log_severity severity, ob_error **error)
 Set the log output to the console.
void ob_set_logger_to_console (ob_log_severity severity, ob_error **error)
 Set the log output to the console. More...
 
void ob_load_license (const char *filePath, const char *key, ob_error **error)
 Load a license file.
 Load a license file. More...
 
void ob_load_license_from_data (const char *data, uint32_t dataLen, const char *key, ob_error **error)
 Load a license from data.
 Load a license from data. More...
 

Detailed Description

Context is a management class that describes the runtime of the SDK and is responsible for resource allocation and release of the SDK. Context has the ability to manage multiple devices. It is responsible for enumerating devices, monitoring device callbacks, and enabling multi-device synchronization.

-

Definition in file Context.h.

+

Definition in file Context.h.

Macro Definition Documentation

- -

◆ ob_enable_multi_device_sync

- +
@@ -158,19 +171,17 @@

-

Definition at line 93 of file Context.h.

+

Definition at line 93 of file Context.h.

Function Documentation

- -

◆ ob_create_context()

- +

- + @@ -190,14 +201,12 @@

-

◆ ob_create_context_with_config()

- +

ob_context * ob_create_context ob_context* ob_create_context ( ob_error **  error)
- + @@ -228,9 +237,7 @@

-

◆ ob_delete_context()

- +

ob_context * ob_create_context_with_config ob_context* ob_create_context_with_config ( const char *  config_path,
@@ -265,14 +272,12 @@

-

◆ ob_query_device_list()

- +

- + @@ -303,9 +308,7 @@

-

◆ ob_enable_net_device_enumeration()

- +

ob_device_list * ob_query_device_list ob_device_list* ob_query_device_list ( ob_context *  context,
@@ -336,7 +339,7 @@

Enable or disable network device enumeration.

-

After enabling, the network device will be automatically discovered and can be retrieved through ob_query_device_list. The default state can be set in the configuration file.

+

After enabling, the network device will be automatically discovered and can be retrieved through ob_query_device_list. The default state can be set in the configuration file.

Attention
Network device enumeration is performed through the GVCP protocol. If the device is not in the same subnet as the host, it will be discovered but cannot be connected.
Parameters

@@ -349,14 +352,12 @@

-

◆ ob_create_net_device()

- +

- + @@ -401,9 +402,7 @@

-

◆ ob_set_device_changed_callback()

- +

ob_device * ob_create_net_device ob_device* ob_create_net_device ( ob_context *  context,
@@ -453,9 +452,7 @@

-

◆ ob_enable_device_clock_sync()

- +

@@ -497,9 +494,7 @@

-

◆ ob_free_idle_memory()

- +

@@ -534,16 +529,14 @@

-

◆ ob_set_logger_severity()

- +

- + @@ -572,16 +565,14 @@

-

◆ ob_set_logger_to_file()

- +

void ob_set_logger_severity (ob_log_severity ob_log_severity  severity,
- + @@ -616,22 +607,20 @@

-

◆ ob_set_logger_callback()

- +

void ob_set_logger_to_file (ob_log_severity ob_log_severity  severity,
- + - + @@ -667,16 +656,14 @@

-

◆ ob_set_logger_to_console()

- +

void ob_set_logger_callback (ob_log_severity ob_log_severity  severity,
ob_log_callback ob_log_callback  callback,
- + @@ -704,9 +691,7 @@

-

◆ ob_load_license()

- +

void ob_set_logger_to_console (ob_log_severity ob_log_severity  severity,
@@ -748,9 +733,7 @@

-

◆ ob_load_license_from_data()

- +

@@ -802,7 +785,9 @@

-Generated on Sat May 11 2024 17:13:38 for OrbbecSDK by doxygen 1.9.7 +Generated on Tue Jun 4 2024 08:48:15 for OrbbecSDK by   +doxygen + 1.8.11
diff --git a/doc/api/English/Context_8h_source.html b/doc/api/English/Context_8h_source.html index 284b7641..999ec8f3 100644 --- a/doc/api/English/Context_8h_source.html +++ b/doc/api/English/Context_8h_source.html @@ -1,17 +1,19 @@ - - + + - - - -OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/h/Context.h Source File + + +OrbbecSDK: /root/libobsensor/include/libobsensor/h/Context.h Source File + @@ -19,10 +21,11 @@

- + - @@ -31,23 +34,41 @@
-
OrbbecSDK 1.10.5 +
+
OrbbecSDK +  1.10.8
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
- + - - - - + +
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
+
-
Context.h
+
+
Context.h
-Go to the documentation of this file.
1
-
7#pragma once
-
8
-
9#ifdef __cplusplus
-
10extern "C" {
-
11#endif
-
12
-
13#include "ObTypes.h"
-
14
-
21ob_context *ob_create_context(ob_error **error);
-
22
-
30ob_context *ob_create_context_with_config(const char *config_path, ob_error **error);
-
31
-
38void ob_delete_context(ob_context *context, ob_error **error);
-
39
-
47ob_device_list *ob_query_device_list(ob_context *context, ob_error **error);
-
48
-
61void ob_enable_net_device_enumeration(ob_context *context, bool enable, ob_error **error);
-
62
-
72ob_device *ob_create_net_device(ob_context *context, const char *address, uint16_t port, ob_error **error);
-
73
-
83void ob_set_device_changed_callback(ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error);
-
84
-
92void ob_enable_device_clock_sync(ob_context *context, uint64_t repeatInterval, ob_error **error);
-
93#define ob_enable_multi_device_sync ob_enable_device_clock_sync
-
94
-
101void ob_free_idle_memory(ob_context *context, ob_error **error);
-
102
-
111void ob_set_logger_severity(ob_log_severity severity, ob_error **error);
-
112
-
121void ob_set_logger_to_file(ob_log_severity severity, const char *directory, ob_error **error);
-
122
-
131void ob_set_logger_callback(ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error);
-
132
-
139void ob_set_logger_to_console(ob_log_severity severity, ob_error **error);
-
140
-
148void ob_load_license(const char *filePath, const char *key, ob_error **error);
-
149
-
158void ob_load_license_from_data(const char *data, uint32_t dataLen, const char *key, ob_error **error);
-
159
-
160#ifdef __cplusplus
-
161}
-
162#endif
-
ob_free_idle_memory
void ob_free_idle_memory(ob_context *context, ob_error **error)
Free idle memory from the internal frame memory pool.
-
ob_set_logger_callback
void ob_set_logger_callback(ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error)
Set the log callback function.
-
ob_create_net_device
ob_device * ob_create_net_device(ob_context *context, const char *address, uint16_t port, ob_error **error)
Create a network device object.
-
ob_create_context_with_config
ob_context * ob_create_context_with_config(const char *config_path, ob_error **error)
Create a context object with a specified configuration file.
-
ob_set_logger_to_console
void ob_set_logger_to_console(ob_log_severity severity, ob_error **error)
Set the log output to the console.
-
ob_load_license
void ob_load_license(const char *filePath, const char *key, ob_error **error)
Load a license file.
-
ob_set_logger_severity
void ob_set_logger_severity(ob_log_severity severity, ob_error **error)
Set the global log level.
-
ob_query_device_list
ob_device_list * ob_query_device_list(ob_context *context, ob_error **error)
Get a list of enumerated devices.
-
ob_create_context
ob_context * ob_create_context(ob_error **error)
Create a context object.
-
ob_set_logger_to_file
void ob_set_logger_to_file(ob_log_severity severity, const char *directory, ob_error **error)
Set the log output to a file.
-
ob_load_license_from_data
void ob_load_license_from_data(const char *data, uint32_t dataLen, const char *key, ob_error **error)
Load a license from data.
-
ob_set_device_changed_callback
void ob_set_device_changed_callback(ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error)
Set a device plug-in callback function.
-
ob_delete_context
void ob_delete_context(ob_context *context, ob_error **error)
Delete a context object.
-
ob_enable_device_clock_sync
void ob_enable_device_clock_sync(ob_context *context, uint64_t repeatInterval, ob_error **error)
Activates device clock synchronization to synchronize the clock of the host and all created devices (...
-
ob_enable_net_device_enumeration
void ob_enable_net_device_enumeration(ob_context *context, bool enable, ob_error **error)
Enable or disable network device enumeration.
-
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
-
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_device
struct DeviceImpl ob_device
Definition ObTypes.h:55
-
ob_log_severity
enum OBLogSeverity ob_log_severity
-
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_list
struct DeviceListImpl ob_device_list
Definition ObTypes.h:57
-
ob_context
struct ContextImpl ob_context
Definition ObTypes.h:54
-
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition ObTypes.h:146
+Go to the documentation of this file.
1 
7 #pragma once
8 
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
12 
13 #include "ObTypes.h"
14 
21 ob_context *ob_create_context(ob_error **error);
22 
30 ob_context *ob_create_context_with_config(const char *config_path, ob_error **error);
31 
38 void ob_delete_context(ob_context *context, ob_error **error);
39 
47 ob_device_list *ob_query_device_list(ob_context *context, ob_error **error);
48 
61 void ob_enable_net_device_enumeration(ob_context *context, bool enable, ob_error **error);
62 
72 ob_device *ob_create_net_device(ob_context *context, const char *address, uint16_t port, ob_error **error);
73 
83 void ob_set_device_changed_callback(ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error);
84 
92 void ob_enable_device_clock_sync(ob_context *context, uint64_t repeatInterval, ob_error **error);
93 #define ob_enable_multi_device_sync ob_enable_device_clock_sync
94 
101 void ob_free_idle_memory(ob_context *context, ob_error **error);
102 
111 void ob_set_logger_severity(ob_log_severity severity, ob_error **error);
112 
121 void ob_set_logger_to_file(ob_log_severity severity, const char *directory, ob_error **error);
122 
131 void ob_set_logger_callback(ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error);
132 
139 void ob_set_logger_to_console(ob_log_severity severity, ob_error **error);
140 
148 void ob_load_license(const char *filePath, const char *key, ob_error **error);
149 
158 void ob_load_license_from_data(const char *data, uint32_t dataLen, const char *key, ob_error **error);
159 
160 #ifdef __cplusplus
161 }
162 #endif
ob_set_logger_to_file
void ob_set_logger_to_file(ob_log_severity severity, const char *directory, ob_error **error)
Set the log output to a file.
+
ob_enable_device_clock_sync
void ob_enable_device_clock_sync(ob_context *context, uint64_t repeatInterval, ob_error **error)
Activates device clock synchronization to synchronize the clock of the host and all created devices (...
+
ob_load_license_from_data
void ob_load_license_from_data(const char *data, uint32_t dataLen, const char *key, ob_error **error)
Load a license from data.
+
ob_create_context_with_config
ob_context * ob_create_context_with_config(const char *config_path, ob_error **error)
Create a context object with a specified configuration file.
+
ob_load_license
void ob_load_license(const char *filePath, const char *key, ob_error **error)
Load a license file.
+
ob_query_device_list
ob_device_list * ob_query_device_list(ob_context *context, ob_error **error)
Get a list of enumerated devices.
+
ob_enable_net_device_enumeration
void ob_enable_net_device_enumeration(ob_context *context, bool enable, ob_error **error)
Enable or disable network device enumeration.
+
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
+
ob_create_context
ob_context * ob_create_context(ob_error **error)
Create a context object.
+
ob_device_list
struct DeviceListImpl ob_device_list
Definition: ObTypes.h:57
+
ob_device
struct DeviceImpl ob_device
Definition: ObTypes.h:55
+
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:1700
+
ob_set_logger_to_console
void ob_set_logger_to_console(ob_log_severity severity, ob_error **error)
Set the log output to the console.
+
ob_context
struct ContextImpl ob_context
Definition: ObTypes.h:54
+
ob_delete_context
void ob_delete_context(ob_context *context, ob_error **error)
Delete a context object.
+
ob_set_logger_severity
void ob_set_logger_severity(ob_log_severity severity, ob_error **error)
Set the global log level.
+
ob_free_idle_memory
void ob_free_idle_memory(ob_context *context, ob_error **error)
Free idle memory from the internal frame memory pool.
+
ob_set_device_changed_callback
void ob_set_device_changed_callback(ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error)
Set a device plug-in callback function.
+
ob_log_callback
void( ob_log_callback)(ob_log_severity severity, const char *message, void *user_data)
Callback for receiving log.
Definition: ObTypes.h:1738
+
ob_set_logger_callback
void ob_set_logger_callback(ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error)
Set the log callback function.
+
ob_create_net_device
ob_device * ob_create_net_device(ob_context *context, const char *address, uint16_t port, ob_error **error)
Create a network device object.
+
ob_log_severity
enum OBLogSeverity ob_log_severity
+
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error...
Definition: ObTypes.h:151
-Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +Generated on Tue Jun 4 2024 08:48:15 for OrbbecSDK by   +doxygen + 1.8.11
diff --git a/doc/api/English/Context_8hpp.html b/doc/api/English/Context_8hpp.html index 10002be7..3de06e03 100644 --- a/doc/api/English/Context_8hpp.html +++ b/doc/api/English/Context_8hpp.html @@ -1,17 +1,19 @@ - - + + - - - -OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Context.hpp File Reference + + +OrbbecSDK: /root/libobsensor/include/libobsensor/hpp/Context.hpp File Reference + @@ -19,10 +21,11 @@
- + - @@ -31,23 +34,41 @@
-
OrbbecSDK 1.10.5 +
+
OrbbecSDK +  1.10.8
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
- - - - + - + +
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
+
-
Context.hpp File Reference
+
+
Context.hpp File Reference
@@ -91,17 +106,17 @@

Go to the source code of this file.

-

+

Classes

class  ob::Context
 
- - +

+

Namespaces

namespace  ob
 ob
 
- @@ -109,11 +124,9 @@

Detailed Description

The SDK context class, which serves as the entry point to the underlying SDK. It is used to query device lists, handle device callbacks, and set the log level.

-

Definition in file Context.hpp.

+

Definition in file Context.hpp.

Macro Definition Documentation

- -

◆ enableMultiDeviceSync

- +

+

Macros

#define enableMultiDeviceSync   enableDeviceClockSync
 
@@ -123,14 +136,16 @@

-

Definition at line 84 of file Context.hpp.

+

Definition at line 84 of file Context.hpp.

-Generated on Sat May 11 2024 17:13:38 for OrbbecSDK by doxygen 1.9.7 +Generated on Tue Jun 4 2024 08:48:15 for OrbbecSDK by   +doxygen + 1.8.11
diff --git a/doc/api/English/Context_8hpp_source.html b/doc/api/English/Context_8hpp_source.html index 268c0f7a..93003ba1 100644 --- a/doc/api/English/Context_8hpp_source.html +++ b/doc/api/English/Context_8hpp_source.html @@ -1,17 +1,19 @@ - - + + - - - -OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Context.hpp Source File + + +OrbbecSDK: /root/libobsensor/include/libobsensor/hpp/Context.hpp Source File + @@ -19,10 +21,11 @@

- + - @@ -31,23 +34,41 @@
-
OrbbecSDK 1.10.5 +
+
OrbbecSDK +  1.10.8
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
- + - - - - + +
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
+
-
Context.hpp
+
+
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
+Go to the documentation of this file.
1 
7 #pragma once
8 
9 #include "Types.hpp"
10 
11 #include <functional>
12 #include <memory>
13 
14 struct ContextImpl;
15 
16 namespace ob {
17 class Device;
18 class DeviceInfo;
19 class DeviceList;
20 
21 class OB_EXTENSION_API Context {
22 private:
23  std::unique_ptr<ContextImpl> impl_;
24 
25 public:
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
Definition: Context.hpp:16
+ +
ob::Context::DeviceChangedCallback
std::function< void(std::shared_ptr< DeviceList > removedList, std::shared_ptr< DeviceList > addedList)> DeviceChangedCallback
Definition: Context.hpp:69
+
OBLogSeverity
OBLogSeverity
log level, the higher the level, the stronger the log filter
Definition: ObTypes.h:120
+
ob::Context::LogCallback
std::function< void(OBLogSeverity severity, const char *logMsg)> LogCallback
Log output callback function.
Definition: Context.hpp:120
+
Types.hpp
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes.h).
+
OBNetIpConfig
IP address configuration for network devices (IPv4)
Definition: ObTypes.h:1094
+
ob::DeviceInfo
A class describing device information, representing the name, id, serial number and other basic infor...
Definition: Device.hpp:640
+
ob::DeviceList
Class representing a list of devices.
Definition: Device.hpp:757
+ +
OB_DEFAULT_DECRYPT_KEY
#define OB_DEFAULT_DECRYPT_KEY
The default Decrypt Key.
Definition: ObTypes.h:1770
+
OB_EXTENSION_API
#define OB_EXTENSION_API
Definition: ObTypes.h:28
-Generated on Sat May 11 2024 17:13:37 for OrbbecSDK by doxygen 1.9.7 +Generated on Tue Jun 4 2024 08:48:15 for OrbbecSDK by   +doxygen + 1.8.11
diff --git a/doc/api/English/Device_8h.html b/doc/api/English/Device_8h.html index 5be04379..e5d57b77 100644 --- a/doc/api/English/Device_8h.html +++ b/doc/api/English/Device_8h.html @@ -1,17 +1,19 @@ - - + + - - - -OrbbecSDK: E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/h/Device.h File Reference + + +OrbbecSDK: /root/libobsensor/include/libobsensor/h/Device.h File Reference + @@ -19,10 +21,11 @@
- + - @@ -31,23 +34,41 @@
-
OrbbecSDK 1.10.5 +
+
OrbbecSDK +  1.10.8
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
- + - - - - + +
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
+