Context.h

Go to the documentation of this file.

// Copyright (c) Orbbec Inc. All Rights Reserved.
// Licensed under the MIT License.

#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ObTypes.h"

OB_EXPORT ob_context *ob_create_context(ob_error **error);

OB_EXPORT ob_context *ob_create_context_with_config(const char *config_file_path, ob_error **error);

OB_EXPORT void ob_delete_context(ob_context *context, ob_error **error);

OB_EXPORT ob_device_list *ob_query_device_list(ob_context *context, ob_error **error);

OB_EXPORT void ob_enable_net_device_enumeration(ob_context *context, bool enable, ob_error **error);

OB_EXPORT bool ob_force_ip_config(const char *macAddress, ob_net_ip_config config, ob_error **error);

OB_EXPORT bool ob_send_action_command(uint32_t deviceKey, uint32_t groupKey, uint32_t groupMask, const char *destIp, uint64_t scheduledTime, ob_error **error);

OB_EXPORT void ob_set_gvcp_port_scheme(ob_context *context, ob_gvcp_port_scheme scheme, ob_error **error);

OB_EXPORT ob_gvcp_port_scheme ob_get_gvcp_port_scheme(ob_context *context, ob_error **error);

OB_EXPORT ob_device *ob_create_net_device(ob_context *context, const char *address, uint16_t port, ob_error **error);

OB_EXPORT ob_device *ob_create_net_device_ex(ob_context *context, const char *address, uint16_t port, ob_device_access_mode accessMode, ob_error **error);

OB_EXPORT void ob_set_device_changed_callback(ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error);

OB_EXPORT ob_callback_id ob_register_device_changed_callback(ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error);

OB_EXPORT void ob_unregister_device_changed_callback(ob_context *context, ob_callback_id callback_id, ob_error **error);

OB_EXPORT void ob_enable_device_clock_sync(ob_context *context, uint64_t repeat_interval_msec, ob_error **error);

OB_EXPORT void ob_sync_device_hardware_pps_time(ob_context *context, uint64_t hardware_pps_time, ob_error **error);

OB_EXPORT void ob_free_idle_memory(ob_context *context, ob_error **error);

OB_EXPORT void ob_set_uvc_backend_type(ob_context *context, ob_uvc_backend_type backend_type, ob_error **error);

OB_EXPORT void ob_set_logger_severity(ob_log_severity severity, ob_error **error);

OB_EXPORT void ob_set_logger_to_file(ob_log_severity severity, const char *directory, ob_error **error);

OB_EXPORT void ob_set_logger_file_name(const char *file_name, ob_error **error);

OB_EXPORT void ob_set_logger_to_callback(ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error);

OB_EXPORT void ob_set_logger_to_console(ob_log_severity severity, ob_error **error);

OB_EXPORT void ob_log_external_message(ob_log_severity severity, const char *module, const char *message, const char *file, const char *func, int line,
                                       ob_error **error);

OB_EXPORT void ob_set_extensions_directory(const char *directory, ob_error **error);
 

OB_EXPORT void ob_context_set_timestamp_clock_type(ob_context *context, ob_clock_type clock_type, ob_error **error);

OB_EXPORT ob_clock_type ob_context_get_timestamp_clock_type(const ob_context *context, ob_error **error);
 
// The following interfaces are deprecated and are retained here for compatibility purposes.
#define ob_enable_multi_device_sync ob_enable_device_clock_sync
#define ob_set_logger_callback ob_set_logger_to_callback
 
#ifdef __cplusplus
}
#endif