OrbbecSDK  1.0.0
Pipeline.h
浏览该文件的文档.
1 
6 #pragma once
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include "ObTypes.h"
13 
20 ob_pipeline* ob_create_pipeline( ob_error** error );
21 
29 ob_pipeline* ob_create_pipeline_with_device( ob_device* dev, ob_error** error );
30 
37 void ob_delete_pipeline( ob_pipeline* pipeline, ob_error** error );
38 
45 void ob_pipeline_start( ob_pipeline* pipeline, ob_error** error );
46 
54 void ob_pipeline_start_with_config( ob_pipeline* pipeline, ob_config* config, ob_error** error );
55 
65 void ob_pipeline_start_with_callback( ob_pipeline* pipeline, ob_config* config, ob_frame_set_callback callback, void* user_data, ob_error** error );
66 
73 void ob_pipeline_stop( ob_pipeline* pipeline, ob_error** error );
74 
82 ob_config* ob_pipeline_get_config( ob_pipeline* pipeline, ob_error** error );
83 
92 ob_frame_set* ob_pipeline_wait_for_frames( ob_pipeline* pipeline, uint32_t timeout_ms, ob_error** error );
93 
101 ob_device* ob_pipeline_get_device( ob_pipeline* pipeline, ob_error** error );
102 
112 ob_stream_profile** ob_pipeline_get_stream_profiles( ob_pipeline* pipeline, ob_sensor_type sensor_type, uint32_t* profile_count, ob_error** error );
113 
122 ob_stream_profile** ob_pipeline_get_all_stream_profiles( ob_pipeline* pipeline, uint32_t* profile_count, ob_error** error );
123 
130 void ob_pipeline_enable_frame_sync( ob_pipeline* pipeline, ob_error** error );
131 
138 void ob_pipeline_disable_frame_sync( ob_pipeline* pipeline, ob_error** error );
139 
146 ob_config* ob_create_config( ob_error** error );
147 
154 void ob_delete_config( ob_config* config, ob_error** error );
155 
163 void ob_config_enable_stream( ob_config* config, ob_stream_profile* profile, ob_error** error );
164 
171 void ob_config_enable_all_stream( ob_config* config, ob_error** error );
172 
180 void ob_config_disable_stream( ob_config* config, ob_stream_type type, ob_error** error );
181 
188 void ob_config_disable_all_stream( ob_config* config, ob_error** error );
189 
196 void ob_filter_reset( ob_filter* filter, ob_error** error );
197 
205 void ob_filter_process( ob_filter* filter, ob_frame* frame, ob_error** error );
206 
213 bool ob_filter_start( ob_filter* filter, ob_error** error );
214 
221 void ob_filter_stop( ob_filter* filter, ob_error** error );
222 
231 void ob_filter_set_callback( ob_filter* filter, ob_filter_callback callback, void* user_data, ob_error** error );
232 
239 void ob_filter_push_frame( ob_filter* filter, ob_frame* frame, ob_error** error );
240 
241 #ifdef __cplusplus
242 }
243 #endif
void ob_config_disable_all_stream(ob_config *config, ob_error **error)
配置关闭所有的流
提供SDK常用的的结构体、枚举常量定义。
void ob_pipeline_enable_frame_sync(ob_pipeline *pipeline, ob_error **error)
打开帧同步功能
ob_pipeline * ob_create_pipeline_with_device(ob_device *dev, ob_error **error)
使用设备对象来创建pipeline对象
void ob_pipeline_start_with_config(ob_pipeline *pipeline, ob_config *config, ob_error **error)
启动pipeline并配置参数
ob_config * ob_create_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并设置帧集合数据回调
ob_device * ob_pipeline_get_device(ob_pipeline *pipeline, ob_error **error)
从pipeline中获取设备
void ob_filter_push_frame(ob_filter *filter, ob_frame *frame, ob_error **error)
filter 压入frame_set到待处理缓存(异步回调接口)
void ob_filter_set_callback(ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error)
Filter 设置处理结果回调函数(异步回调接口)
void ob_config_enable_all_stream(ob_config *config, ob_error **error)
配置打开所有的流
void ob_pipeline_disable_frame_sync(ob_pipeline *pipeline, ob_error **error)
关闭帧同步功能
void ob_filter_reset(ob_filter *filter, ob_error **error)
Filter重置
ob_stream_profile ** ob_pipeline_get_all_stream_profiles(ob_pipeline *pipeline, uint32_t *profile_count, ob_error **error)
获取所有流配置
void ob_config_disable_stream(ob_config *config, ob_stream_type type, ob_error **error)
配置要关闭的流
ob_frame_set * ob_pipeline_wait_for_frames(ob_pipeline *pipeline, uint32_t timeout_ms, ob_error **error)
以同步阻塞的形式等待返回一组帧集合
void ob_filter_process(ob_filter *filter, ob_frame *frame, ob_error **error)
Filter 处理(同步接口)
ob_sensor_type
描述传感器类型的枚举值
Definition: ObTypes.h:341
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_type
描述数据流类型的枚举值
Definition: ObTypes.h:353
ob_config * ob_pipeline_get_config(ob_pipeline *pipeline, ob_error **error)
获取pipeline当前参数
ob_pipeline * ob_create_pipeline(ob_error **error)
创建pipeline对象
void ob_filter_stop(ob_filter *filter, ob_error **error)
Filter 停止处理线程(异步回调接口)
void ob_config_enable_stream(ob_config *config, ob_stream_profile *profile, ob_error **error)
配置要打开的流
void ob_pipeline_start(ob_pipeline *pipeline, ob_error **error)
以默认参数启动pipeline
bool ob_filter_start(ob_filter *filter, ob_error **error)
Filter 启动处理线程(异步回调接口)
void ob_delete_pipeline(ob_pipeline *pipeline, ob_error **error)
删除pipeline对象
void ob_delete_config(ob_config *config, ob_error **error)
删除pipeline的配置
void ob_pipeline_stop(ob_pipeline *pipeline, ob_error **error)
停止pipeline
SDK的对外暴露的错误类,用户可以根据该错误类,获取详细的错误信息 ob_status: 描述错误的状态码,作为兼容...
Definition: ObTypes.h:329