rs2::pipeline_profile Class Reference

#include <rs_pipeline.hpp>

Public Member Functions
	pipeline_profile ()
std::vector< stream_profile >	get_streams () const
stream_profile	get_stream (rs2_stream stream_type, int stream_index=-1) const
device	get_device () const
	operator bool () const
	operator std::shared_ptr< rs2_pipeline_profile > ()
	pipeline_profile (std::shared_ptr< rs2_pipeline_profile > profile)

Friends
class	config
class	pipeline

Detailed Description

The pipeline profile includes a device and a selection of active streams, with specific profiles. The profile is a selection of the above under filters and conditions defined by the pipeline. Streams may belong to more than one sensor of the device.

Constructor & Destructor Documentation

pipeline_profile() [1/2]

rs2::pipeline_profile::pipeline_profile ( )

inline

pipeline_profile() [2/2]

rs2::pipeline_profile::pipeline_profile ( std::shared_ptr< rs2_pipeline_profile >  profile )

inline

Member Function Documentation

get_device()

device rs2::pipeline_profile::get_device ( ) const

inline

Retrieve the device used by the pipeline. The device class provides the application access to control camera additional settings - get device information, sensor options information, options value query and set, sensor specific extensions. Since the pipeline controls the device streams configuration, activation state and frames reading, calling the device API functions, which execute those operations, results in unexpected behavior. The pipeline streaming device is selected during pipeline start(). Devices of profiles, which are not returned by pipeline start() or get_active_profile(), are not guaranteed to be used by the pipeline.

Returns

rs2::device The pipeline selected device

get_stream()

stream_profile rs2::pipeline_profile::get_stream ( rs2_stream  stream_type, int  stream_index = -1  ) const

inline

Return the stream profile that is enabled for the specified stream in this profile.

Parameters

[in]	stream_type	Stream type of the desired profile
[in]	stream_index	Stream index of the desired profile. -1 for any matching.

Returns

The first matching stream profile

get_streams()

std::vector<stream_profile> rs2::pipeline_profile::get_streams ( ) const

inline

Return the selected streams profiles, which are enabled in this profile.

Returns

Vector of stream profiles

operator bool()

rs2::pipeline_profile::operator bool ( ) const

inline

Conversion to boolean value to test for the object's validity

Returns

true iff the profile is valid

operator std::shared_ptr< rs2_pipeline_profile >()

rs2::pipeline_profile::operator std::shared_ptr< rs2_pipeline_profile > ( )

inlineexplicit

Friends And Related Function Documentation

config

friend class config

friend

pipeline

friend class pipeline

friend

---

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

• C:/jenkins_sys_rsbuild/workspace/LRS_doxygen_pipeline/source/include/librealsense2/hpp/rs_pipeline.hpp