OrbbecSDK  1.5.7
OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices
Pipeline.h
Go to the documentation of this file.
1 
12 #pragma once
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 #include "ObTypes.h"
19 
34 
51 
67 ob_pipeline *ob_create_pipeline_with_playback_file(const char *file_name, ob_error **error);
68 
82 void ob_delete_pipeline(ob_pipeline *pipeline, ob_error **error);
83 
97 void ob_pipeline_start(ob_pipeline *pipeline, ob_error **error);
98 
114 void ob_pipeline_start_with_config(ob_pipeline *pipeline, ob_config *config, ob_error **error);
115 
135 void ob_pipeline_start_with_callback(ob_pipeline *pipeline, ob_config *config, ob_frameset_callback callback, void *user_data, ob_error **error);
136 
150 void ob_pipeline_stop(ob_pipeline *pipeline, ob_error **error);
151 
168 
186 ob_frame *ob_pipeline_wait_for_frameset(ob_pipeline *pipeline, uint32_t timeout_ms, ob_error **error);
187 
204 
221 
242 
256 void ob_pipeline_enable_frame_sync(ob_pipeline *pipeline, ob_error **error);
257 
271 void ob_pipeline_disable_frame_sync(ob_pipeline *pipeline, ob_error **error);
272 
288 void ob_pipeline_switch_config(ob_pipeline *pipeline, ob_config *config, ob_error **error);
289 
308 
329 
347 ob_rect ob_get_d2c_valid_area(ob_pipeline *pipeline, uint32_t distance, ob_error **error);
348 
369 ob_rect ob_get_d2c_range_valid_area(ob_pipeline *pipeline, uint32_t minimum_distance, uint32_t maximum_distance, ob_error **error);
370 
386 void ob_pipeline_start_record(ob_pipeline *pipeline, const char *file_name, ob_error **error);
387 
402 void ob_pipeline_stop_record(ob_pipeline *pipeline, ob_error **error);
403 
418 
432 void ob_delete_config(ob_config *config, ob_error **error);
433 
449 void ob_config_enable_stream(ob_config *config, ob_stream_profile *profile, ob_error **error);
450 
464 void ob_config_enable_all_stream(ob_config *config, ob_error **error);
465 
481 void ob_config_disable_stream(ob_config *config, ob_stream_type type, ob_error **error);
482 
496 void ob_config_disable_all_stream(ob_config *config, ob_error **error);
497 
513 void ob_config_set_align_mode(ob_config *config, ob_align_mode mode, ob_error **error);
514 
530 void ob_config_set_depth_scale_require(ob_config *config, bool enable, ob_error **error);
531 
552 void ob_config_set_d2c_target_resolution(ob_config *config, uint32_t d2c_target_width, uint32_t d2c_target_height, ob_error **error);
553 
573 
574 #ifdef __cplusplus
575 }
576 #endif
ob_camera_param ob_pipeline_get_camera_param(ob_pipeline *pipeline, ob_error **error)
Get current camera parameters.
ob_rect ob_get_d2c_valid_area(ob_pipeline *pipeline, uint32_t distance, ob_error **error)
Get valid area after D2C (DEPRECATED)
struct StreamProfileListImpl ob_stream_profile_list
Definition: ObTypes.h:55
struct ConfigImpl ob_config
Definition: ObTypes.h:59
enum OB_FRAME_AGGREGATE_OUTPUT_MODE ob_frame_aggregate_output_mode
void ob_config_set_depth_scale_require(ob_config *config, bool enable, ob_error **error)
Whether the depth needs to be scaled after setting D2C.
void ob_config_set_frame_aggregate_output_mode(ob_config *config, ob_frame_aggregate_output_mode mode, ob_error **error)
Frame aggregation output mode.
struct PlaybackImpl ob_playback
Definition: ObTypes.h:61
enum OBStreamType ob_stream_type
void ob_pipeline_enable_frame_sync(ob_pipeline *pipeline, ob_error **error)
Enable frame synchronization.
enum OBSensorType ob_sensor_type
ob_rect ob_get_d2c_range_valid_area(ob_pipeline *pipeline, uint32_t minimum_distance, uint32_t maximum_distance, ob_error **error)
Get valid area between minimum distance and maximum distance after D2C.
void ob_config_disable_all_stream(ob_config *config, ob_error **error)
Configure all streams to be disabled.
void ob_pipeline_start_record(ob_pipeline *pipeline, const char *file_name, ob_error **error)
Start recording.
void ob_pipeline_start(ob_pipeline *pipeline, ob_error **error)
Start the pipeline with default parameters.
Provide structs commonly used in the SDK, enumerating constant definitions.
void ob_pipeline_disable_frame_sync(ob_pipeline *pipeline, ob_error **error)
Disable frame synchronization.
ob_stream_profile_list * ob_pipeline_get_stream_profile_list(ob_pipeline *pipeline, ob_sensor_type sensorType, ob_error **error)
Get stream profile from the pipeline.
struct DeviceImpl ob_device
Definition: ObTypes.h:48
void ob_config_enable_all_stream(ob_config *config, ob_error **error)
Configure all streams to be enabled.
void ob_config_enable_stream(ob_config *config, ob_stream_profile *profile, ob_error **error)
Configure the stream to be enabled.
Camera parameters.
Definition: ObTypes.h:434
rectangle
Definition: ObTypes.h:507
void ob_config_set_align_mode(ob_config *config, ob_align_mode mode, ob_error **error)
Set the alignment mode.
void ob_pipeline_switch_config(ob_pipeline *pipeline, ob_config *config, ob_error **error)
Dynamically switch the corresponding config configuration.
ob_device * ob_pipeline_get_device(ob_pipeline *pipeline, ob_error **error)
Get device from the pipeline.
struct StreamProfileImpl ob_stream_profile
Definition: ObTypes.h:54
void ob_delete_config(ob_config *config, ob_error **error)
Delete the pipeline configuration.
struct CFrameImpl ob_frame
Definition: ObTypes.h:56
ob_config * ob_pipeline_get_config(ob_pipeline *pipeline, ob_error **error)
Get current pipeline parameters.
void ob_config_disable_stream(ob_config *config, ob_stream_type type, ob_error **error)
Configure the stream to be disabled.
void ob_delete_pipeline(ob_pipeline *pipeline, ob_error **error)
Delete pipeline objects.
ob_pipeline * ob_create_pipeline_with_device(ob_device *dev, ob_error **error)
Using device objects to create pipeline objects.
void ob_pipeline_stop_record(ob_pipeline *pipeline, ob_error **error)
Turn off recording.
ob_frame * ob_pipeline_wait_for_frameset(ob_pipeline *pipeline, uint32_t timeout_ms, ob_error **error)
Waiting for the return of a set of frames in the form of synchronous blocking.
void(* ob_frameset_callback)(ob_frame *frameset, void *user_data)
dataframe collection callback
Definition: ObTypes.h:1421
ob_pipeline * ob_create_pipeline(ob_error **error)
Create a pipeline object.
struct PipelineImpl ob_pipeline
Definition: ObTypes.h:58
void ob_pipeline_start_with_callback(ob_pipeline *pipeline, ob_config *config, ob_frameset_callback callback, void *user_data, ob_error **error)
Start the pipeline and set the frame collection data callback.
ob_stream_profile_list * ob_get_d2c_depth_profile_list(ob_pipeline *pipeline, ob_stream_profile *color_profile, ob_align_mode align_mode, ob_error **error)
Returns a list of D2C-enabled depth sensor resolutions corresponding to the input color sensor resolu...
void ob_pipeline_start_with_config(ob_pipeline *pipeline, ob_config *config, ob_error **error)
Start the pipeline with configuration parameters.
void ob_pipeline_stop(ob_pipeline *pipeline, ob_error **error)
Stop pipeline.
ob_pipeline * ob_create_pipeline_with_playback_file(const char *file_name, ob_error **error)
Use the playback file to create a pipeline object.
ob_playback * ob_pipeline_get_playback(ob_pipeline *pipeline, ob_error **error)
Get playback object from pipeline.
void ob_config_set_d2c_target_resolution(ob_config *config, uint32_t d2c_target_width, uint32_t d2c_target_height, ob_error **error)
Set the D2C target resolution, which is applicable to cases where the Color stream is not enabled usi...
ob_config * ob_create_config(ob_error **error)
Create the pipeline configuration.
enum OBAlignMode ob_align_mode
The error class exposed by the SDK, users can get detailed error information according to the erro...
Definition: ObTypes.h:142