The config allows pipeline users to request filters for the pipeline streams and device selection and configuration.
This is an optional step in pipeline creation, as the pipeline resolves its streaming device internally. Config provides its users a way to set the filters and test if there is no conflict with the pipeline requirements from the device. It also allows the user to find a matching device for the config filters and the pipeline, in order to select a device explicitly, and modify its controls before streaming starts.
Definition at line 124 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
Public Member Functions | |
| config () | |
| void | enable_stream (rs2_stream stream_type, int stream_index, int width, int height, rs2_format format=RS2_FORMAT_ANY, int framerate=0) |
| Enable a device stream explicitly, with selected stream parameters. More... | |
| void | enable_stream (rs2_stream stream_type, int stream_index=-1) |
| Stream type and possibly also stream index. More... | |
| void | enable_stream (rs2_stream stream_type, int width, int height, rs2_format format=RS2_FORMAT_ANY, int framerate=0) |
| Stream type and resolution, and possibly format and frame rate. More... | |
| void | enable_stream (rs2_stream stream_type, rs2_format format, int framerate=0) |
| Stream type and format, and possibly frame rate. More... | |
| void | enable_stream (rs2_stream stream_type, int stream_index, rs2_format format, int framerate=0) |
| Stream type, index, and format, and possibly framerate. More... | |
| void | enable_all_streams () |
| Enable all device streams explicitly. More... | |
| void | enable_device (const std::string &serial) |
| Select a specific device explicitly by its serial number, to be used by the pipeline. More... | |
| void | enable_device_from_file (const std::string &file_name, bool repeat_playback=true) |
| Select a recorded device from a file, to be used by the pipeline through playback. More... | |
| void | enable_record_to_file (const std::string &file_name) |
| Requires that the resolved device would be recorded to file. More... | |
| void | disable_stream (rs2_stream stream, int index=-1) |
| Disable a device stream explicitly, to remove any requests on this stream profile. More... | |
| void | disable_all_streams () |
| Disable all device stream explicitly, to remove any requests on the streams profiles. More... | |
| pipeline_profile | resolve (std::shared_ptr< rs2_pipeline > p) const |
| Resolve the configuration filters, to find a matching device and streams profiles. More... | |
| bool | can_resolve (std::shared_ptr< rs2_pipeline > p) const |
| Check if the config can resolve the configuration filters, to find a matching device and streams profiles. More... | |
| std::shared_ptr< rs2_config > | get () const |
| operator std::shared_ptr< rs2_config > () const | |
| config (std::shared_ptr< rs2_config > cfg) | |
| config () | |
| void | enable_stream (rs2_stream stream_type, int stream_index, int width, int height, rs2_format format=RS2_FORMAT_ANY, int framerate=0) |
| Enable a device stream explicitly, with selected stream parameters. More... | |
| void | enable_stream (rs2_stream stream_type, int stream_index=-1) |
| Stream type and possibly also stream index. More... | |
| void | enable_stream (rs2_stream stream_type, int width, int height, rs2_format format=RS2_FORMAT_ANY, int framerate=0) |
| Stream type and resolution, and possibly format and frame rate. More... | |
| void | enable_stream (rs2_stream stream_type, rs2_format format, int framerate=0) |
| Stream type and format, and possibly frame rate. More... | |
| void | enable_stream (rs2_stream stream_type, int stream_index, rs2_format format, int framerate=0) |
| Stream type, index, and format, and possibly framerate. More... | |
| void | enable_all_streams () |
| Enable all device streams explicitly. More... | |
| void | enable_device (const std::string &serial) |
| Select a specific device explicitly by its serial number, to be used by the pipeline. More... | |
| void | enable_device_from_file (const std::string &file_name, bool repeat_playback=true) |
| Select a recorded device from a file, to be used by the pipeline through playback. More... | |
| void | enable_record_to_file (const std::string &file_name) |
| Requires that the resolved device would be recorded to file. More... | |
| void | disable_stream (rs2_stream stream, int index=-1) |
| Disable a device stream explicitly, to remove any requests on this stream profile. More... | |
| void | disable_all_streams () |
| Disable all device stream explicitly, to remove any requests on the streams profiles. More... | |
| pipeline_profile | resolve (std::shared_ptr< rs2_pipeline > p) const |
| Resolve the configuration filters, to find a matching device and streams profiles. More... | |
| bool | can_resolve (std::shared_ptr< rs2_pipeline > p) const |
| Check if the config can resolve the configuration filters, to find a matching device and streams profiles. More... | |
| std::shared_ptr< rs2_config > | get () const |
| operator std::shared_ptr< rs2_config > () const | |
| config (std::shared_ptr< rs2_config > cfg) | |
|
inline |
Definition at line 127 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), rs2_create_config(), and rs2_delete_config().
|
inline |
Definition at line 349 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
|
inline |
Definition at line 127 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), rs2_create_config(), and rs2_delete_config().
|
inline |
Definition at line 349 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
|
inline |
Check if the config can resolve the configuration filters, to find a matching device and streams profiles.
The resolution conditions are as described in resolve().
| [in] | p | The pipeline for which the selected filters are applied |
Definition at line 332 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_can_resolve().
|
inline |
Check if the config can resolve the configuration filters, to find a matching device and streams profiles.
The resolution conditions are as described in resolve().
| [in] | p | The pipeline for which the selected filters are applied |
Definition at line 332 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_can_resolve().
|
inline |
Disable all device stream explicitly, to remove any requests on the streams profiles.
The streams can still be enabled due to pipeline computer vision module request. This call removes any filter on the streams configuration.
Definition at line 289 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_disable_all_streams().
|
inline |
Disable all device stream explicitly, to remove any requests on the streams profiles.
The streams can still be enabled due to pipeline computer vision module request. This call removes any filter on the streams configuration.
Definition at line 289 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_disable_all_streams().
|
inline |
Disable a device stream explicitly, to remove any requests on this stream profile.
The stream can still be enabled due to pipeline computer vision module request. This call removes any filter on the stream configuration.
| [in] | stream | Stream type, for which the filters are cleared |
Definition at line 277 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_disable_indexed_stream().
|
inline |
Disable a device stream explicitly, to remove any requests on this stream profile.
The stream can still be enabled due to pipeline computer vision module request. This call removes any filter on the stream configuration.
| [in] | stream | Stream type, for which the filters are cleared |
Definition at line 277 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_disable_indexed_stream().
|
inline |
Enable all device streams explicitly.
The conditions and behavior of this method are similar to those of enable_stream(). This filter enables all raw streams of the selected device. The device is either selected explicitly by the application, or by the pipeline requirements or default. The list of streams is device dependent.
Definition at line 219 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_all_stream().
|
inline |
Enable all device streams explicitly.
The conditions and behavior of this method are similar to those of enable_stream(). This filter enables all raw streams of the selected device. The device is either selected explicitly by the application, or by the pipeline requirements or default. The list of streams is device dependent.
Definition at line 219 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_all_stream().
|
inline |
Select a specific device explicitly by its serial number, to be used by the pipeline.
The conditions and behavior of this method are similar to those of enable_stream(). This method is required if the application needs to set device or sensor settings prior to pipeline streaming, to enforce the pipeline to use the configured device.
| [in] | serial | device serial number, as returned by RS2_CAMERA_INFO_SERIAL_NUMBER |
Definition at line 234 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_device().
|
inline |
Select a specific device explicitly by its serial number, to be used by the pipeline.
The conditions and behavior of this method are similar to those of enable_stream(). This method is required if the application needs to set device or sensor settings prior to pipeline streaming, to enforce the pipeline to use the configured device.
| [in] | serial | device serial number, as returned by RS2_CAMERA_INFO_SERIAL_NUMBER |
Definition at line 234 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_device().
|
inline |
Select a recorded device from a file, to be used by the pipeline through playback.
The device available streams are as recorded to the file, and resolve() considers only this device and configuration as available. This request cannot be used if enable_record_to_file() is called for the current config, and vice versa.
| [in] | file_name | The playback file of the device |
Definition at line 249 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_device_from_file_repeat_option().
|
inline |
Select a recorded device from a file, to be used by the pipeline through playback.
The device available streams are as recorded to the file, and resolve() considers only this device and configuration as available. This request cannot be used if enable_record_to_file() is called for the current config, and vice versa.
| [in] | file_name | The playback file of the device |
Definition at line 249 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_device_from_file_repeat_option().
|
inline |
Requires that the resolved device would be recorded to file.
This request cannot be used if enable_device_from_file() is called for the current config, and vice versa. as available.
| [in] | file_name | The desired file for the output record |
Definition at line 263 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_record_to_file().
|
inline |
Requires that the resolved device would be recorded to file.
This request cannot be used if enable_device_from_file() is called for the current config, and vice versa. as available.
| [in] | file_name | The desired file for the output record |
Definition at line 263 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), and rs2_config_enable_record_to_file().
|
inline |
Enable a device stream explicitly, with selected stream parameters.
The method allows the application to request a stream with specific configuration. If no stream is explicitly enabled, the pipeline configures the device and its streams according to the attached computer vision modules and processing blocks requirements, or default configuration for the first available device. The application can configure any of the input stream parameters according to its requirement, or set to 0 for don't care value. The config accumulates the application calls for enable configuration methods, until the configuration is applied. Multiple enable stream calls for the same stream override each other, and the last call is maintained. Upon calling resolve(), the config checks for conflicts between the application configuration requests and the attached computer vision modules and processing blocks requirements, and fails if conflicts are found. Before resolve() is called, no conflict check is done.
| [in] | stream_type | Stream type to be enabled |
| [in] | stream_index | Stream index, used for multiple streams of the same type. -1 indicates any. |
| [in] | width | Stream image width - for images streams. 0 indicates any. |
| [in] | height | Stream image height - for images streams. 0 indicates any. |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 156 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References ds3d::v2xinfer::format(), rs2::error::handle(), rs2_config_enable_stream(), and width.
|
inline |
Enable a device stream explicitly, with selected stream parameters.
The method allows the application to request a stream with specific configuration. If no stream is explicitly enabled, the pipeline configures the device and its streams according to the attached computer vision modules and processing blocks requirements, or default configuration for the first available device. The application can configure any of the input stream parameters according to its requirement, or set to 0 for don't care value. The config accumulates the application calls for enable configuration methods, until the configuration is applied. Multiple enable stream calls for the same stream override each other, and the last call is maintained. Upon calling resolve(), the config checks for conflicts between the application configuration requests and the attached computer vision modules and processing blocks requirements, and fails if conflicts are found. Before resolve() is called, no conflict check is done.
| [in] | stream_type | Stream type to be enabled |
| [in] | stream_index | Stream index, used for multiple streams of the same type. -1 indicates any. |
| [in] | width | Stream image width - for images streams. 0 indicates any. |
| [in] | height | Stream image height - for images streams. 0 indicates any. |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 156 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References ds3d::v2xinfer::format(), rs2::error::handle(), rs2_config_enable_stream(), and width.
Referenced by enable_stream().
|
inline |
Stream type, index, and format, and possibly framerate.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | stream_index | Stream index, used for multiple streams of the same type. -1 indicates any. |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 208 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), and ds3d::v2xinfer::format().
|
inline |
Stream type, index, and format, and possibly framerate.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | stream_index | Stream index, used for multiple streams of the same type. -1 indicates any. |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 208 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), and ds3d::v2xinfer::format().
|
inline |
Stream type and possibly also stream index.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | stream_index | Stream index, used for multiple streams of the same type. -1 indicates any. |
Definition at line 169 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), and RS2_FORMAT_ANY.
|
inline |
Stream type and possibly also stream index.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | stream_index | Stream index, used for multiple streams of the same type. -1 indicates any. |
Definition at line 169 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), and RS2_FORMAT_ANY.
|
inline |
Stream type and resolution, and possibly format and frame rate.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | width | Stream image width - for images streams. 0 indicates any. |
| [in] | height | Stream image height - for images streams. 0 indicates any. |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 183 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), ds3d::v2xinfer::format(), and width.
|
inline |
Stream type and resolution, and possibly format and frame rate.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | width | Stream image width - for images streams. 0 indicates any. |
| [in] | height | Stream image height - for images streams. 0 indicates any. |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 183 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), ds3d::v2xinfer::format(), and width.
|
inline |
Stream type and format, and possibly frame rate.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 195 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), and ds3d::v2xinfer::format().
|
inline |
Stream type and format, and possibly frame rate.
Other parameters are resolved internally.
| [in] | stream_type | Stream type to be enabled |
| [in] | format | Stream data format - pixel format for images streams, of data type for other streams. RS2_FORMAT_ANY indicates any. |
| [in] | framerate | Stream frames per second. 0 indicates any. |
Definition at line 195 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References enable_stream(), and ds3d::v2xinfer::format().
|
inline |
Definition at line 340 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
|
inline |
Definition at line 340 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
Referenced by rs2::pipeline::start().
|
inlineexplicit |
Definition at line 344 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
|
inlineexplicit |
Definition at line 344 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
|
inline |
Resolve the configuration filters, to find a matching device and streams profiles.
The method resolves the user configuration filters for the device and streams, and combines them with the requirements of the computer vision modules and processing blocks attached to the pipeline. If there are no conflicts of requests, it looks for an available device, which can satisfy all requests, and selects the first matching streams configuration. In the absence of any request, the rs2::config selects the first available device and the first color and depth streams configuration. The pipeline profile selection during start() follows the same method. Thus, the selected profile is the same, if no change occurs to the available devices. Resolving the pipeline configuration provides the application access to the pipeline selected device for advanced control. The returned configuration is not applied to the device, so the application doesn't own the device sensors. However, the application can call enable_device(), to enforce the device returned by this method is selected by pipeline start(), and configure the device and sensors options or extensions before streaming starts.
| [in] | p | The pipeline for which the selected filters are applied |
Definition at line 314 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), rs2_config_resolve(), and rs2_delete_pipeline_profile().
|
inline |
Resolve the configuration filters, to find a matching device and streams profiles.
The method resolves the user configuration filters for the device and streams, and combines them with the requirements of the computer vision modules and processing blocks attached to the pipeline. If there are no conflicts of requests, it looks for an available device, which can satisfy all requests, and selects the first matching streams configuration. In the absence of any request, the rs2::config selects the first available device and the first color and depth streams configuration. The pipeline profile selection during start() follows the same method. Thus, the selected profile is the same, if no change occurs to the available devices. Resolving the pipeline configuration provides the application access to the pipeline selected device for advanced control. The returned configuration is not applied to the device, so the application doesn't own the device sensors. However, the application can call enable_device(), to enforce the device returned by this method is selected by pipeline start(), and configure the device and sensors options or extensions before streaming starts.
| [in] | p | The pipeline for which the selected filters are applied |
Definition at line 314 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_pipeline.hpp.
References rs2::error::handle(), rs2_config_resolve(), and rs2_delete_pipeline_profile().