OrbbecSDK  1.0.0
函数
Pipeline.h 文件参考

SDK的高级API,可以快速实现开关流,帧同步,软件滤波等功能,适用于应用,算法重点关于rgbd数据流场景。如果对实时性或需要单独 处理的同步,对齐的场景。请使用Device的Lower API的接口。 更多...

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

浏览源代码.

函数

ob_pipeline * ob_create_pipeline (ob_error **error)
 创建pipeline对象 更多...
 
ob_pipeline * ob_create_pipeline_with_device (ob_device *dev, ob_error **error)
 使用设备对象来创建pipeline对象 更多...
 
void ob_delete_pipeline (ob_pipeline *pipeline, ob_error **error)
 删除pipeline对象 更多...
 
void ob_pipeline_start (ob_pipeline *pipeline, ob_error **error)
 以默认参数启动pipeline 更多...
 
void ob_pipeline_start_with_config (ob_pipeline *pipeline, ob_config *config, ob_error **error)
 启动pipeline并配置参数 更多...
 
void ob_pipeline_start_with_callback (ob_pipeline *pipeline, ob_config *config, ob_frame_set_callback callback, void *user_data, ob_error **error)
 启动pipeline并设置帧集合数据回调 更多...
 
void ob_pipeline_stop (ob_pipeline *pipeline, ob_error **error)
 停止pipeline 更多...
 
ob_config * ob_pipeline_get_config (ob_pipeline *pipeline, ob_error **error)
 获取pipeline当前参数 更多...
 
ob_frame_set * ob_pipeline_wait_for_frames (ob_pipeline *pipeline, uint32_t timeout_ms, ob_error **error)
 以同步阻塞的形式等待返回一组帧集合 更多...
 
ob_device * ob_pipeline_get_device (ob_pipeline *pipeline, ob_error **error)
 从pipeline中获取设备 更多...
 
ob_stream_profile ** ob_pipeline_get_stream_profiles (ob_pipeline *pipeline, ob_sensor_type sensor_type, uint32_t *profile_count, ob_error **error)
 获取传感器相应的流配置 更多...
 
ob_stream_profile ** ob_pipeline_get_all_stream_profiles (ob_pipeline *pipeline, uint32_t *profile_count, ob_error **error)
 获取所有流配置 更多...
 
void ob_pipeline_enable_frame_sync (ob_pipeline *pipeline, ob_error **error)
 打开帧同步功能 更多...
 
void ob_pipeline_disable_frame_sync (ob_pipeline *pipeline, ob_error **error)
 关闭帧同步功能 更多...
 
ob_config * ob_create_config (ob_error **error)
 创建pipeline的配置 更多...
 
void ob_delete_config (ob_config *config, ob_error **error)
 删除pipeline的配置 更多...
 
void ob_config_enable_stream (ob_config *config, ob_stream_profile *profile, ob_error **error)
 配置要打开的流 更多...
 
void ob_config_enable_all_stream (ob_config *config, ob_error **error)
 配置打开所有的流 更多...
 
void ob_config_disable_stream (ob_config *config, ob_stream_type type, ob_error **error)
 配置要关闭的流 更多...
 
void ob_config_disable_all_stream (ob_config *config, ob_error **error)
 配置关闭所有的流 更多...
 
void ob_filter_reset (ob_filter *filter, ob_error **error)
 Filter重置 更多...
 
void ob_filter_process (ob_filter *filter, ob_frame *frame, ob_error **error)
 Filter 处理(同步接口) 更多...
 
bool ob_filter_start (ob_filter *filter, ob_error **error)
 Filter 启动处理线程(异步回调接口) 更多...
 
void ob_filter_stop (ob_filter *filter, ob_error **error)
 Filter 停止处理线程(异步回调接口) 更多...
 
void ob_filter_set_callback (ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error)
 Filter 设置处理结果回调函数(异步回调接口) 更多...
 
void ob_filter_push_frame (ob_filter *filter, ob_frame *frame, ob_error **error)
 filter 压入frame_set到待处理缓存(异步回调接口) 更多...
 

详细描述

SDK的高级API,可以快速实现开关流,帧同步,软件滤波等功能,适用于应用,算法重点关于rgbd数据流场景。如果对实时性或需要单独 处理的同步,对齐的场景。请使用Device的Lower API的接口。

在文件 Pipeline.h 中定义.

函数说明

void ob_config_disable_all_stream ( ob_config *  config,
ob_error **  error 
)

配置关闭所有的流

参数
[in]configpipeline的配置
[out]error记录错误信息
void ob_config_disable_stream ( ob_config *  config,
ob_stream_type  type,
ob_error **  error 
)

配置要关闭的流

参数
[in]configpipeline的配置
[in]profile要关闭的流的配置
[out]error记录错误信息
void ob_config_enable_all_stream ( ob_config *  config,
ob_error **  error 
)

配置打开所有的流

参数
[in]configpipeline的配置
[out]error记录错误信息
void ob_config_enable_stream ( ob_config *  config,
ob_stream_profile *  profile,
ob_error **  error 
)

配置要打开的流

参数
[in]configpipeline的配置
[in]profile要打开的流的配置
[out]error记录错误信息
ob_config* ob_create_config ( ob_error **  error)

创建pipeline的配置

参数
[out]error记录错误信息
返回
ob_config* 返回配置对象
ob_pipeline* ob_create_pipeline ( ob_error **  error)

