Class pipeline_profile
Defined in File rs_pipeline.hpp
Class Documentation
-
class pipeline_profile
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.
Public Functions
-
inline pipeline_profile()
-
inline std::vector<stream_profile> get_streams() const
Return the selected streams profiles, which are enabled in this profile.
- Returns:
Vector of stream profiles
-
inline stream_profile get_stream(rs2_stream stream_type, int stream_index = -1) const
Return the stream profile that is enabled for the specified stream in this profile.
- Parameters:
stream_type – [in] Stream type of the desired profile
stream_index – [in] Stream index of the desired profile. -1 for any matching.
- Returns:
The first matching stream profile
-
inline device get_device() const
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 pipelinestart()orget_active_profile(), are not guaranteed to be used by the pipeline.- Returns:
rs2::device The pipeline selected device
-
inline operator bool() const
Conversion to boolean value to test for the object’s validity
- Returns:
true iff the profile is valid
-
inline pipeline_profile()