6.2. Pipeline

Pipeline for data streaming and processing configuration.

6.2.1. Classes

6.2.1.1. Pipeline

class pyorbbecsdk.Pipeline

Bases: pybind11_object

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyorbbecsdk.pyorbbecsdk.Pipeline) -> None

  2. __init__(self: pyorbbecsdk.pyorbbecsdk.Pipeline, arg0: pyorbbecsdk.pyorbbecsdk.Device) -> None

disable_frame_sync(self: pyorbbecsdk.Pipeline) → None
enable_frame_sync(self: pyorbbecsdk.Pipeline) → None
get_camera_param(self: pyorbbecsdk.Pipeline) → pyorbbecsdk.OBCameraParam
get_config(self: pyorbbecsdk.Pipeline) → pyorbbecsdk.Config
get_d2c_depth_profile_list(self: pyorbbecsdk.Pipeline, arg0: pyorbbecsdk.StreamProfile, arg1: pyorbbecsdk.OBAlignMode) → pyorbbecsdk.StreamProfileList
get_device(self: pyorbbecsdk.Pipeline) → pyorbbecsdk.Device
get_stream_profile_list(self: pyorbbecsdk.Pipeline, arg0: pyorbbecsdk.OBSensorType) → pyorbbecsdk.StreamProfileList
start(*args, **kwargs)

Overloaded function.

  1. start(self: pyorbbecsdk.pyorbbecsdk.Pipeline, arg0: pyorbbecsdk.pyorbbecsdk.Config) -> None

  2. start(self: pyorbbecsdk.pyorbbecsdk.Pipeline, arg0: pyorbbecsdk.pyorbbecsdk.Config, arg1: collections.abc.Callable) -> None

  3. start(self: pyorbbecsdk.pyorbbecsdk.Pipeline) -> None

stop(self: pyorbbecsdk.Pipeline) → None
wait_for_frames(self: pyorbbecsdk.Pipeline, arg0: SupportsInt | SupportsIndex) → pyorbbecsdk.FrameSet

6.2.1.2. Config

class pyorbbecsdk.Config

Bases: pybind11_object

__init__(self: pyorbbecsdk.Config) → None
disable_all_stream(self: pyorbbecsdk.Config) → None
disable_stream(*args, **kwargs)

Overloaded function.

  1. disable_stream(self: pyorbbecsdk.pyorbbecsdk.Config, arg0: pyorbbecsdk.pyorbbecsdk.OBStreamType) -> None

  2. disable_stream(self: pyorbbecsdk.pyorbbecsdk.Config, arg0: pyorbbecsdk.pyorbbecsdk.OBSensorType) -> None

enable_accel_stream(self: pyorbbecsdk.Config, full_scale_range: pyorbbecsdk.OBAccelFullScaleRange = <OBAccelFullScaleRange.ACCEL_FS_UNKNOWN: -1>, sample_rate: pyorbbecsdk.OBGyroSampleRate = <OBGyroSampleRate.SAMPLE_RATE_UNKNOWN: 0>) → None
enable_all_stream(self: pyorbbecsdk.Config) → None
enable_gyro_stream(self: pyorbbecsdk.Config, full_scale_range: pyorbbecsdk.OBGyroFullScaleRange = <OBGyroFullScaleRange.FS_UNKNOWN: -1>, sample_rate: pyorbbecsdk.OBGyroSampleRate = <OBGyroSampleRate.SAMPLE_RATE_UNKNOWN: 0>) → None
enable_lidar_stream(self: pyorbbecsdk.Config, scan_rate: pyorbbecsdk.OBLiDARScanRate = <OBLiDARScanRate.LIDAR_SCAN_UNKNOWN: 0>, format: pyorbbecsdk.OBFormat = <OBFormat.UNKNOWN_FORMAT: -1>) → None
enable_stream(*args, **kwargs)

Overloaded function.

  1. enable_stream(self: pyorbbecsdk.pyorbbecsdk.Config, arg0: pyorbbecsdk.pyorbbecsdk.StreamProfile) -> None

  2. enable_stream(self: pyorbbecsdk.pyorbbecsdk.Config, arg0: pyorbbecsdk.pyorbbecsdk.OBStreamType) -> None

  3. enable_stream(self: pyorbbecsdk.pyorbbecsdk.Config, arg0: pyorbbecsdk.pyorbbecsdk.OBSensorType) -> None

enable_video_stream(*args, **kwargs)

Overloaded function.

  1. enable_video_stream(self: pyorbbecsdk.pyorbbecsdk.Config, stream_type: pyorbbecsdk.pyorbbecsdk.OBStreamType, width: typing.SupportsInt | typing.SupportsIndex = 0, height: typing.SupportsInt | typing.SupportsIndex = 0, fps: typing.SupportsInt | typing.SupportsIndex = 0, format: pyorbbecsdk.pyorbbecsdk.OBFormat = <OBFormat.UNKNOWN_FORMAT: -1>) -> None

  2. enable_video_stream(self: pyorbbecsdk.pyorbbecsdk.Config, sensor_type: pyorbbecsdk.pyorbbecsdk.OBSensorType, width: typing.SupportsInt | typing.SupportsIndex = 0, height: typing.SupportsInt | typing.SupportsIndex = 0, fps: typing.SupportsInt | typing.SupportsIndex = 0, format: pyorbbecsdk.pyorbbecsdk.OBFormat = <OBFormat.UNKNOWN_FORMAT: -1>) -> None

  3. enable_video_stream(self: pyorbbecsdk.pyorbbecsdk.Config, sensor_type: pyorbbecsdk.pyorbbecsdk.OBSensorType, decimation_config: pyorbbecsdk.pyorbbecsdk.OBHardwareDecimationConfig, fps: typing.SupportsInt | typing.SupportsIndex = 0, format: pyorbbecsdk.pyorbbecsdk.OBFormat = <OBFormat.UNKNOWN_FORMAT: -1>) -> None

get_enabled_stream_profile_list(self: pyorbbecsdk.Config) → pyorbbecsdk.StreamProfileList
set_align_mode(self: pyorbbecsdk.Config, arg0: pyorbbecsdk.OBAlignMode) → None
set_depth_scale_require(self: pyorbbecsdk.Config, arg0: bool) → None
set_frame_aggregate_output_mode(self: pyorbbecsdk.Config, arg0: pyorbbecsdk.OBFrameAggregateOutputMode) → None