| OrbbecSDK 1.10.18 OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras

Loading...
Searching...
No Matches
Context.h
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
177 void ob_set_uvc_backend(ob_context *context, ob_uvc_backend uvc_backend, ob_error **error);
178
179#ifdef __cplusplus
180}
181#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_uvc_backend
void ob_set_uvc_backend(ob_context *context, ob_uvc_backend uvc_backend, ob_error **error)
Set the UVC backend for the specified context This function configures the Universal Video Class (UVC...
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:1747
ob_device
struct DeviceImpl ob_device
Definition ObTypes.h:55
ob_uvc_backend
enum UVC_BACKEND ob_uvc_backend
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:1785
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:151