ob2context.h 文件参考

#include "ob2types.h"

浏览源代码.

函数
ob2_version_t	ob2_get_version (void)
	获取 SDK 版本号 更多...
ob2_version_t	ob2_get_core_version (void)
	获取 SDK 核心版本号 更多...
void	ob2_set_log_severity_threshold (ob2_logger_type_t logger_type, ob2_log_severity_t severity, ob2_status_t *status)
	设置日志等级 更多...
void	ob2_set_log_output_directory (const char *directory, ob2_status_t *status)
	设置日志输出文件目录 更多...
ob2_context_t	ob2_create_context (ob2_status_t *status)
	创建 context 更多...
ob2_context_t	ob2_create_context_with_config (const char *config_file_path, ob2_status_t *status)
	传入配置文件创建 context 更多...
void	ob2_release_context (ob2_context_t context_handle, ob2_status_t *status)
	释放 context 更多...

函数说明

ob2_get_version()

ob2_version_t ob2_get_version

(

void

)

获取 SDK 版本号

返回

ob2_version_t 返回 SDK 版本号

被这些函数引用 ob2::context::get_version().

ob2_get_core_version()

ob2_version_t ob2_get_core_version

(

void

)

获取 SDK 核心版本号

OrbbecSDK2 其实是基于 OrbbecSDK 核心代码做的 API 封装，本接口用于获取 OrbbecSDK 核心版本号

返回

ob2_version_t 返回 SDK 版本号

被这些函数引用 ob2::context::get_core_version().

ob2_set_log_severity_threshold()

void ob2_set_log_severity_threshold	(	ob2_logger_type_t	logger_type,
		ob2_log_severity_t	severity,
		ob2_status_t *	status
	)

设置日志等级

可通过设置日志等级过滤掉一些不必要的日志输出，默认等级为 OB2_LOG_SEVERITY_INFO

参数

[in]	logger_type	日志输出类型（终端或者文件）
[in]	severity	日志等级
[out]	status	返回函数调用状态

被这些函数引用 ob2::context::set_log_severity_threshold().

ob2_set_log_output_directory()

void ob2_set_log_output_directory	(	const char *	directory,
		ob2_status_t *	status
	)

设置日志输出文件目录

日志文件名由 SDK 自动生成，输出目录默认为: ./Log，可通过本接口修改输出目录

参数

[in]	directory	日志输出目录
[out]	status	返回函数调用状态

被这些函数引用 ob2::context::set_log_output_directory().

ob2_create_context()

ob2_context_t ob2_create_context

(

ob2_status_t *

status

)

创建 context

context 用于 SDK 的生命周期管理，SDK 内部所有模块的加载及初始化，线程创建都依赖 context 的创建。

注意

不再对 SDK 内部资源进行访问时，需要调用 ob2_release_context 将 context 句柄释放，否则可能会导致内存泄漏。

参数

status

返回函数调用状态

返回

ob2_context_t 返回 context 句柄

ob2_create_context_with_config()

ob2_context_t ob2_create_context_with_config	(	const char *	config_file_path,
		ob2_status_t *	status
	)

传入配置文件创建 context

context 创建时会依据配置文件路径加载配置文件，并依据配置文件内容初始化内部各模块功能。默认配置文件路径为：./OrbbecSDKConfig_v1.0.xml

注意

不在对 SDK 内部资源进行访问时，需要调用 ob2_release_context 将 context 句柄释放，否则可能会导致内存泄漏。

参数

[in]	config_file_path	配置文件路径
[out]	status	返回函数调用状态

返回

ob2_context_t 返回 context 句柄

被这些函数引用 ob2::context::context().

ob2_release_context()

void ob2_release_context	(	ob2_context_t	context_handle,
		ob2_status_t *	status
	)

释放 context

context 用于 SDK 的生命周期管理，在 context 释放时会完成 SDK 内部各模块复位和资源释放。

参数

context_handle	context 句柄
status	返回函数调用状态

被这些函数引用 ob2::context::~context().