Config class for configuring pipeline parameters. More...

#include <Pipeline.hpp>

Public Member Functions
	Config ()
	Construct a new Config object.
	Config (ob_config_t *impl)
	~Config () noexcept
	Destroy the Config object.
ob_config_t *	getImpl () const
void	enableStream (OBStreamType streamType) const
	enable a stream with a specific stream type
void	enableStream (OBSensorType sensorType) const
	Enable a stream with a specific sensor type.
void	enableStream (std::shared_ptr< const StreamProfile > streamProfile) const
	Enable a stream to be used in the pipeline.
void	enableVideoStream (OBStreamType streamType, uint32_t width=OB_WIDTH_ANY, uint32_t height=OB_HEIGHT_ANY, uint32_t fps=OB_FPS_ANY, OBFormat format=OB_FORMAT_ANY) const
	Enable a video stream to be used in the pipeline.
void	enableVideoStream (OBSensorType sensorType, uint32_t width=OB_WIDTH_ANY, uint32_t height=OB_HEIGHT_ANY, uint32_t fps=OB_FPS_ANY, OBFormat format=OB_FORMAT_ANY) const
	Enable a video stream to be used in the pipeline.
void	enableAccelStream (OBAccelFullScaleRange fullScaleRange=OB_ACCEL_FULL_SCALE_RANGE_ANY, OBAccelSampleRate sampleRate=OB_ACCEL_SAMPLE_RATE_ANY) const
	Enable an accelerometer stream to be used in the pipeline.
void	enableGyroStream (OBGyroFullScaleRange fullScaleRange=OB_GYRO_FULL_SCALE_RANGE_ANY, OBGyroSampleRate sampleRate=OB_GYRO_SAMPLE_RATE_ANY) const
	Enable a gyroscope stream to be used in the pipeline.
void	enableLiDARStream (OBLiDARScanRate scanRate=OB_LIDAR_SCAN_ANY, OBFormat format=OB_FORMAT_ANY) const
	Enable a LiDAR stream to be used in the pipeline.
void	enableAllStream ()
	Enable all streams to be used in the pipeline.
void	disableStream (OBStreamType streamType) const
	Disable a stream to be used in the pipeline.
void	disableStream (OBSensorType sensorType) const
	Disable a sensor stream to be used in the pipeline.
void	disableAllStream () const
	Disable all streams to be used in the pipeline.
std::shared_ptr< StreamProfileList >	getEnabledStreamProfileList () const
	Get the Enabled Stream Profile List.
void	setAlignMode (OBAlignMode mode) const
	Set the alignment mode.
void	setDepthScaleRequire (bool enable) const
	Set whether the depth needs to be scaled after setting D2C.
void	setFrameAggregateOutputMode (OBFrameAggregateOutputMode mode) const
	Set the frame aggregation output mode for the pipeline configuration.

Detailed Description

Config class for configuring pipeline parameters.

The Config class provides an interface for configuring pipeline parameters.

Definition at line 28 of file Pipeline.hpp.

Constructor & Destructor Documentation

◆ Config() [1/2]

ob::Config::Config ( )

inline

Construct a new Config object.

Definition at line 36 of file Pipeline.hpp.

◆ Config() [2/2]

ob::Config::Config ( ob_config_t * impl )

inlineexplicit

Definition at line 42 of file Pipeline.hpp.

◆ ~Config()

ob::Config::~Config ( )

inlinenoexcept

Destroy the Config object.

Definition at line 47 of file Pipeline.hpp.

Member Function Documentation

◆ getImpl()

ob_config_t * ob::Config::getImpl ( ) const

inline

Definition at line 53 of file Pipeline.hpp.

◆ enableStream() [1/3]

void ob::Config::enableStream ( OBStreamType streamType ) const

inline

enable a stream with a specific stream type

Parameters

[in] streamType The stream type to be enabled

Definition at line 62 of file Pipeline.hpp.

Referenced by enableStream().

◆ enableStream() [2/3]

void ob::Config::enableStream ( OBSensorType sensorType ) const

inline

Enable a stream with a specific sensor type.

Will convert sensor type to stream type automatically.

Parameters

[in] sensorType The sensor type to be enabled

