| OrbbecSDK 1.5.7 OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

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
33 ob_pipeline *ob_create_pipeline(ob_error **error);
34
50 ob_pipeline *ob_create_pipeline_with_device(ob_device *dev, ob_error **error);
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
167 ob_config *ob_pipeline_get_config(ob_pipeline *pipeline, ob_error **error);
168
186 ob_frame *ob_pipeline_wait_for_frameset(ob_pipeline *pipeline, uint32_t timeout_ms, ob_error **error);
187
203 ob_device *ob_pipeline_get_device(ob_pipeline *pipeline, ob_error **error);
204
220 ob_playback *ob_pipeline_get_playback(ob_pipeline *pipeline, ob_error **error);
221
241 ob_stream_profile_list *ob_pipeline_get_stream_profile_list(ob_pipeline *pipeline, ob_sensor_type sensorType, ob_error **error);
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
307 ob_camera_param ob_pipeline_get_camera_param(ob_pipeline *pipeline, ob_error **error);
308
328 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);
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
417 ob_config *ob_create_config(ob_error **error);
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
572 void ob_config_set_frame_aggregate_output_mode(ob_config *config, ob_frame_aggregate_output_mode mode, ob_error **error);
573
574 #ifdef __cplusplus
575 }
576 #endif
ob_pipeline_get_camera_param
ob_camera_param ob_pipeline_get_camera_param(ob_pipeline *pipeline, ob_error **error)
Get current camera parameters.
ob_get_d2c_valid_area
ob_rect ob_get_d2c_valid_area(ob_pipeline *pipeline, uint32_t distance, ob_error **error)
Get valid area after D2C (DEPRECATED)
ob_stream_profile_list
struct StreamProfileListImpl ob_stream_profile_list
Definition: ObTypes.h:55
ob_config
struct ConfigImpl ob_config
Definition: ObTypes.h:59
ob_frame_aggregate_output_mode
enum OB_FRAME_AGGREGATE_OUTPUT_MODE ob_frame_aggregate_output_mode
ob_config_set_depth_scale_require
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.
ob_config_set_frame_aggregate_output_mode
void ob_config_set_frame_aggregate_output_mode(ob_config *config, ob_frame_aggregate_output_mode mode, ob_error **error)
Frame aggregation output mode.
ob_playback
struct PlaybackImpl ob_playback
Definition: ObTypes.h:61
ob_stream_type
enum OBStreamType ob_stream_type
ob_pipeline_enable_frame_sync
void ob_pipeline_enable_frame_sync(ob_pipeline *pipeline, ob_error **error)
Enable frame synchronization.
ob_sensor_type
enum OBSensorType ob_sensor_type
ob_get_d2c_range_valid_area
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.
ob_config_disable_all_stream
void ob_config_disable_all_stream(ob_config *config, ob_error **error)
Configure all streams to be disabled.
ob_pipeline_start_record
void ob_pipeline_start_record(ob_pipeline *pipeline, const char *file_name, ob_error **error)
Start recording.
ob_pipeline_start
void ob_pipeline_start(ob_pipeline *pipeline, ob_error **error)
Start the pipeline with default parameters.
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
ob_pipeline_disable_frame_sync
void ob_pipeline_disable_frame_sync(ob_pipeline *pipeline, ob_error **error)
Disable frame synchronization.
ob_pipeline_get_stream_profile_list
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.
ob_device
struct DeviceImpl ob_device
Definition: ObTypes.h:48
ob_config_enable_all_stream
void ob_config_enable_all_stream(ob_config *config, ob_error **error)
Configure all streams to be enabled.
ob_config_enable_stream
void ob_config_enable_stream(ob_config *config, ob_stream_profile *profile, ob_error **error)
Configure the stream to be enabled.
OBCameraParam
Camera parameters.
Definition: ObTypes.h:434
OBRect
rectangle
Definition: ObTypes.h:507
ob_config_set_align_mode
void ob_config_set_align_mode(ob_config *config, ob_align_mode mode, ob_error **error)
Set the alignment mode.
ob_pipeline_switch_config
void ob_pipeline_switch_config(ob_pipeline *pipeline, ob_config *config, ob_error **error)
Dynamically switch the corresponding config configuration.
ob_pipeline_get_device
ob_device * ob_pipeline_get_device(ob_pipeline *pipeline, ob_error **error)
Get device from the pipeline.
ob_stream_profile
struct StreamProfileImpl ob_stream_profile
Definition: ObTypes.h:54
ob_delete_config
void ob_delete_config(ob_config *config, ob_error **error)
Delete the pipeline configuration.
ob_frame
struct CFrameImpl ob_frame
Definition: ObTypes.h:56
ob_pipeline_get_config
ob_config * ob_pipeline_get_config(ob_pipeline *pipeline, ob_error **error)
Get current pipeline parameters.
ob_config_disable_stream
void ob_config_disable_stream(ob_config *config, ob_stream_type type, ob_error **error)
Configure the stream to be disabled.
ob_delete_pipeline
void ob_delete_pipeline(ob_pipeline *pipeline, ob_error **error)
Delete pipeline objects.
ob_create_pipeline_with_device
ob_pipeline * ob_create_pipeline_with_device(ob_device *dev, ob_error **error)
Using device objects to create pipeline objects.
ob_pipeline_stop_record
void ob_pipeline_stop_record(ob_pipeline *pipeline, ob_error **error)
Turn off recording.
ob_pipeline_wait_for_frameset
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.
ob_frameset_callback
void(* ob_frameset_callback)(ob_frame *frameset, void *user_data)
dataframe collection callback
Definition: ObTypes.h:1421
ob_create_pipeline
ob_pipeline * ob_create_pipeline(ob_error **error)
Create a pipeline object.
ob_pipeline
struct PipelineImpl ob_pipeline
Definition: ObTypes.h:58
ob_pipeline_start_with_callback
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_get_d2c_depth_profile_list
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...
ob_pipeline_start_with_config
void ob_pipeline_start_with_config(ob_pipeline *pipeline, ob_config *config, ob_error **error)
Start the pipeline with configuration parameters.
ob_pipeline_stop
void ob_pipeline_stop(ob_pipeline *pipeline, ob_error **error)
Stop pipeline.
ob_create_pipeline_with_playback_file
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_pipeline_get_playback
ob_playback * ob_pipeline_get_playback(ob_pipeline *pipeline, ob_error **error)
Get playback object from pipeline.
ob_config_set_d2c_target_resolution
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_create_config
ob_config * ob_create_config(ob_error **error)
Create the pipeline configuration.
ob_align_mode
enum OBAlignMode ob_align_mode
ob_error
The error class exposed by the SDK, users can get detailed error information according to the erro...
Definition: ObTypes.h:142