创建pipeline对象

参数
[out]error记录错误信息
返回
ob_pipeline* 返回pipeline对象
ob_pipeline* ob_create_pipeline_with_device ( ob_device *  dev,
ob_error **  error 
)

使用设备对象来创建pipeline对象

参数
[in]dev用于创建pipeline的设备对象
[out]error记录错误信息
返回
ob_pipeline* 返回pipeline对象
void ob_delete_config ( ob_config *  config,
ob_error **  error 
)

删除pipeline的配置

参数
[in]config要删除的配置
[out]error记录错误信息
void ob_delete_pipeline ( ob_pipeline *  pipeline,
ob_error **  error 
)

删除pipeline对象

参数
[in]pipeline要删除的pipeline对象
[out]error记录错误信息
void ob_filter_process ( ob_filter *  filter,
ob_frame *  frame,
ob_error **  error 
)

Filter 处理(同步接口)

参数
[in]filterfilter对象
void ob_filter_push_frame ( ob_filter *  filter,
ob_frame *  frame,
ob_error **  error 
)

filter 压入frame_set到待处理缓存(异步回调接口)

参数
[in]filterfilter对象
[out]error记录错误信息
void ob_filter_reset ( ob_filter *  filter,
ob_error **  error 
)

Filter重置

参数
[in]filterfilter对象
[out]error记录错误信息
void ob_filter_set_callback ( ob_filter *  filter,
ob_filter_callback  callback,
void *  user_data,
ob_error **  error 
)

Filter 设置处理结果回调函数(异步回调接口)

参数
[in]filterfilter对象
[in]callback回调函数
[in]user_data可以传入任意用户数据指针,并从回调返回该数据指针
[out]error记录错误信息
bool ob_filter_start ( ob_filter *  filter,
ob_error **  error 
)

Filter 启动处理线程(异步回调接口)

参数
[in]filterfilter对象
[out]error记录错误信息
void ob_filter_stop ( ob_filter *  filter,
ob_error **  error 
)

Filter 停止处理线程(异步回调接口)

参数
[in]filterfilter对象
[out]error记录错误信息
void ob_pipeline_disable_frame_sync ( ob_pipeline *  pipeline,
ob_error **  error 
)

关闭帧同步功能

参数
[in]pipelinepipeline对象
[out]error记录错误信息
void ob_pipeline_enable_frame_sync ( ob_pipeline *  pipeline,
ob_error **  error 
)

打开帧同步功能

参数
[in]pipelinepipeline对象
[out]error记录错误信息
ob_stream_profile** ob_pipeline_get_all_stream_profiles ( ob_pipeline *  pipeline,
uint32_t *  profile_count,
ob_error **  error 
)

获取所有流配置

参数
[in]pipelinepipeline对象
[out]profile_count获取的流配置数量
[out]error记录错误信息
返回
ob_stream_profile** 返回流配置列表
ob_config* ob_pipeline_get_config ( ob_pipeline *  pipeline,
ob_error **  error 
)

获取pipeline当前参数

参数
[in]pipelinepipeline对象
[out]error记录错误信息
返回
ob_config* 返回pipeline参数
ob_device* ob_pipeline_get_device ( ob_pipeline *  pipeline,
ob_error **  error 
)

从pipeline中获取设备

参数
[in]pipelinepipeline对象
[out]error记录错误信息
返回
ob_device* 返回设备对象
ob_stream_profile** ob_pipeline_get_stream_profiles ( ob_pipeline *  pipeline,
ob_sensor_type  sensor_type,
uint32_t *  profile_count,
ob_error **  error 
)

获取传感器相应的流配置

参数
[in]pipelinepipeline对象
[in]sensor_type传感器类型
[out]profile_count获取的流配置数量
[out]error记录错误信息
返回
ob_stream_profile** 返回流配置列表
void ob_pipeline_start ( ob_pipeline *  pipeline,
ob_error **  error 
)

以默认参数启动pipeline

参数
[in]pipelinepipeline对象
[out]error记录错误信息
void ob_pipeline_start_with_callback ( ob_pipeline *  pipeline,
ob_config *  config,
ob_frame_set_callback  callback,
void *  user_data,
ob_error **  error 
)

启动pipeline并设置帧集合数据回调

参数
[in]pipelinepipeline对象
[in]config要配置的参数
[in]callback帧集合中的所有帧数据都到达时触发回调
[in]user_data可以传入任意用户数据,并从回调中获取
[out]error记录错误信息
void ob_pipeline_start_with_config ( ob_pipeline *  pipeline,
ob_config *  config,
ob_error **  error 
)

启动pipeline并配置参数

参数
[in]pipelinepipeline对象
[in]config要配置的参数
[out]error记录错误信息
void ob_pipeline_stop ( ob_pipeline *  pipeline,
ob_error **  error 
)

停止pipeline

参数
[in]pipelinepipeline对象
[out]error记录错误信息
ob_frame_set* ob_pipeline_wait_for_frames ( ob_pipeline *  pipeline,
uint32_t  timeout_ms,
ob_error **  error 
)

以同步阻塞的形式等待返回一组帧集合

参数
[in]pipelinepipeline对象
[in]timeout_ms等待超时时间(毫秒)
[out]error记录错误信息
返回
ob_frame_set* 返回等待的帧集合