Definition at line 74 of file Pipeline.hpp.

◆ enableStream() [3/3]

void ob::Config::enableStream ( std::shared_ptr< const StreamProfile > streamProfile ) const

inline

Enable a stream to be used in the pipeline.

Parameters

[in] streamProfile The stream configuration to be enabled

Definition at line 84 of file Pipeline.hpp.

◆ enableVideoStream() [1/2]

void ob::Config::enableVideoStream	(	OBStreamType	streamType,
		uint32_t	width = OB_WIDTH_ANY,
		uint32_t	height = OB_HEIGHT_ANY,
		uint32_t	fps = OB_FPS_ANY,
		OBFormat	format = OB_FORMAT_ANY ) const

inline

Enable a video stream to be used in the pipeline.

This function allows users to enable a video stream with customizable parameters. If no parameters are specified, the stream will be enabled with default resolution settings. Users who wish to set custom resolutions should refer to the product manual, as available resolutions vary by camera model.

Parameters

[in]	streamType	The video stream type.
[in]	width	The video stream width (default is OB_WIDTH_ANY, which selects the default resolution).
[in]	height	The video stream height (default is OB_HEIGHT_ANY, which selects the default resolution).
[in]	fps	The video stream frame rate (default is OB_FPS_ANY, which selects the default frame rate).
[in]	format	The video stream format (default is OB_FORMAT_ANY, which selects the default format).

Definition at line 104 of file Pipeline.hpp.

Referenced by enableVideoStream().

◆ enableVideoStream() [2/2]

void ob::Config::enableVideoStream	(	OBSensorType	sensorType,
		uint32_t	width = OB_WIDTH_ANY,
		uint32_t	height = OB_HEIGHT_ANY,
		uint32_t	fps = OB_FPS_ANY,
		OBFormat	format = OB_FORMAT_ANY ) const

inline

Enable a video stream to be used in the pipeline.

Will convert sensor type to stream type automatically.

Parameters

[in]	sensorType	The sensor type to be enabled.
[in]	width	The video stream width (default is OB_WIDTH_ANY, which selects the default resolution).
[in]	height	The video stream height (default is OB_HEIGHT_ANY, which selects the default resolution).
[in]	fps	The video stream frame rate (default is OB_FPS_ANY, which selects the default frame rate).
[in]	format	The video stream format (default is OB_FORMAT_ANY, which selects the default format).

Definition at line 121 of file Pipeline.hpp.

◆ enableAccelStream()

void ob::Config::enableAccelStream	(	OBAccelFullScaleRange	fullScaleRange = OB_ACCEL_FULL_SCALE_RANGE_ANY,
		OBAccelSampleRate	sampleRate = OB_ACCEL_SAMPLE_RATE_ANY ) const

inline

Enable an accelerometer stream to be used in the pipeline.

This function allows users to enable an accelerometer stream with customizable parameters. If no parameters are specified, the stream will be enabled with default settings. Users who wish to set custom full-scale ranges or sample rates should refer to the product manual, as available settings vary by device model.

Parameters

[in]	fullScaleRange	The full-scale range of the accelerometer (default is OB_ACCEL_FULL_SCALE_RANGE_ANY, which selects the default range).
[in]	sampleRate	The sample rate of the accelerometer (default is OB_ACCEL_SAMPLE_RATE_ANY, which selects the default rate).

Definition at line 137 of file Pipeline.hpp.

◆ enableGyroStream()

void ob::Config::enableGyroStream	(	OBGyroFullScaleRange	fullScaleRange = OB_GYRO_FULL_SCALE_RANGE_ANY,
		OBGyroSampleRate	sampleRate = OB_GYRO_SAMPLE_RATE_ANY ) const

inline

Enable a gyroscope stream to be used in the pipeline.

This function allows users to enable a gyroscope stream with customizable parameters. If no parameters are specified, the stream will be enabled with default settings. Users who wish to set custom full-scale ranges or sample rates should refer to the product manual, as available settings vary by device model.

Parameters

[in]	fullScaleRange	The full-scale range of the gyroscope (default is OB_GYRO_FULL_SCALE_RANGE_ANY, which selects the default range).
[in]	sampleRate	The sample rate of the gyroscope (default is OB_GYRO_SAMPLE_RATE_ANY, which selects the default rate).

