OrbbecSDK  1.0.0
函数
Context.h 文件参考

context是描述SDK的runtime一个管理类,负责SDK的资源申请与释放 context具备多设备的管理能力,负责枚举设备,监听设备回调,启用多设备同步等功能 更多...

#include "ObTypes.h"
Context.h 的引用(Include)关系图:
此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

函数

ob_context * ob_create_context (ob_error **error)
 创建context的接口函数 更多...
 
void ob_delete_context (ob_context *context, ob_error **error)
 删除上下文环境 更多...
 
ob_device_list * ob_query_device_list (ob_context *context, ob_error **error)
 获取OS枚举设备列表 更多...
 
void ob_set_device_changed_callback (ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error)
 设置设备插拔回调函数 更多...
 
void ob_set_logger_serverity (ob_context *context, ob_log_severity log, ob_error **error)
 设置日志的等级 更多...
 
void ob_set_logger_to_file (ob_context *context, ob_log_severity log, const char *file_name, ob_error **error)
 设置输出日志到文件 更多...
 
void ob_set_logger_to_console (ob_context *context, ob_log_severity log, ob_error **error)
 设置输出日志到控制台 更多...
 
void ob_enable_multi_device_sync (ob_context *context, uint64_t repeatInterval, ob_error **error)
 启动多设备同步功能,同步已创建设备的时钟(需要使用的设备支持该功能) 更多...
 

详细描述

context是描述SDK的runtime一个管理类,负责SDK的资源申请与释放 context具备多设备的管理能力,负责枚举设备,监听设备回调,启用多设备同步等功能

在文件 Context.h 中定义.

函数说明

ob_context* ob_create_context ( ob_error **  error)

创建context的接口函数

参数
[out]error记录错误信息
返回
ob_context* 返回上下文环境
void ob_delete_context ( ob_context *  context,
ob_error **  error 
)

删除上下文环境

参数
[in]context要删除的上下文环境
[out]error记录错误信息
void ob_enable_multi_device_sync ( ob_context *  context,
uint64_t  repeatInterval,
ob_error **  error 
)

启动多设备同步功能,同步已创建设备的时钟(需要使用的设备支持该功能)

参数
[in]context上下文环境
[in]repeatInterval定时同步时间间隔(单位ms;如果repeatInterval=0,表示只同步一次,不再定时执行)
[out]error记录错误信息
ob_device_list* ob_query_device_list ( ob_context *  context,
ob_error **  error 
)

获取OS枚举设备列表

参数
[in]context上下文环境
[out]error记录错误信息
返回
ob_device_list* 返回设备列表对象
void ob_set_device_changed_callback ( ob_context *  context,
ob_device_changed_callback  callback,
void *  user_data,
ob_error **  error 
)

设置设备插拔回调函数

注意
通过回调接口返回的added和removed设备列表,在回调函数返回后会自动销毁
参数
[in]context上下文环境
[in]callback设备插拔时触发的回调
[in]user_data可以传入任意用户数据,并从回调中获取
[out]error记录错误信息
void ob_set_logger_serverity ( ob_context *  context,
ob_log_severity  log,
ob_error **  error 
)

设置日志的等级

参数
[in]context上下文环境
[in]log日志的等级
[out]error记录错误信息
void ob_set_logger_to_console ( ob_context *  context,
ob_log_severity  log,
ob_error **  error 
)

设置输出日志到控制台

参数
[in]context上下文环境
[in]log日志的等级
[out]error记录错误信息
void ob_set_logger_to_file ( ob_context *  context,
ob_log_severity  log,
const char *  file_name,
ob_error **  error 
)

设置输出日志到文件

参数
[in]context上下文环境
[in]log日志的等级
[in]file_name日志文件名
[out]error记录错误信息