Definition at line 154 of file Pipeline.hpp.

◆ enableLiDARStream()

void ob::Config::enableLiDARStream	(	OBLiDARScanRate	scanRate = OB_LIDAR_SCAN_ANY,
		OBFormat	format = OB_FORMAT_ANY ) const

inline

Enable a LiDAR stream to be used in the pipeline.

This function allows users to enable a LiDAR stream with customizable parameters. If no parameters are specified, the stream will be enabled with default settings. Users who wish to set custom full-scale ranges or sample rates should refer to the product manual, as available settings vary by device model.

Parameters

[in]	scanRate	The scan rate of the LiDAR (default is OB_LIDAR_SCAN_ANY, which selects the default scan rate).
[in]	format	The stream format (default is OB_FORMAT_ANY, which selects the default format).

Definition at line 170 of file Pipeline.hpp.

◆ enableAllStream()

void ob::Config::enableAllStream ( )

inline

Enable all streams to be used in the pipeline.

Deprecated: Use enableStream(std::shared_ptr<StreamProfile> streamProfile) instead

Definition at line 180 of file Pipeline.hpp.

◆ disableStream() [1/2]

void ob::Config::disableStream ( OBStreamType streamType ) const

inline

Disable a stream to be used in the pipeline.

Parameters

[in] streamType The stream configuration to be disabled

Definition at line 191 of file Pipeline.hpp.

Referenced by disableStream().

◆ disableStream() [2/2]

void ob::Config::disableStream ( OBSensorType sensorType ) const

inline

Disable a sensor stream to be used in the pipeline.

Will convert sensor type to stream type automatically.

Parameters

[in] sensorType The sensor configuration to be disabled

Definition at line 203 of file Pipeline.hpp.

◆ disableAllStream()

void ob::Config::disableAllStream ( ) const

inline

Disable all streams to be used in the pipeline.

Definition at line 211 of file Pipeline.hpp.

◆ getEnabledStreamProfileList()

std::shared_ptr< StreamProfileList > ob::Config::getEnabledStreamProfileList ( ) const

inline

Get the Enabled Stream Profile List.

Returns: std::shared_ptr<StreamProfileList>

Definition at line 222 of file Pipeline.hpp.

◆ setAlignMode()

void ob::Config::setAlignMode ( OBAlignMode mode ) const

inline

Set the alignment mode.

Parameters

[in] mode The alignment mode

Definition at line 234 of file Pipeline.hpp.

◆ setDepthScaleRequire()

void ob::Config::setDepthScaleRequire ( bool enable ) const

inline

Set whether the depth needs to be scaled after setting D2C.

Parameters

[in] enable Whether scaling is required

Definition at line 245 of file Pipeline.hpp.

◆ setFrameAggregateOutputMode()

void ob::Config::setFrameAggregateOutputMode ( OBFrameAggregateOutputMode mode ) const

inline

Set the frame aggregation output mode for the pipeline configuration.

The processing strategy when the FrameSet generated by the frame aggregation function does not contain the frames of all opened streams (which can be caused by different frame rates of each stream, or by the loss of frames of one stream): drop directly or output to the user.

Parameters

[in] mode The frame aggregation output mode to be set (default mode is OB_FRAME_AGGREGATE_OUTPUT_ANY_SITUATION)

Definition at line 258 of file Pipeline.hpp.

The documentation for this class was generated from the following file:

Pipeline.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Config() [1/2]

◆ Config() [2/2]

◆ ~Config()

Member Function Documentation

◆ getImpl()

◆ enableStream() [1/3]

◆ enableStream() [2/3]

◆ enableStream() [3/3]

◆ enableVideoStream() [1/2]

◆ enableVideoStream() [2/2]

◆ enableAccelStream()

◆ enableGyroStream()

◆ enableLiDARStream()

◆ enableAllStream()

◆ disableStream() [1/2]

◆ disableStream() [2/2]

◆ disableAllStream()

◆ getEnabledStreamProfileList()

◆ setAlignMode()

◆ setDepthScaleRequire()

◆ setFrameAggregateOutputMode()